Configure uma tarefa de migração ou sincronização de dados.
Pré-configure a tarefa no console e visualize os parâmetros correspondentes da OpenAPI para facilitar a especificação dos parâmetros da solicitação. Para mais informações, consulte Visualizar parâmetros de solicitação da OpenAPI.
Tarefas em um cluster dedicado aceitam apenas o método de faturamento configurar primeiro e comprar depois. Não há suporte para tarefas entre regiões.
Depuração
Parâmetros de solicitação
|
Nome |
Tipo |
Obrigatório |
Exemplo |
Descrição |
| Action | String | Sim | ConfigureDtsJob | A ação a ser executada. Defina o valor como ConfigureDtsJob. |
| DtsJobName | String | Sim | rdsmysql_to_mysql | O nome da tarefa do DTS. |
| SourceEndpointInstanceType | String | Sim | RDS | O tipo da instância de origem. Valores válidos: Banco de dados da Alibaba Cloud
Nota
|
| SourceEndpointInstanceID | String | Não | rm-bp1imrtn6fq7h**** | O ID da instância de origem. Se a instância de origem for um banco de dados da Alibaba Cloud, como o RDS for MySQL, especifique o ID dessa instância. Se a instância de origem for um banco de dados autogerenciado, o valor deste parâmetro varia conforme o valor de SourceEndpointInstanceType. Por exemplo, se SourceEndpointInstanceType estiver definido como:
Nota Se você definir o valor como CENDescrição do parâmetro Reserve, também será necessário especificar o ID da instância CEN no parâmetro Reserve. Para mais informações, consulte . |
| SourceEndpointEngineName | String | Não | MYSQL | O tipo de banco de dados da instância de origem.
Nota
|
| SourceEndpointRegion | String | Não | cn-hangzhou | A região da instância de origem. Para mais informações, consulte Lista de regiões suportadas. Nota Este parâmetro é obrigatório se a instância de origem for um banco de dados da Alibaba Cloud. |
| SourceEndpointIP | String | Não | 172.16.**.*** | O endereço IP da instância de origem. Nota Este parâmetro é necessário apenas quando SourceEndpointInstanceType está definido como OTHER, EXPRESS, DG ou CEN. |
| SourceEndpointPort | String | Não | 3306 | A porta de serviço do banco de dados da instância de origem. Nota Este parâmetro é necessário apenas quando a instância de origem é um banco de dados autogerenciado. |
| SourceEndpointOracleSID | String | Não | testsid | O ID do sistema (SID) do banco de dados Oracle. Nota Este parâmetro é necessário apenas quando SourceEndpointEngineName está definido como Oracle e o banco de dados Oracle não é uma instância Real Application Clusters (RAC). |
| SourceEndpointDatabaseName | String | Não | dtstestdatabase | O nome do banco de dados que contém os objetos a serem migrados na instância de origem. Nota Este parâmetro é necessário apenas quando a instância de origem ou o tipo de banco de dados da instância de origem é PolarDB for PostgreSQL (Compatible with Oracle), PostgreSQL ou MongoDB. |
| SourceEndpointUserName | String | Não | dtstest | A conta do banco de dados de origem. Nota
|
| SourceEndpointPassword | String | Não | Test123456 | A senha da conta do banco de dados de origem. |
| SourceEndpointOwnerID | String | Não | 140692647406**** | O ID da conta da Alibaba Cloud à qual a instância de origem pertence. Nota Ao especificar este parâmetro, você executa uma tarefa de migração ou sincronização de dados entre contas. Também é necessário especificar o parâmetro SourceEndpointRole. |
| SourceEndpointRole | String | Não | ram-for-dts | O nome da função RAM configurada para a conta da Alibaba Cloud à qual a instância de origem pertence. Nota Como configurar a autorização RAM para migração ou sincronização de dados entre contas da Alibaba CloudEste parâmetro é obrigatório para migração ou sincronização de dados entre contas. Para mais informações sobre as permissões necessárias e como concedê-las à função RAM, consulte . |
| DestinationEndpointInstanceType | String | Sim | EXPRESS | O tipo da instância de destino. Valores válidos: Banco de dados da Alibaba Cloud
Nota
|
| DestinationEndpointInstanceID | String | Não | vpc-bp1opxu1zkhn00gzv**** | O ID da instância de destino. Se a instância de destino for um banco de dados da Alibaba Cloud, como o RDS for MySQL, especifique o ID dessa instância. Quando a instância de destino for um banco de dados autogerenciado, o valor deste parâmetro varia conforme o valor de DestinationEndpointInstanceType. Por exemplo, se DestinationEndpointInstanceType estiver definido como:
Nota Se você definir o valor como CENParâmetros Reserve, também será necessário especificar o ID da instância CEN no parâmetro Reserve. Para mais informações, consulte . |
| DestinationEndpointEngineName | String | Não | MYSQL | O tipo de banco de dados da instância de destino.
Nota
|
| DestinationEndpointRegion | String | Não | cn-hangzhou | A região da instância de destino. Para mais informações, consulte Lista de regiões suportadas. Nota Este parâmetro é obrigatório se a instância de destino for um banco de dados da Alibaba Cloud. |
| DestinationEndpointIP | String | Não | 172.16.**.*** | O endereço IP da instância de destino. Nota Este parâmetro é necessário apenas quando DestinationEndpointInstanceType está definido como OTHER, EXPRESS, DG ou CEN. |
| DestinationEndpointPort | String | Não | 3306 | A porta de serviço do banco de dados da instância de destino. Nota Este parâmetro é necessário apenas quando a instância de destino é um banco de dados autogerenciado. |
| DestinationEndpointDataBaseName | String | Não | dtstestdata | O nome do banco de dados para o qual os objetos são migrados na instância de destino. Nota
|
| DestinationEndpointUserName | String | Não | dtstest | A conta do banco de dados de destino. Nota
|
| DestinationEndpointPassword | String | Não | Test123456 | A senha da conta do banco de dados de destino. Nota Criar um AccessKeySe o banco de dados de destino for um projeto MaxCompute, especifique o AccessKey secret da sua conta da Alibaba Cloud. Para mais informações sobre como obter um AccessKey secret, consulte . |
| DestinationEndpointOwnerID | String | Não | 140692647406**** | O ID da conta da Alibaba Cloud à qual a instância RDS for MySQL de destino pertence. Nota
|
| DestinationEndpointRole | String | Não | ram-for-dts | O nome da função RAM configurada para a conta da Alibaba Cloud à qual a instância de destino pertence. Nota Como configurar a autorização RAM para migração ou sincronização de dados entre contasEste parâmetro é obrigatório para migração ou sincronização de dados entre contas. Para mais informações sobre as permissões necessárias e como concedê-las à função RAM, consulte . |
| StructureInitialization | Boolean | Sim | true | Define se deve ser realizada a migração ou inicialização de esquema. Valores válidos:
Nota Se JobType estiver definido como CHECK, este parâmetro só poderá ser definido como false. |
| DataInitialization | Boolean | Sim | true | Define se deve ser realizada a sincronização completa inicial de dados. Valores válidos:
Nota Se JobType estiver definido como CHECK, este parâmetro só poderá ser definido como false. |
| DataSynchronization | Boolean | Sim | true | Define se deve ser realizada a migração ou sincronização incremental de dados. Valores válidos:
Nota Se JobType estiver definido como CHECK, este parâmetro só poderá ser definido como false. |
| DbList | String | Sim | {"dtstest":{"name":"dtstest","all":true}} | Os objetos a serem migrados ou sincronizados. O valor é uma string JSON. Para mais informações, consulte Descrição de objetos de migração, sincronização ou assinatura.
|
| Reserve | String | Não | { "srcInstanceId": "cen-9kqshqum*******" } | O parâmetro reservado para o DTS, que é uma string JSON. Use este parâmetro para fornecer informações adicionais sobre os bancos de dados de origem e destino, como o formato de armazenamento de dados para o banco de dados Kafka de destino, o ID da instância de uma Cloud Enterprise Network (CEN) ou a configuração do recurso de extração, transformação e carga (ETL). Para mais informações, consulte Descrição do parâmetro Reserve. |
| Checkpoint | String | Não | 1610540493 | O deslocamento inicial da migração ou sincronização incremental de dados. O valor é um carimbo de data/hora UNIX. Unidade: segundos. Nota Se você especificar o parâmetro Checkpoint, certifique-se de que nenhuma outra tarefa DTS em execução use o mesmo banco de dados de origem que a instância DTS de destino. |
| DestinationEndpointOracleSID | String | Não | testsid | O SID do banco de dados Oracle. Nota Este parâmetro é necessário apenas quando DestinationEndpointEngineName está definido como Oracle e o banco de dados Oracle não é uma instância RAC. |
| JobType | String | Sim | SYNC | O tipo de tarefa. Valores válidos:
Nota
|
| DtsJobId | String | Não | k2gm967v16f**** | O ID da tarefa de migração ou sincronização de dados. Nota DescribeDtsJobsChame a operação para consultar o ID da tarefa. |
| DtsInstanceId | String | Não | dtsk2gm967v16f**** | O ID da instância de migração ou sincronização de dados. Nota DescribeDtsJobsChame a operação para consultar o ID da instância. |
| DelayPhone | String | Não | 1361234****,1371234**** | Os números de celular dos contatos que recebem alertas relacionados à latência. Separe vários números de celular com vírgulas (,). Nota
|
| DelayRuleTime | Long | Não | 10 | O limiar para acionar um alerta de latência. Unidade: segundos. O valor deve ser um número inteiro. Defina o limiar como 10 segundos ou mais para evitar falsos alertas causados por oscilações de rede e do banco de dados. Nota Este parâmetro é obrigatório quando DelayNotice está definido como true. |
| DelayNotice | Boolean | Não | true | Define se a latência da tarefa deve ser monitorada. Valores válidos:
|
| ErrorPhone | String | Não | 1361234****,1371234**** | Os números de celular dos contatos que recebem alertas relacionados a exceções. Separe vários números de celular com vírgulas (,). Nota
|
| ErrorNotice | Boolean | Não | true | Define se o status da tarefa deve ser monitorado. Valores válidos:
|
| SynchronizationDirection | String | Não | Forward | A direção da sincronização. Valores válidos:
Nota
|
| RegionId | String | Não | cn-hangzhou | A região onde a instância DTS está localizada. Para mais informações, consulte Lista de regiões suportadas. |
| DedicatedClusterId | String | Não | dtscluster_atyl3b5214uk*** | O ID do cluster dedicado do DTS. Nota Se você especificar o ID de um cluster dedicado, a tarefa será agendada para esse cluster. |
| FileOssUrl | String | Não | http://db-list-os-file.oss-cn-shanghai.aliyuncs.com/8e42_121852**********_79dd3aeabe2f43cdb************** | A URL do arquivo do Object Storage Service (OSS) para a tarefa. |
| DataCheckConfigure | String | Não | {"fullCheckModel":1,"fullCheckRatio":20,"checkMaximumHourEnable":1,"checkMaximumHour":1,"fullCheckErrorNotice":true,"fullCheckValidFailNotice":true,"fullCheckNoticeValue":8,"incrementalCheckErrorNotice":true,"incrementalCheckValidFailNotice":true,"incrementalCheckValidFailNoticeTimes":2,"incrementalCheckValidFailNoticePeriod":1,"incrementalCheckValidFailNoticeValue":1,"incrementalCheckDelayNotice":true,"incrementalCheckDelayNoticeTimes":2,"incrementalCheckDelayNoticePeriod":1,"incrementalCheckDelayNoticeValue":60,"fullDataCheck":true,"incrementalDataCheck":true,"dataCheckNoticePhone":"13126800****","dataCheckDbList":{"dts":{"name":"dts","all":true}}} | Os parâmetros para verificação de dados, incluindo as configurações de verificação de dados e alertas. O valor é uma string JSON. Para mais informações, consulte Parâmetros DataCheckConfigure. |
| DisasterRecoveryJob | Boolean | Não | true | Define se a instância é uma instância de recuperação de desastres. Valores válidos:
|
| SourceEndpointVSwitchID | String | Não | vsw-bp10df3mxae6lpmku**** | O ID do vSwitch para o link de envio de dados. |
| DtsBisLabel | String | Não | normal | A tag de ambiente da instância DTS. Valores válidos:
|
| SrcCaCertificateOssUrl | String | Não | **** | O caminho do certificado da autoridade certificadora (CA) se o banco de dados de origem estiver conectado via SSL. Nota Não há suporte para este recurso. Não especifique este parâmetro. |
| SrcCaCertificatePassword | String | Não | **** | A senha do certificado CA se o banco de dados de origem estiver conectado via SSL. Nota Não há suporte para este recurso. Não especifique este parâmetro. |
| DestCaCertificateOssUrl | String | Não | **** | O caminho do certificado CA se o banco de dados de destino estiver conectado via SSL. Nota Não há suporte para este recurso. Não especifique este parâmetro. |
| DestCaCertificatePassword | String | Não | **** | A senha do certificado CA se o banco de dados de destino estiver conectado via SSL. Nota Não há suporte para este recurso. Não especifique este parâmetro. |
| MinDu | double | Não | 1 | O número mínimo de unidades DTS (DUs). Nota Este parâmetro é suportado apenas para instâncias serverless. |
| MaxDu | double | Não | 16 | O número máximo de DUs. Nota Este parâmetro é suportado apenas para instâncias serverless. |
| SrcClientCertOssUrl | String | Não | **** | O caminho do certificado do cliente se o banco de dados de origem estiver conectado via SSL. Nota Não há suporte para este recurso. Não especifique este parâmetro. |
| SrcClientKeyOssUrl | String | Não | **** | O caminho da chave privada do certificado do cliente se o banco de dados de origem estiver conectado via SSL. Nota Não há suporte para este recurso. Não especifique este parâmetro. |
| SrcClientPassword | String | Não | **** | A senha da chave privada do certificado do cliente se o banco de dados de origem estiver conectado via SSL. Nota Não há suporte para este recurso. Não especifique este parâmetro. |
| DestClientCertOssUrl | String | Não | **** | O caminho do certificado do cliente se o banco de dados de destino estiver conectado via SSL. Nota Não há suporte para este recurso. Não especifique este parâmetro. |
| DestClientKeyOssUrl | String | Não | **** | O caminho da chave privada do certificado do cliente se o banco de dados de destino estiver conectado via SSL. Nota Não há suporte para este recurso. Não especifique este parâmetro. |
| DestClientPassword | String | Não | **** | A senha da chave privada do certificado do cliente se o banco de dados de destino estiver conectado via SSL. Nota Não há suporte para este recurso. Não especifique este parâmetro. |
| SrcPrimaryVswId | String | Não | **** | O vSwitch primário da origem para NAT da VPC. |
| SrcSecondaryVswId | String | Não | **** | O vSwitch secundário da origem para NAT da VPC. |
| DestPrimaryVswId | String | Não | **** | O vSwitch primário do destino para NAT da VPC. |
| DestSecondaryVswId | String | Não | **** | O vSwitch secundário do destino para NAT da VPC. |
| ResourceGroupId | String | Não | rg-acfmzawhxxc**** | O ID do grupo de recursos. |
Parâmetros de resposta
|
Nome |
Tipo |
Exemplo |
Descrição |
|
HttpStatusCode |
String |
200 |
O código de status HTTP. |
|
RequestId |
String |
224DB9F7-3100-4899-AB9C-C938BCCB**** |
O ID da solicitação. |
|
ErrCode |
String |
InternalError |
O código de erro retornado se a chamada falhar. |
|
DtsJobId |
String |
k2gm967v16f**** |
O ID da tarefa de migração ou sincronização de dados. |
|
DtsInstanceId |
String |
dtsk2gm967v16f**** |
O ID da instância de migração ou sincronização de dados. |
|
Success |
String |
true |
Indica se a solicitação foi bem-sucedida. |
|
ErrMessage |
String |
The request processing has failed due to some unknown error. |
A mensagem de erro retornada se a chamada falhar. |
Exemplos
Exemplo de solicitação
http(s)://dts.aliyuncs.com/?Action=ConfigureDtsJob
&RegionId=cn-hangzhou
&SourceEndpointInstanceType=RDS
&DestinationEndpointInstanceType=EXPRESS
&StructureInitialization=true
&DataInitialization=true
&DataSynchronization=true
&DbList={"dtstest":{"name":"dtstest","all":true}}
&JobType=SYNC
&SourceEndpointInstanceID=rm-bp1imrtn6fq7h****
&SourceEndpointEngineName=MYSQL
&SourceEndpointRegion=cn-hangzhou
&SourceEndpointUserName=dtstest
&SourceEndpointPassword=Test123456
&DestinationEndpointInstanceID=vpc-bp1opxu1zkhn00gzv****
&DestinationEndpointEngineName=MYSQL
&DestinationEndpointIP=172.16.**.***
&DestinationEndpointRegion=cn-hangzhou
&DestinationEndpointPort=3306
&DestinationEndpointUserName=dtstest
&DestinationEndpointPassword=Test123456
&DtsJobId=k2gm967v16f****
&DtsInstanceId=dtsk2gm967v16f****
&DtsJobName=rdsmysql_to_self-managed_mysql_over_leased_line
&<Common request parameters>
Exemplos de respostas
Formato XML
HTTP/1.1 200 OK
Content-Type:application/xml
<ConfigureDtsJobResponse>
<DtsJobId>k2gm967v16f****</DtsJobId>
<RequestId>224DB9F7-3100-4899-AB9C-C938BCCB****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<DtsInstanceId>dtsk2gm967v16f****</DtsInstanceId>
<Success>true</Success>
</ConfigureDtsJobResponse>
Formato JSON
HTTP/1.1 200 OK
Content-Type:application/json
{
"DtsJobId" : "k2gm967v16f****",
"RequestId" : "224DB9F7-3100-4899-AB9C-C938BCCB****",
"HttpStatusCode" : 200,
"DtsInstanceId" : "dtsk2gm967v16f****",
"Success" : true
}
Códigos de erro
|
HttpCode |
Código de erro |
Mensagem de erro |
Descrição |
|
403 |
InvalidParameter.KafkaBrokerInvalid |
kafka broker configuration must be intranet IP |
O broker do cluster Kafka autogerenciado em uma instância ECS deve ser configurado usando um endereço IP. Não há suporte para hostnames. |
|
403 |
InvalidParameter.KafkaHostInvalid |
kafaka host name should be intranet IP |
Não há suporte para o hostname do cluster Kafka. Insira um endereço IP interno. |
|
403 |
UpdateJob.OperationDenied.InitStatus |
The operation is not permitted due to Dts job status is init. |
A tarefa foi iniciada e não pode ser modificada. Reconfigure a tarefa ou modifique os objetos de sincronização. |
|
403 |
GetMongoDbShardInfo.NoShardAddress |
MongoDb has not yet opened the shard connection address, please try again after opening. |
Falha ao obter as informações de conexão do shard. Verifique as configurações de parâmetros para confirmar que o banco de dados é um banco de dados MongoDB fragmentado e que o endereço do shard está habilitado. |
|
403 |
GetMongoDbShardInfo.EmptyInstances |
Failed to get MongoDb shard information, the return is empty. |
Falha ao obter as informações do shard. Verifique as configurações de parâmetros para confirmar que o banco de dados é um banco de dados MongoDB fragmentado. |
|
403 |
CheckJobFailed.ServerUnAvailable |
Unable to check whether the node can connect to the database because the node service is unavailable. |
Alguns nós do DTS estão indisponíveis. Tente novamente. Se o problema persistir, entre em contato com o suporte técnico. |
|
403 |
DbTypeNotSupport.PolarDBRDS |
The current rds instance is of type PolarDB, which is not supported for the time being. Only rds instances under drds are supported. |
O DTS não suporta sincronização de dados para instâncias DRDS que usam bancos de dados PolarDB for MySQL para fragmentação de banco de dados. |
|
403 |
DbTypeNotSupport.OnlyReadRDS |
Synchronization is not currently supported due to latency issues with read-only DRDS instances. |
O DTS não suporta sincronização de dados para instâncias DRDS que usam bancos de dados somente leitura para fragmentação de banco de dados. |
|
403 |
DTS.Msg.InvalidParameter.KafkaBrokerInvalid |
kafka broker configuration must be intranet IP |
O broker do cluster Kafka autogerenciado em uma instância ECS deve ser configurado usando um endereço IP. Não há suporte para hostnames. |
|
403 |
DTS.Msg.InvalidParameter.KafkaHostInvalid |
kafaka host name should be intranet IP |
Não há suporte para o hostname do cluster Kafka. Insira um endereço IP interno. |
|
403 |
DTS.Msg.UpdateJob.OperationDenied.InitStatus |
The operation is not permitted due to Dts job status is init. |
A tarefa foi iniciada e não pode ser modificada. Reconfigure a tarefa ou modifique os objetos de sincronização. |
|
403 |
DTS.Msg.GetMongoDbShardInfo.NoShardAddress |
MongoDb has not yet opened the shard connection address, please try again after opening. |
Falha ao obter as informações de conexão do shard. Verifique as configurações de parâmetros para confirmar que o banco de dados é um banco de dados MongoDB fragmentado e que o endereço do shard está habilitado. |
|
403 |
DTS.Msg.GetMongoDbShardInfo.EmptyInstances |
Failed to get MongoDb shard information, the return is empty. |
Falha ao obter as informações do shard. Verifique as configurações de parâmetros para confirmar que o banco de dados é um banco de dados MongoDB fragmentado. |
|
403 |
DTS.Msg.CheckJobFailed.ServerUnAvailable |
Unable to check whether the node can connect to the database because the node service is unavailable. |
Alguns nós do DTS estão indisponíveis. Tente novamente. Se o problema persistir, entre em contato com o suporte técnico. |
|
403 |
DTS.Msg.DbTypeNotSupport.PolarDBRDS |
The current rds instance is of type PolarDB, which is not supported for the time being. Only rds instances under drds are supported. |
O DTS não suporta sincronização de dados para instâncias DRDS que usam bancos de dados PolarDB for MySQL para fragmentação de banco de dados. |
|
403 |
DTS.Msg.DbTypeNotSupport.OnlyReadRDS |
Synchronization is not currently supported due to latency issues with read-only DRDS instances. |
O DTS não suporta sincronização de dados para instâncias DRDS que usam bancos de dados somente leitura para fragmentação de banco de dados. |
|
403 |
InvalidSecurityToken.Expired |
Specified SecurityToken is expired. |
A assinatura expirou. Atualize a assinatura. |
|
400 |
Throttling.User |
Request was denied due to user flow control. |
A solicitação foi negada porque a frequência de solicitações atingiu o limite. Tente novamente mais tarde. |
|
500 |
ServiceUnavailable |
The request has failed due to a temporary failure of the server. |
A solicitação falhou porque o servidor atingiu o tempo limite ou estava indisponível. Tente novamente. Se a solicitação falhar novamente, entre em contato com o suporte técnico. |
Para mais informações sobre outros códigos de erro, consulte a Central de Erros de API para o site internacional.