Criação de tarefas de migração de dados
Função
Essa API é usada para criar uma tarefa de migração de dados.
URI
POST /v2/{project_id}/migration-task
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
task_name |
Sim |
String |
Nome da tarefa de migração. |
description |
Não |
String |
Descrição do tipo de migração. |
migration_type |
Sim |
String |
Modo de migração. Valores:
Valores de enumeração:
|
migration_method |
Sim |
String |
Tipo de migração, que pode ser migração completa ou migração incremental. Valores:
Valores de enumeração:
|
backup_files |
Não |
BackupFilesBody object |
Arquivos de backup a serem importados quando o modo de migração é a importação de arquivos de backup. |
network_type |
Não |
String |
Tipo de rede para comunicação entre o Redis de origem e de destino quando o modo de migração é a migração de dados on-line. O tipo de rede pode ser VPC ou VPN. Valores de enumeração:
|
source_instance |
Não |
SourceInstanceBody object |
Fonte das informações do Redis. Este parâmetro é obrigatório quando o modo de migração é migração de dados online. |
target_instance |
Sim |
TargetInstanceBody object |
Informações do Redis de destino. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
file_source |
Não |
String |
Fonte de dados, que pode ser um bucket do OBS ou um registro de backup. Valores de enumeração:
|
bucket_name |
Sim |
String |
Nome do bucket do OBS. |
files |
Sim |
Array of Files objects |
Lista de arquivos de backup a serem importados. Esse parâmetro é obrigatório quando a origem de dados é um bucket do OBS. |
backup_id |
Não |
String |
ID do registro de backup. Este parâmetro é obrigatório quando a fonte de dados é um registro de backup. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
file_name |
Sim |
String |
Nome de um arquivo de backup. |
size |
Não |
String |
Tamanho do arquivo em bytes. |
update_at |
Não |
String |
Hora em que o arquivo foi modificado pela última vez. O formato é AAAA-MM-DD HH:MM:SS. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
addrs |
Sim |
String |
Nome do Redis de origem (especificado no parâmetro source_instance). |
password |
Não |
String |
Senha do Redis. Se uma senha for definida, esse parâmetro é obrigatório. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
id |
Sim |
String |
ID da instância do Redis (obrigatório no parâmetro target_instance). |
name |
Não |
String |
Nome da instância do Redis (especificado no parâmetro target_instance). |
password |
Não |
String |
Senha do Redis. Se uma senha for definida, esse parâmetro é obrigatório. |
Parâmetros de resposta
Código de estado: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID da tarefa de migração. |
name |
String |
Nome da tarefa de migração. |
status |
String |
Status da tarefa de migração. O valor pode ser SUCCESS, FAILED, MIGRATING, ou TERMINATED. Valores de enumeração:
|
Código de estado: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
error_code |
String |
Código de erro. Máximo: 9 |
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 401
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
error_code |
String |
Código de erro. Máximo: 9 |
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 403
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
error_code |
String |
Código de erro. Máximo: 9 |
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 404
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
error_code |
String |
Código de erro. Máximo: 9 |
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
error_code |
String |
Código de erro. Máximo: 9 |
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Exemplos de solicitações
POST https://{dcs_endpoint}/v2/{project_id}/migration-task { "task_name" : "migration1", "description" : "Test", "migration_type" : "online_migration", "migration_method" : "full_amount_migration", "network_type" : "vpc", "source_instance" : { "addrs" : "192.168.1.135:6379", "password" : "xxxxxx" }, "target_instance" : { "name" : "dcs-test", "id" : "4cd5dbb8-aacd-4603-b817-3e97d48c7a20" } }
Exemplo de respostas
Código de estado: 200
Tarefa de migração de dados criada com êxito.
{ "id" : "8aa6999e71cb638b0171f485f5266ef0", "name" : "dcs-test", "status" : "MIGRATING" }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
Tarefa de migração de dados criada com êxito. |
400 |
Pedido inválido. |
401 |
Informações de autenticação inválidas. |
403 |
O pedido é rejeitado. |
404 |
O recurso solicitado não foi encontrado. |
500 |
Erro de serviço interno. |
Códigos de erro
Consulte Códigos de erro.