Chame esta API para modificar uma tarefa de sincronização do Data Transmission Service (DTS).
Configure previamente a tarefa no console e depois visualize os parâmetros de solicitação da OpenAPI para auxiliar no preenchimento dos parâmetros.
Depuração
Execute esta operação no OpenAPI Explorer, que calcula automaticamente o valor da assinatura. Após uma chamada bem-sucedida, o OpenAPI Explorer gera exemplos de código SDK.
Parâmetros de solicitação
|
Nome |
Tipo |
Obrigatório |
Exemplo |
Descrição |
|
Action |
String |
Sim |
ModifyDtsJob |
Parâmetro definido pelo sistema. Defina o valor como |
|
RegionId |
String |
Não |
cn-hangzhou |
ID da região da instância. Para mais informações, consulte Regiões suportadas. |
|
DtsInstanceId |
String |
Sim |
dtsbi6e22ay243**** |
ID da instância de sincronização. |
|
SynchronizationDirection |
String |
Não |
Forward |
Direção da sincronização. Valores válidos:
Nota
|
|
ClientToken |
String |
Não |
0c593ea1-3bea-11e9-b96b-88e9fe63**** |
Token do cliente que garante a idempotência da solicitação. Gere um valor exclusivo no cliente para cada solicitação diferente. O ClientToken aceita apenas caracteres ASCII e não pode exceder 64 caracteres. |
|
DbList |
Map |
Não |
{"dtstest":{"name":"dtstest","all":true}} |
Objetos de sincronização modificados no formato de string JSON. Para mais informações, consulte Objetos para migração, sincronização e assinatura.
|
|
EtlOperatorColumnReference |
String |
Não |
{ "configKeyMap": [ { "moduleCode": "03", "etlOperatorColumnReference": "etlOperatorColumnReference", "etlOperatorSetting": "etlOperatorSetting" }, { "moduleCode": "07", "etlOperatorColumnReference": "etlOperatorColumnReference", "etlOperatorSetting": "etlOperatorSetting" } ], "amp.increment.replicator.compare.all.columns.enable": false, "srcNetType": "VPC", "etlOperatorColumnReference": { "MODIFY_TIME": [ { "datasynchron.test_timing_user_000": "user_create_date" }, { "datasynchron.test_timing_user_001": "user_create_date" }, { "datasynchron.test_timing_user_002": "user_create_date" }, { "datasynchron.test_timing_user_003": "user_create_date" } ] }, "destNetType": "VPC", "originalSrcDbInst": "sg-sit-db2-primary.mysql.polardb.rds.aliyuncs.com", "etlOperatorSetting": "adb_time_travel", "sjobUseJobTask": "1", "srcVpcNetMappingInst": "172.19.XXX.XXX:4261", "destVpcNetMappingInst": "172.19.XXX.XXX:4260", "useJobTask": "1" } |
Operador relacionado ao recurso de extração, transformação e carga (ETL), específico para negócios T+1. |
|
ModifyTypeEnum |
String |
Não |
UPDATE_RESERVED |
Método de modificação da tarefa de sincronização. Se este parâmetro não for especificado, os objetos de sincronização serão modificados por padrão. Se definido como UPDATE_RESERVED, os parâmetros reservados serão modificados. |
|
Reserved |
String |
Não |
{"definer": false,"syncArchitecture": "oneway","whitelist.dms.online.ddl.enable": false,"destSSL": "0","triggerMode": "manual","sqlparser.dms.original.ddl": true,"whitelist.ghost.online.ddl.enable": false,"privilegeMigration": false,"maxRetryTime": 43200,"srcSSL": "0","autoStartModulesAfterConfig": "none"} |
Parâmetro reservado do DTS. A atualização adiciona valores em vez de sobrescrever. O formato é uma string JSON do tipo MAP. Utilize este parâmetro para implementar requisitos especiais (como definir se a pré-verificação deve iniciar automaticamente). O uso é semelhante ao do parâmetro Reserve. Para mais informações, consulte Descrição do parâmetro Reserve. |
|
FileOssUrl |
String |
Não |
http://db-list-os-file.oss-cn-shanghai.aliyuncs.com/8e42_1218543989_** |
URL do OSS do arquivo de sincronização. |
|
FilterTableName |
String |
Não |
testtable |
Nome da tabela a ser filtrada. |
|
StructureInitialization |
Boolean |
Não |
true |
Define se deve executar a migração ou a sincronização de esquema. Valores válidos:
|
|
DataInitialization |
Boolean |
Não |
true |
Define se deve executar a migração ou a sincronização completa de dados. Valores válidos:
|
|
DataSynchronization |
Boolean |
Não |
true |
Define se deve executar a migração ou a sincronização incremental de dados. Valores válidos:
|
|
DtsJobId |
String |
Não |
fpx1149rw7p*** |
ID da tarefa de sincronização. Obtenha-o chamando a API DescribeDtsJobs. |
|
ZeroEtlJob |
Boolean |
Não |
false |
Define se deve consultar apenas tarefas de integração zero-extract, transform, load (ETL). Valores válidos:
|
|
ResourceGroupId |
String |
Não |
rg-acfmzawhxxc**** |
ID do grupo de recursos. |
Parâmetros de resposta
|
Nome |
Tipo |
Exemplo |
Descrição |
|
Status |
String |
200 |
Código de status. |
|
RequestId |
String |
1D6ECADF-C5E9-4C96-8811-77602B31**** |
ID da solicitação. |
|
DtsJobId |
String |
bi6e22a**** |
ID da tarefa DTS. |
|
ErrCode |
String |
InternalError |
Código de erro retornado quando a solicitação falha. |
|
Success |
Boolean |
true |
Indica se a solicitação foi bem-sucedida. |
|
ErrMessage |
String |
The request processing has failed due to some unknown error. |
Mensagem de erro retornada se a solicitação falhar. Nota
O tipo de dados deste parâmetro deve ser String, e o valor real do exemplo é The request processing has failed due to some unknown error. |
Exemplos
Exemplo de solicitação
http(s)://dts.aliyuncs.com/?Action=ModifyDtsJob
&DtsInstanceId=dtsbi6e22ay243****
&DbList={"dtstest":{"name":"dtstest","all":true}}
&<Common request parameters>
Exemplos de respostas de sucesso
Formato XML
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyDtsJobResponse>
<DtsJobId>bi6e22a****</DtsJobId>
<RequestId>1D6ECADF-C5E9-4C96-8811-77602B31****</RequestId>
<Success>true</Success>
</ModifyDtsJobResponse>
Formato JSON
HTTP/1.1 200 OK
Content-Type:application/json
{
"DtsJobId" : "bi6e22a****",
"RequestId" : "1D6ECADF-C5E9-4C96-8811-77602B31****",
"Success" : true
}
Códigos de erro
|
HttpCode |
Código de erro |
Mensagem de erro |
Descrição |
|
403 |
OperationDenied.JobStatusModifying |
jobs state is modifying, please wait sync subtask ends |
A tarefa está passando por modificação de objetos de sincronização (a operação de modificação anterior ainda não foi concluída). Aguarde o término deste estado. |
|
403 |
CheckStatus.InvalidInitStatus |
Task has not been configured, please configure job first |
A tarefa não foi configurada. Configure a tarefa antes de modificá-la. |
|
403 |
DTS.Msg.OperationDenied.JobStatusModifying |
jobs state is modifying, please wait sync subtask ends |
A tarefa está passando por modificação de objetos de sincronização (a operação de modificação anterior ainda não foi concluída). Aguarde o término deste estado. |
|
403 |
DTS.Msg.CheckStatus.InvalidInitStatus |
Task has not been configured, please configure job first |
A tarefa não foi configurada. Configure a tarefa antes de modificá-la. |
|
403 |
InvalidSecurityToken.Expired |
Specified SecurityToken is expired. |
O SecurityToken especificado 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 requisições atingiu o limiar. Tente novamente mais tarde. |
|
500 |
ServiceUnavailable |
The request has failed due to a temporary failure of the server. |
A solicitação falhou devido a um tempo limite temporário ou indisponibilidade do servidor. Tente novamente. Se a falha persistir após novas tentativas, entre em contato com o suporte técnico. |
Visite o Error Center para mais códigos de erro.