Перейти к основному содержимому

Миграция API 1.7.0

Методы API для работы с разделом «Миграция».

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.7.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела​

МетодПуть
GET/migration/running
POST/migration/start
GET/migration/status
POST/migration/stop

GET /migration/running​

Раздел: Миграция.

Проверка работает ли перенос данных.

Параметры и ответы по OpenAPI
{
  "description": "Проверка работает ли перенос данных",
  "responses": {
    "200": {
      "description": "Successfully retrieved migration running status",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success",
              "isRunning",
              "status"
            ],
            "properties": {
              "success": {
                "type": "boolean"
              },
              "isRunning": {
                "type": "boolean"
              },
              "status": {
                "type": "string",
                "enum": [
                  "idle",
                  "running",
                  "completed",
                  "error"
                ]
              },
              "message": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Internal server error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI​

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/migration/running" \
  -H "Authorization: Bearer <token>"

Пример ответа​

{
  "success": true,
  "isRunning": true,
  "status": "idle",
  "message": "string"
}

POST /migration/start​

Раздел: Миграция.

Запуск переноса данных вручную с проверкой подключения накопителя.

Параметры и ответы по OpenAPI
{
  "description": "Запуск переноса данных вручную с проверкой подключения накопителя",
  "responses": {
    "200": {
      "description": "Migration successfully started",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Internal server error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI​

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса​

curl -k -X POST "https://{IP_контроллера}/api/v1/migration/start" \
  -H "Authorization: Bearer <token>"

Пример ответа​

{
  "success": false,
  "message": "string",
  "data": {}
}

GET /migration/status​

Раздел: Миграция.

Получение статуса переноса данных.

Параметры и ответы по OpenAPI
{
  "description": "Получение статуса переноса данных",
  "responses": {
    "200": {
      "description": "Successfully retrieved migration status",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean"
              },
              "jobInfo": {
                "type": "object",
                "properties": {
                  "isRunning": {
                    "type": "boolean"
                  },
                  "lastRun": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "nextRun": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "progress": {
                    "type": "number"
                  },
                  "totalRecords": {
                    "type": "integer"
                  },
                  "processedRecords": {
                    "type": "integer"
                  }
                }
              },
              "message": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Internal server error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI​

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/migration/status" \
  -H "Authorization: Bearer <token>"

Пример ответа​

{
  "success": true,
  "jobInfo": {
    "isRunning": true,
    "lastRun": "2026-07-14T12:00:00Z",
    "nextRun": "2026-07-14T12:00:00Z",
    "progress": 1.0,
    "totalRecords": 1,
    "processedRecords": 1
  },
  "message": "string"
}

POST /migration/stop​

Раздел: Миграция.

Остановка переноса данных.

Параметры и ответы по OpenAPI
{
  "description": "Остановка переноса данных",
  "responses": {
    "200": {
      "description": "Migration successfully stopped",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Internal server error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI​

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса​

curl -k -X POST "https://{IP_контроллера}/api/v1/migration/stop" \
  -H "Authorization: Bearer <token>"

Пример ответа​

{
  "success": false,
  "message": "string",
  "data": {}
}