Puede configurar una tarea de migración o sincronización de datos.
Puede preconfigurar la tarea en la consola y luego obtener una vista previa de los parámetros correspondientes de OpenAPI para facilitar la especificación de los parámetros de solicitud. Para más información, consulte Preview OpenAPI request parameters.
Las tareas en un clúster dedicado solo admiten el método de facturación de configurar primero y comprar después. No se admiten tareas entre regiones.
Depuración
Parámetros de solicitud
|
Nombre |
Tipo |
Obligatorio |
Ejemplo |
Descripción |
| Action | String | Sí | ConfigureDtsJob | La acción a realizar. Establezca el valor en ConfigureDtsJob. |
| DtsJobName | String | Sí | rdsmysql_to_mysql | El nombre de la tarea de DTS. |
| SourceEndpointInstanceType | String | Sí | RDS | El tipo de instancia de origen. Valores válidos: Base de datos de Alibaba Cloud
Nota
|
| SourceEndpointInstanceID | String | No | rm-bp1imrtn6fq7h**** | El ID de la instancia de origen. Si la instancia de origen es una instancia de base de datos de Alibaba Cloud, como una instancia de RDS for MySQL, especifique el ID de dicha instancia. Si la instancia de origen es una base de datos autogestionada, el valor de este parámetro varía según el valor de SourceEndpointInstanceType. Por ejemplo, si SourceEndpointInstanceType está establecido en:
Nota Si establece el valor en CENReserve parameter description, también debe especificar el ID de la instancia CEN en el parámetro Reserve. Para más información, consulte . |
| SourceEndpointEngineName | String | No | MYSQL | El tipo de base de datos de la instancia de origen.
Nota
|
| SourceEndpointRegion | String | No | cn-hangzhou | La región de la instancia de origen. Para más información, consulte List of supported regions. Nota Este parámetro es obligatorio si la instancia de origen es una instancia de base de datos de Alibaba Cloud. |
| SourceEndpointIP | String | No | 172.16.**.*** | La dirección IP de la instancia de origen. Nota Este parámetro es obligatorio solo cuando SourceEndpointInstanceType está establecido en OTHER, EXPRESS, DG o CEN. |
| SourceEndpointPort | String | No | 3306 | El puerto del servicio de base de datos de la instancia de origen. Nota Este parámetro es obligatorio solo cuando la instancia de origen es una base de datos autogestionada. |
| SourceEndpointOracleSID | String | No | testsid | El ID del sistema (SID) de la base de datos Oracle. Nota Este parámetro es obligatorio solo cuando SourceEndpointEngineName está establecido en Oracle y la base de datos Oracle no es una instancia de Real Application Clusters (RAC). |
| SourceEndpointDatabaseName | String | No | dtstestdatabase | El nombre de la base de datos que contiene los objetos a migrar en la instancia de origen. Nota Este parámetro es obligatorio solo cuando la instancia de origen o su tipo de base de datos es PolarDB for PostgreSQL (Compatible with Oracle), PostgreSQL o MongoDB. |
| SourceEndpointUserName | String | No | dtstest | La cuenta de la base de datos de origen. Nota
|
| SourceEndpointPassword | String | No | Test123456 | La contraseña de la cuenta de la base de datos de origen. |
| SourceEndpointOwnerID | String | No | 140692647406**** | El ID de la cuenta de Alibaba Cloud a la que pertenece la instancia de origen. Nota Si especifica este parámetro, realizará una tarea de migración o sincronización de datos entre cuentas. También debe especificar el parámetro SourceEndpointRole. |
| SourceEndpointRole | String | No | ram-for-dts | El nombre del rol RAM configurado para la cuenta de Alibaba Cloud a la que pertenece la instancia de origen. Nota How to configure RAM authorization for data migration or synchronization across Alibaba Cloud accountsEste parámetro es obligatorio para la migración o sincronización de datos entre cuentas. Para más información sobre los permisos necesarios y cómo otorgarlos al rol RAM, consulte . |
| DestinationEndpointInstanceType | String | Sí | EXPRESS | El tipo de instancia de destino. Valores válidos: Base de datos de Alibaba Cloud
Nota
|
| DestinationEndpointInstanceID | String | No | vpc-bp1opxu1zkhn00gzv**** | El ID de la instancia de destino. Si la instancia de destino es una instancia de base de datos de Alibaba Cloud, como una instancia de RDS for MySQL, especifique el ID de dicha instancia. Si la instancia de destino es una base de datos autogestionada, el valor de este parámetro varía según el valor de DestinationEndpointInstanceType. Por ejemplo, si DestinationEndpointInstanceType está establecido en:
Nota Si establece el valor en CENReserve parameters, también debe especificar el ID de la instancia CEN en el parámetro Reserve. Para más información, consulte . |
| DestinationEndpointEngineName | String | No | MYSQL | El tipo de base de datos de la instancia de destino.
Nota
|
| DestinationEndpointRegion | String | No | cn-hangzhou | La región de la instancia de destino. Para más información, consulte List of supported regions. Nota Este parámetro es obligatorio si la instancia de destino es una instancia de base de datos de Alibaba Cloud. |
| DestinationEndpointIP | String | No | 172.16.**.*** | La dirección IP de la instancia de destino. Nota Este parámetro es obligatorio solo cuando DestinationEndpointInstanceType está establecido en OTHER, EXPRESS, DG o CEN. |
| DestinationEndpointPort | String | No | 3306 | El puerto del servicio de base de datos de la instancia de destino. Nota Este parámetro es obligatorio solo cuando la instancia de destino es una base de datos autogestionada. |
| DestinationEndpointDataBaseName | String | No | dtstestdata | El nombre de la base de datos a la que se migran los objetos en la instancia de destino. Nota
|
| DestinationEndpointUserName | String | No | dtstest | La cuenta de la base de datos de destino. Nota
|
| DestinationEndpointPassword | String | No | Test123456 | La contraseña de la cuenta de la base de datos de destino. Nota Create an AccessKeySi la base de datos de destino es un proyecto de MaxCompute, especifique el AccessKey secret de su cuenta de Alibaba Cloud. Para más información sobre cómo obtener un AccessKey secret, consulte . |
| DestinationEndpointOwnerID | String | No | 140692647406**** | El ID de la cuenta de Alibaba Cloud a la que pertenece la instancia de destino RDS for MySQL. Nota
|
| DestinationEndpointRole | String | No | ram-for-dts | El nombre del rol RAM configurado para la cuenta de Alibaba Cloud a la que pertenece la instancia de destino. Nota How to configure RAM authorization for cross-account data migration or synchronizationEste parámetro es obligatorio para la migración o sincronización de datos entre cuentas. Para más información sobre los permisos necesarios y cómo otorgarlos al rol RAM, consulte . |
| StructureInitialization | Boolean | Sí | true | Especifica si se debe realizar la migración o inicialización del esquema. Valores válidos:
Nota Si JobType está establecido en CHECK, solo puede establecer este parámetro en false. |
| DataInitialization | Boolean | Sí | true | Especifica si se debe realizar la sincronización inicial completa de datos. Valores válidos:
Nota Si JobType está establecido en CHECK, solo puede establecer este parámetro en false. |
| DataSynchronization | Boolean | Sí | true | Especifica si se debe realizar la migración o sincronización incremental de datos. Valores válidos:
Nota Si JobType está establecido en CHECK, solo puede establecer este parámetro en false. |
| DbList | String | Sí | {"dtstest":{"name":"dtstest","all":true}} | Los objetos que desea migrar o sincronizar. El valor es una cadena JSON. Para más información, consulte Description of migration, synchronization, or subscription objects.
|
| Reserve | String | No | { "srcInstanceId": "cen-9kqshqum*******" } | El parámetro reservado para DTS, que es una cadena JSON. Puede usar este parámetro para proporcionar información adicional sobre las bases de datos de origen y destino, como el formato de almacenamiento de datos para la base de datos Kafka de destino, el ID de instancia de Cloud Enterprise Network (CEN) o la configuración de la función de extracción, transformación y carga (ETL). Para más información, consulte Description of the Reserve parameter. |
| Checkpoint | String | No | 1610540493 | El desplazamiento inicial de la migración o sincronización incremental de datos. El valor es una marca de tiempo UNIX. Unidad: segundos. Nota Si especifica el parámetro Checkpoint, debe asegurarse de que ninguna otra tarea de DTS en ejecución utilice la misma base de datos de origen que la instancia de DTS de destino. |
| DestinationEndpointOracleSID | String | No | testsid | El SID de la base de datos Oracle. Nota Este parámetro es obligatorio solo cuando DestinationEndpointEngineName está establecido en Oracle y la base de datos Oracle no es una instancia RAC. |
| JobType | String | Sí | SYNC | El tipo de tarea. Valores válidos:
Nota
|
| DtsJobId | String | No | k2gm967v16f**** | El ID de la tarea de migración o sincronización de datos. Nota DescribeDtsJobsPuede llamar a la operación para consultar el ID de la tarea. |
| DtsInstanceId | String | No | dtsk2gm967v16f**** | El ID de la instancia de migración o sincronización de datos. Nota DescribeDtsJobsPuede llamar a la operación para consultar el ID de la instancia. |
| DelayPhone | String | No | 1361234****,1371234**** | Los números de celular de los contactos que reciben alertas relacionadas con la latencia. Separe varios números de celular con comas (,). Nota
|
| DelayRuleTime | Long | No | 10 | El umbral para activar una alerta de latencia. Unidad: segundos. El valor debe ser un número entero. Establezca el umbral en 10 segundos o más para evitar falsas alertas causadas por fluctuaciones en la red y la base de datos. Nota Este parámetro es obligatorio cuando DelayNotice está establecido en true. |
| DelayNotice | Boolean | No | true | Especifica si se debe monitorear la latencia de la tarea. Valores válidos:
|
| ErrorPhone | String | No | 1361234****,1371234**** | Los números de celular de los contactos que reciben alertas relacionadas con excepciones. Separe varios números de celular con comas (,). Nota
|
| ErrorNotice | Boolean | No | true | Especifica si se debe monitorear el estado de la tarea. Valores válidos:
|
| SynchronizationDirection | String | No | Forward | La dirección de sincronización. Valores válidos:
Nota
|
| RegionId | String | No | cn-hangzhou | La región donde se encuentra la instancia de DTS. Para más información, consulte List of supported regions. |
| DedicatedClusterId | String | No | dtscluster_atyl3b5214uk*** | El ID del clúster dedicado de DTS. Nota Si especifica el ID de un clúster dedicado, la tarea se programará en dicho clúster. |
| FileOssUrl | String | No | http://db-list-os-file.oss-cn-shanghai.aliyuncs.com/8e42_121852**********_79dd3aeabe2f43cdb************** | La URL del archivo de Object Storage Service (OSS) para la tarea. |
| DataCheckConfigure | String | No | {"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}}} | Los parámetros para la verificación de datos, incluidas las configuraciones de verificación y alertas. El valor es una cadena JSON. Para más información, consulte DataCheckConfigure parameters. |
| DisasterRecoveryJob | Boolean | No | true | Especifica si la instancia es una instancia de recuperación ante desastres. Valores válidos:
|
| SourceEndpointVSwitchID | String | No | vsw-bp10df3mxae6lpmku**** | El ID del vSwitch para el enlace de envío de datos. |
| DtsBisLabel | String | No | normal | La etiqueta de entorno de la instancia de DTS. Valores válidos:
|
| SrcCaCertificateOssUrl | String | No | **** | La ruta del certificado de la autoridad de certificación (CA) si la base de datos de origen está conectada mediante SSL. Nota Esta función no es compatible. No especifique este parámetro. |
| SrcCaCertificatePassword | String | No | **** | La contraseña del certificado CA si la base de datos de origen está conectada mediante SSL. Nota Esta función no es compatible. No especifique este parámetro. |
| DestCaCertificateOssUrl | String | No | **** | La ruta del certificado CA si la base de datos de destino está conectada mediante SSL. Nota Esta función no es compatible. No especifique este parámetro. |
| DestCaCertificatePassword | String | No | **** | La contraseña del certificado CA si la base de datos de destino está conectada mediante SSL. Nota Esta función no es compatible. No especifique este parámetro. |
| MinDu | double | No | 1 | El número mínimo de unidades DTS (DU). Nota Este parámetro solo es compatible con instancias serverless. |
| MaxDu | double | No | 16 | El número máximo de DU. Nota Este parámetro solo es compatible con instancias serverless. |
| SrcClientCertOssUrl | String | No | **** | La ruta del certificado de cliente si la base de datos de origen está conectada mediante SSL. Nota Esta función no es compatible. No especifique este parámetro. |
| SrcClientKeyOssUrl | String | No | **** | La ruta de la clave privada del certificado de cliente si la base de datos de origen está conectada mediante SSL. Nota Esta función no es compatible. No especifique este parámetro. |
| SrcClientPassword | String | No | **** | La contraseña de la clave privada del certificado de cliente si la base de datos de origen está conectada mediante SSL. Nota Esta función no es compatible. No especifique este parámetro. |
| DestClientCertOssUrl | String | No | **** | La ruta del certificado de cliente si la base de datos de destino está conectada mediante SSL. Nota Esta función no es compatible. No especifique este parámetro. |
| DestClientKeyOssUrl | String | No | **** | La ruta de la clave privada del certificado de cliente si la base de datos de destino está conectada mediante SSL. Nota Esta función no es compatible. No especifique este parámetro. |
| DestClientPassword | String | No | **** | La contraseña de la clave privada del certificado de cliente si la base de datos de destino está conectada mediante SSL. Nota Esta función no es compatible. No especifique este parámetro. |
| SrcPrimaryVswId | String | No | **** | El vSwitch principal del origen para VPC NAT. |
| SrcSecondaryVswId | String | No | **** | El vSwitch secundario del origen para VPC NAT. |
| DestPrimaryVswId | String | No | **** | El vSwitch principal del destino para VPC NAT. |
| DestSecondaryVswId | String | No | **** | El vSwitch secundario del destino para VPC NAT. |
| ResourceGroupId | String | No | rg-acfmzawhxxc**** | El ID del resource group. |
Parámetros de respuesta
|
Nombre |
Tipo |
Ejemplo |
Descripción |
|
HttpStatusCode |
String |
200 |
El código de estado HTTP. |
|
RequestId |
String |
224DB9F7-3100-4899-AB9C-C938BCCB**** |
El ID de la solicitud. |
|
ErrCode |
String |
InternalError |
El código de error devuelto si la llamada falla. |
|
DtsJobId |
String |
k2gm967v16f**** |
El ID de la tarea de migración o sincronización de datos. |
|
DtsInstanceId |
String |
dtsk2gm967v16f**** |
El ID de la instancia de migración o sincronización de datos. |
|
Success |
String |
true |
Indica si la solicitud fue exitosa. |
|
ErrMessage |
String |
The request processing has failed due to some unknown error. |
El mensaje de error devuelto si la llamada falla. |
Ejemplos
Solicitud de ejemplo
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>
Respuestas de ejemplo
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 error
|
HttpCode |
Código de error |
Mensaje de error |
Descripción |
|
403 |
InvalidParameter.KafkaBrokerInvalid |
kafka broker configuration must be intranet IP |
El broker del clúster Kafka autogestionado en una instancia ECS debe configurarse mediante una dirección IP. No se admiten nombres de host. |
|
403 |
InvalidParameter.KafkaHostInvalid |
kafaka host name should be intranet IP |
El nombre de host del clúster Kafka no es compatible. Introduzca una dirección IP interna. |
|
403 |
UpdateJob.OperationDenied.InitStatus |
The operation is not permitted due to Dts job status is init. |
La tarea ha comenzado y no se puede modificar. Reconfigure la tarea o modifique los objetos de sincronización. |
|
403 |
GetMongoDbShardInfo.NoShardAddress |
MongoDb has not yet opened the shard connection address, please try again after opening. |
No se pudo obtener la información de conexión del shard. Compruebe las configuraciones de parámetros para confirmar que la base de datos es una base de datos MongoDB fragmentada y que la dirección del shard está habilitada. |
|
403 |
GetMongoDbShardInfo.EmptyInstances |
Failed to get MongoDb shard information, the return is empty. |
No se pudo obtener la información del shard. Compruebe las configuraciones de parámetros para confirmar que la base de datos es una base de datos MongoDB fragmentada. |
|
403 |
CheckJobFailed.ServerUnAvailable |
Unable to check whether the node can connect to the database because the node service is unavailable. |
Algunos nodos de DTS no están disponibles. Inténtelo de nuevo. Si el problema persiste, póngase en contacto con el soporte 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. |
DTS no admite la sincronización de datos para instancias DRDS que utilizan bases de datos PolarDB for MySQL para la fragmentación de bases de datos. |
|
403 |
DbTypeNotSupport.OnlyReadRDS |
Synchronization is not currently supported due to latency issues with read-only DRDS instances. |
DTS no admite la sincronización de datos para instancias DRDS que utilizan bases de datos de solo lectura para la fragmentación de bases de datos. |
|
403 |
DTS.Msg.InvalidParameter.KafkaBrokerInvalid |
kafka broker configuration must be intranet IP |
El broker del clúster Kafka autogestionado en una instancia ECS debe configurarse mediante una dirección IP. No se admiten nombres de host. |
|
403 |
DTS.Msg.InvalidParameter.KafkaHostInvalid |
kafaka host name should be intranet IP |
El nombre de host del clúster Kafka no es compatible. Introduzca una dirección IP interna. |
|
403 |
DTS.Msg.UpdateJob.OperationDenied.InitStatus |
The operation is not permitted due to Dts job status is init. |
La tarea ha comenzado y no se puede modificar. Reconfigure la tarea o modifique los objetos de sincronización. |
|
403 |
DTS.Msg.GetMongoDbShardInfo.NoShardAddress |
MongoDb has not yet opened the shard connection address, please try again after opening. |
No se pudo obtener la información de conexión del shard. Compruebe las configuraciones de parámetros para confirmar que la base de datos es una base de datos MongoDB fragmentada y que la dirección del shard está habilitada. |
|
403 |
DTS.Msg.GetMongoDbShardInfo.EmptyInstances |
Failed to get MongoDb shard information, the return is empty. |
No se pudo obtener la información del shard. Compruebe las configuraciones de parámetros para confirmar que la base de datos es una base de datos MongoDB fragmentada. |
|
403 |
DTS.Msg.CheckJobFailed.ServerUnAvailable |
Unable to check whether the node can connect to the database because the node service is unavailable. |
Algunos nodos de DTS no están disponibles. Inténtelo de nuevo. Si el problema persiste, póngase en contacto con el soporte 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. |
DTS no admite la sincronización de datos para instancias DRDS que utilizan bases de datos PolarDB for MySQL para la fragmentación de bases de datos. |
|
403 |
DTS.Msg.DbTypeNotSupport.OnlyReadRDS |
Synchronization is not currently supported due to latency issues with read-only DRDS instances. |
DTS no admite la sincronización de datos para instancias DRDS que utilizan bases de datos de solo lectura para la fragmentación de bases de datos. |
|
403 |
InvalidSecurityToken.Expired |
Specified SecurityToken is expired. |
La firma ha caducado. Actualice la firma. |
|
400 |
Throttling.User |
Request was denied due to user flow control. |
La solicitud fue denegada porque la frecuencia de solicitudes alcanzó el límite. Inténtelo de nuevo más tarde. |
|
500 |
ServiceUnavailable |
The request has failed due to a temporary failure of the server. |
La solicitud falló porque el servidor agotó el tiempo de espera o no estaba disponible. Inténtelo de nuevo. Si la solicitud vuelve a fallar, póngase en contacto con el soporte técnico. |
Para más información sobre otros códigos de error, consulte el Centro de errores de API para el sitio internacional.