Llame a esta API para modificar una tarea de sincronización de Data Transmission Service (DTS).
Preconfigure la tarea en la consola y luego use preview OpenAPI request parameters para facilitar el llenado de los parámetros de la solicitud.
Depuración
Ejecute esta operación en OpenAPI Explorer, que calcula automáticamente el valor de la firma. Tras una llamada exitosa, OpenAPI Explorer genera ejemplos de código SDK.
Parámetros de solicitud
|
Nombre |
Tipo |
Obligatorio |
Ejemplo |
Descripción |
|
Action |
String |
Sí |
ModifyDtsJob |
Parámetro definido por el sistema. Establezca el valor en |
|
RegionId |
String |
No |
cn-hangzhou |
ID de región de la instancia. Para más información, consulte Supported regions. |
|
DtsInstanceId |
String |
Sí |
dtsbi6e22ay243**** |
ID de la instancia de sincronización. |
|
SynchronizationDirection |
String |
No |
Forward |
Dirección de la sincronización. Valores válidos:
Nota
|
|
ClientToken |
String |
No |
0c593ea1-3bea-11e9-b96b-88e9fe63**** |
Token de cliente que garantiza la idempotencia de la solicitud. Genere un valor único desde su cliente para cada solicitud distinta. ClientToken admite únicamente caracteres ASCII y no puede superar los 64 caracteres de longitud. |
|
DbList |
Map |
No |
{"dtstest":{"name":"dtstest","all":true}} |
Objetos de sincronización modificados en formato de cadena JSON. Para más información, consulte Objects for migration, synchronization, and subscription.
|
|
EtlOperatorColumnReference |
String |
No |
{ "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 con la función de extracción, transformación y carga (ETL), específico para negocios T+1. |
|
ModifyTypeEnum |
String |
No |
UPDATE_RESERVED |
Indica el método para modificar la tarea de sincronización. Si no se especifica este parámetro, se modifican los objetos de sincronización de forma predeterminada. Si se establece en UPDATE_RESERVED, se modifican los parámetros reservados. |
|
Reserved |
String |
No |
{"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 de DTS. La actualización agrega valores en lugar de sobrescribirlos. El formato es una cadena JSON tipo MAP. Pase este parámetro para implementar requisitos especiales (por ejemplo, iniciar automáticamente la verificación previa). Su uso es similar al del parámetro Reserve. Para más información, consulte Reserve parameter description. |
|
FileOssUrl |
String |
No |
http://db-list-os-file.oss-cn-shanghai.aliyuncs.com/8e42_1218543989_** |
URL de OSS del archivo de sincronización. |
|
FilterTableName |
String |
No |
testtable |
Nombre de la tabla que se va a filtrar. |
|
StructureInitialization |
Boolean |
No |
true |
Especifica si se debe realizar la migración o sincronización de esquemas. Valores válidos:
|
|
DataInitialization |
Boolean |
No |
true |
Especifica si se debe realizar la migración o sincronización completa de datos. Valores válidos:
|
|
DataSynchronization |
Boolean |
No |
true |
Especifica si se debe realizar la migración o sincronización incremental de datos. Valores válidos:
|
|
DtsJobId |
String |
No |
fpx1149rw7p*** |
ID de la tarea de sincronización. Puede obtenerlo mediante la API DescribeDtsJobs. |
|
ZeroEtlJob |
Boolean |
No |
false |
Especifica si se deben consultar únicamente tareas de integración ETL sin extracción (zero-ETL). Valores válidos:
|
|
ResourceGroupId |
String |
No |
rg-acfmzawhxxc**** |
ID del resource group. |
Parámetros de respuesta
|
Nombre |
Tipo |
Ejemplo |
Descripción |
|
Status |
String |
200 |
Código de estado. |
|
RequestId |
String |
1D6ECADF-C5E9-4C96-8811-77602B31**** |
ID de la solicitud. |
|
DtsJobId |
String |
bi6e22a**** |
ID de la tarea de DTS. |
|
ErrCode |
String |
InternalError |
Código de error devuelto cuando la solicitud falla. |
|
Success |
Boolean |
true |
Indica si la solicitud fue exitosa. |
|
ErrMessage |
String |
The request processing has failed due to some unknown error. |
Mensaje de error devuelto si la solicitud falló. Nota
El tipo de dato de este parámetro debe ser String, y el valor real del ejemplo es The request processing has failed due to some unknown error. |
Ejemplos
Ejemplo de solicitud
http(s)://dts.aliyuncs.com/?Action=ModifyDtsJob
&DtsInstanceId=dtsbi6e22ay243****
&DbList={"dtstest":{"name":"dtstest","all":true}}
&<Common request parameters>
Ejemplos de respuestas exitosas
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 error
|
HttpCode |
Código de error |
Mensaje de error |
Descripción |
|
403 |
OperationDenied.JobStatusModifying |
jobs state is modifying, please wait sync subtask ends |
La tarea se encuentra actualmente en proceso de modificación de objetos de sincronización (la operación de modificación anterior aún no ha finalizado). Espere a que termine este estado. |
|
403 |
CheckStatus.InvalidInitStatus |
Task has not been configured, please configure job first |
La tarea no se ha configurado. Configure la tarea antes de modificarla. |
|
403 |
DTS.Msg.OperationDenied.JobStatusModifying |
jobs state is modifying, please wait sync subtask ends |
La tarea se encuentra actualmente en proceso de modificación de objetos de sincronización (la operación de modificación anterior aún no ha finalizado). Espere a que termine este estado. |
|
403 |
DTS.Msg.CheckStatus.InvalidInitStatus |
Task has not been configured, please configure job first |
La tarea no se ha configurado. Configure la tarea antes de modificarla. |
|
403 |
InvalidSecurityToken.Expired |
Specified SecurityToken is expired. |
El SecurityToken especificado ha expirado. Actualice la firma. |
|
400 |
Throttling.User |
Request was denied due to user flow control. |
La solicitud se denegó porque la frecuencia de solicitudes alcanzó el umbral. Inténtelo de nuevo más tarde. |
|
500 |
ServiceUnavailable |
The request has failed due to a temporary failure of the server. |
La solicitud falló debido a un tiempo de espera temporal o indisponibilidad del servidor. Reintente la operación. Si el error persiste después de reintentar, póngase en contacto con el soporte técnico. |
Visite el Centro de errores para consultar más códigos de error.