Vous pouvez configurer une tâche de migration ou de synchronisation des données.
Il est possible de préconfigurer la tâche dans la console, puis de consulter les paramètres OpenAPI correspondants pour vous aider à spécifier les paramètres de requête. Pour plus d'informations, consultez Aperçu des paramètres de requête OpenAPI.
Les tâches exécutées sur un cluster dédié prennent uniquement en charge le mode de facturation « configuration préalable, achat ultérieur ». Les tâches interrégions ne sont pas prises en charge.
Débogage
Paramètres de requête
|
Nom |
Type |
Obligatoire |
Exemple |
Description |
| Action | String | Oui | ConfigureDtsJob | L'action à exécuter. Définissez la valeur sur ConfigureDtsJob. |
| DtsJobName | String | Oui | rdsmysql_to_mysql | Le nom de la tâche DTS. |
| SourceEndpointInstanceType | String | Oui | RDS | Le type de l'instance source. Valeurs possibles : Base de données Alibaba Cloud
Remarque
|
| SourceEndpointInstanceID | String | Non | rm-bp1imrtn6fq7h**** | L'ID de l'instance source. Si l'instance source est une instance de base de données Alibaba Cloud, telle qu'une instance RDS for MySQL, spécifiez l'ID de l'instance de base de données Alibaba Cloud. Si l'instance source est une base de données auto-gérée, la valeur de ce paramètre varie en fonction de la valeur de SourceEndpointInstanceType. Par exemple, si SourceEndpointInstanceType est défini sur :
Remarque Si vous définissez la valeur sur CENDescription du paramètre Reserve, vous devez également spécifier l'ID de l'instance CEN dans le paramètre Reserve. Pour plus d'informations, consultez . |
| SourceEndpointEngineName | String | Non | MYSQL | Le type de base de données de l'instance source.
Remarque
|
| SourceEndpointRegion | String | Non | cn-hangzhou | La région de l'instance source. Pour plus d'informations, consultez Liste des régions prises en charge. Remarque Ce paramètre est obligatoire si l'instance source est une instance de base de données Alibaba Cloud. |
| SourceEndpointIP | String | Non | 172.16.**.*** | L'adresse IP de l'instance source. Remarque Ce paramètre est requis uniquement lorsque SourceEndpointInstanceType est défini sur OTHER, EXPRESS, DG ou CEN. |
| SourceEndpointPort | String | Non | 3306 | Le port du service de base de données de l'instance source. Remarque Ce paramètre est requis uniquement lorsque l'instance source est une base de données auto-gérée. |
| SourceEndpointOracleSID | String | Non | testsid | L'identifiant système (SID) de la base de données Oracle. Remarque Ce paramètre est requis uniquement lorsque SourceEndpointEngineName est défini sur Oracle et que la base de données Oracle n'est pas une instance Real Application Clusters (RAC). |
| SourceEndpointDatabaseName | String | Non | dtstestdatabase | Le nom de la base de données contenant les objets à migrer dans l'instance source. Remarque Ce paramètre est requis uniquement lorsque l'instance source ou le type de base de données de l'instance source est PolarDB for PostgreSQL (Compatible with Oracle), PostgreSQL ou MongoDB. |
| SourceEndpointUserName | String | Non | dtstest | Le compte de base de données de la base de données source. Remarque
|
| SourceEndpointPassword | String | Non | Test123456 | Le mot de passe du compte de base de données pour la base de données source. |
| SourceEndpointOwnerID | String | Non | 140692647406**** | L'ID du compte Alibaba Cloud auquel appartient l'instance source. Remarque Si vous spécifiez ce paramètre, vous effectuez une tâche de migration ou de synchronisation de données inter-comptes. Vous devez également spécifier le paramètre SourceEndpointRole. |
| SourceEndpointRole | String | Non | ram-for-dts | Le nom du rôle RAM configuré pour le compte Alibaba Cloud auquel appartient l'instance source. Remarque Comment configurer l'autorisation RAM pour la migration ou la synchronisation de données entre comptes Alibaba CloudCe paramètre est requis pour la migration ou la synchronisation de données inter-comptes. Pour plus d'informations sur les autorisations requises et sur la manière de les accorder au rôle RAM, consultez . |
| DestinationEndpointInstanceType | String | Oui | EXPRESS | Le type de l'instance de destination. Valeurs possibles : Base de données Alibaba Cloud
Remarque
|
| DestinationEndpointInstanceID | String | Non | vpc-bp1opxu1zkhn00gzv**** | L'ID de l'instance de destination. Si l'instance de destination est une instance de base de données Alibaba Cloud, telle qu'une instance RDS for MySQL, spécifiez l'ID de l'instance de base de données Alibaba Cloud. Si l'instance de destination est une base de données auto-gérée, la valeur de ce paramètre varie en fonction de la valeur de DestinationEndpointInstanceType. Par exemple, si DestinationEndpointInstanceType est défini sur :
Remarque Si vous définissez la valeur sur CENParamètres Reserve, vous devez également spécifier l'ID de l'instance CEN dans le paramètre Reserve. Pour plus d'informations, consultez . |
| DestinationEndpointEngineName | String | Non | MYSQL | Le type de base de données de l'instance de destination.
Remarque
|
| DestinationEndpointRegion | String | Non | cn-hangzhou | La région de l'instance de destination. Pour plus d'informations, consultez Liste des régions prises en charge. Remarque Ce paramètre est obligatoire si l'instance de destination est une instance de base de données Alibaba Cloud. |
| DestinationEndpointIP | String | No | 172.16.**.*** | L'adresse IP de l'instance de destination. Remarque Ce paramètre est requis uniquement lorsque DestinationEndpointInstanceType est défini sur OTHER, EXPRESS, DG ou CEN. |
| DestinationEndpointPort | String | No | 3306 | Le port du service de base de données de l'instance de destination. Remarque Ce paramètre est requis uniquement lorsque l'instance de destination est une base de données auto-gérée. |
| DestinationEndpointDataBaseName | String | No | dtstestdata | Le nom de la base de données vers laquelle les objets sont migrés dans l'instance de destination. Remarque
|
| DestinationEndpointUserName | String | No | dtstest | Le compte de base de données de la base de données de destination. Remarque
|
| DestinationEndpointPassword | String | No | Test123456 | Le mot de passe du compte de base de données pour la base de données de destination. Remarque Créer une AccessKeySi la base de données de destination est un projet MaxCompute, spécifiez le secret AccessKey de votre compte Alibaba Cloud. Pour savoir comment obtenir un secret AccessKey, consultez . |
| DestinationEndpointOwnerID | String | No | 140692647406**** | L'ID du compte Alibaba Cloud auquel appartient l'instance RDS for MySQL de destination. Remarque
|
| DestinationEndpointRole | String | No | ram-for-dts | Le nom du rôle RAM configuré pour le compte Alibaba Cloud auquel appartient l'instance de destination. Remarque Comment configurer l'autorisation RAM pour la migration ou la synchronisation de données inter-comptesCe paramètre est requis pour la migration ou la synchronisation de données inter-comptes. Pour plus d'informations sur les autorisations requises et sur la manière de les accorder au rôle RAM, consultez . |
| StructureInitialization | Boolean | Yes | true | Indique s'il faut effectuer la migration ou l'initialisation du schéma. Valeurs possibles :
Remarque Si JobType est défini sur CHECK, vous ne pouvez définir ce paramètre que sur false. |
| DataInitialization | Boolean | Yes | true | Indique s'il faut effectuer la synchronisation initiale des données complètes. Valeurs possibles :
Remarque Si JobType est défini sur CHECK, vous ne pouvez définir ce paramètre que sur false. |
| DataSynchronization | Boolean | Yes | true | Indique s'il faut effectuer la migration ou la synchronisation incrémentielle des données. Valeurs possibles :
Remarque Si JobType est défini sur CHECK, vous ne pouvez définir ce paramètre que sur false. |
| DbList | String | Yes | {"dtstest":{"name":"dtstest","all":true}} | Les objets que vous souhaitez migrer ou synchroniser. La valeur est une chaîne JSON. Pour plus d'informations, consultez Description des objets de migration, de synchronisation ou d'abonnement.
|
| Reserve | String | No | { "srcInstanceId": "cen-9kqshqum*******" } | Le paramètre réservé pour DTS, qui est une chaîne JSON. Vous pouvez utiliser ce paramètre pour fournir des informations supplémentaires sur les bases de données source et de destination, telles que le format de stockage des données pour la base de données Kafka de destination, l'ID d'instance d'un Cloud Enterprise Network (CEN) ou la configuration de la fonctionnalité extract, transform, and load (ETL). Pour plus d'informations, consultez Description du paramètre Reserve. |
| Checkpoint | String | No | 1610540493 | Le décalage de départ de la migration ou de la synchronisation incrémentielle des données. La valeur est un horodatage UNIX. Unité : secondes. Remarque Si vous spécifiez le paramètre Checkpoint, assurez-vous qu'aucune autre tâche DTS en cours d'exécution n'utilise la même base de données source que l'instance DTS de destination. |
| DestinationEndpointOracleSID | String | No | testsid | Le SID de la base de données Oracle. Remarque Ce paramètre est requis uniquement lorsque DestinationEndpointEngineName est défini sur Oracle et que la base de données Oracle n'est pas une instance RAC. |
| JobType | String | Yes | SYNC | Le type de tâche. Valeurs possibles :
Remarque
|
| DtsJobId | String | No | k2gm967v16f**** | L'ID de la tâche de migration ou de synchronisation de données. Remarque DescribeDtsJobsVous pouvez appeler l'opération pour interroger l'ID de la tâche. |
| DtsInstanceId | String | No | dtsk2gm967v16f**** | L'ID de l'instance de migration ou de synchronisation de données. Remarque DescribeDtsJobsVous pouvez appeler l'opération pour interroger l'ID de l'instance. |
| DelayPhone | String | No | 1361234****,1371234**** | Les numéros de mobile des contacts qui reçoivent les alertes liées à la latence. Séparez plusieurs numéros de mobile par des virgules (,). Remarque
|
| DelayRuleTime | Long | No | 10 | Le seuil de déclenchement d'une alerte de latence. Unité : secondes. La valeur doit être un entier. Définissez le seuil à 10 secondes ou plus pour éviter les fausses alertes causées par les fluctuations du réseau et de la base de données. Remarque Ce paramètre est requis lorsque DelayNotice est défini sur true. |
| DelayNotice | Boolean | No | true | Indique s'il faut surveiller la latence de la tâche. Valeurs possibles :
|
| ErrorPhone | String | No | 1361234****,1371234**** | Les numéros de mobile des contacts qui reçoivent les alertes liées aux exceptions. Séparez plusieurs numéros de mobile par des virgules (,). Remarque
|
| ErrorNotice | Boolean | No | true | Indique s'il faut surveiller l'état de la tâche. Valeurs possibles :
|
| SynchronizationDirection | String | No | Forward | La direction de la synchronisation. Valeurs possibles :
Remarque
|
| RegionId | String | No | cn-hangzhou | La région où se trouve l'instance DTS. Pour plus d'informations, consultez Liste des régions prises en charge. |
| DedicatedClusterId | String | No | dtscluster_atyl3b5214uk*** | L'ID du cluster dédié DTS. Remarque Si vous spécifiez l'ID d'un cluster dédié, la tâche est planifiée sur le cluster. |
| FileOssUrl | String | No | http://db-list-os-file.oss-cn-shanghai.aliyuncs.com/8e42_121852**********_79dd3aeabe2f43cdb************** | L'URL du fichier Object Storage Service (OSS) pour la tâche. |
| 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}}} | Les paramètres de vérification des données, y compris les configurations pour la vérification des données et les alertes. La valeur est une chaîne JSON. Pour plus d'informations, consultez Paramètres DataCheckConfigure. |
| DisasterRecoveryJob | Boolean | No | true | Indique si l'instance est une instance de reprise après sinistre. Valeurs possibles :
|
| SourceEndpointVSwitchID | String | No | vsw-bp10df3mxae6lpmku**** | L'ID du vSwitch pour le lien d'expédition des données. |
| DtsBisLabel | String | No | normal | Le tag d'environnement de l'instance DTS. Valeurs possibles :
|
| SrcCaCertificateOssUrl | String | No | **** | Le chemin du certificat d'autorité de certification (CA) si la base de données source est connectée via SSL. Remarque Cette fonctionnalité n'est pas prise en charge. Ne spécifiez pas ce paramètre. |
| SrcCaCertificatePassword | String | No | **** | Le mot de passe du certificat CA si la base de données source est connectée via SSL. Remarque Cette fonctionnalité n'est pas prise en charge. Ne spécifiez pas ce paramètre. |
| DestCaCertificateOssUrl | String | No | **** | Le chemin du certificat CA si la base de données de destination est connectée via SSL. Remarque Cette fonctionnalité n'est pas prise en charge. Ne spécifiez pas ce paramètre. |
| DestCaCertificatePassword | String | No | **** | Le mot de passe du certificat CA si la base de données de destination est connectée via SSL. Remarque Cette fonctionnalité n'est pas prise en charge. Ne spécifiez pas ce paramètre. |
| MinDu | double | No | 1 | Le nombre minimal d'unités DTS (DU). Remarque Ce paramètre est pris en charge uniquement pour les instances serverless. |
| MaxDu | double | No | 16 | Le nombre maximal d'unités DU. Remarque Ce paramètre est pris en charge uniquement pour les instances serverless. |
| SrcClientCertOssUrl | String | No | **** | Chemin du certificat client si la base de données source est connectée via SSL. Remarque Cette fonctionnalité n'est pas prise en charge. Ne spécifiez pas ce paramètre. |
| SrcClientKeyOssUrl | String | No | **** | Chemin de la clé privée du certificat client si la base de données source est connectée via SSL. Remarque Cette fonctionnalité n'est pas prise en charge. Ne spécifiez pas ce paramètre. |
| SrcClientPassword | String | No | **** | Mot de passe de la clé privée du certificat client si la base de données source est connectée via SSL. Remarque Cette fonctionnalité n'est pas prise en charge. Ne spécifiez pas ce paramètre. |
| DestClientCertOssUrl | String | No | **** | Chemin du certificat client si la base de données de destination est connectée via SSL. Remarque Cette fonctionnalité n'est pas prise en charge. Ne spécifiez pas ce paramètre. |
| DestClientKeyOssUrl | String | No | **** | Chemin de la clé privée du certificat client si la base de données de destination est connectée via SSL. Remarque Cette fonctionnalité n'est pas prise en charge. Ne spécifiez pas ce paramètre. |
| DestClientPassword | String | No | **** | Mot de passe de la clé privée du certificat client si la base de données de destination est connectée via SSL. Remarque Cette fonctionnalité n'est pas prise en charge. Ne spécifiez pas ce paramètre. |
| SrcPrimaryVswId | String | No | **** | vSwitch principal de la source pour le NAT VPC. |
| SrcSecondaryVswId | String | No | **** | vSwitch secondaire de la source pour le NAT VPC. |
| DestPrimaryVswId | String | No | **** | vSwitch principal de la destination pour le NAT VPC. |
| DestSecondaryVswId | String | No | **** | vSwitch secondaire de la destination pour le NAT VPC. |
| ResourceGroupId | String | No | rg-acfmzawhxxc**** | ID du groupe de ressources. |
Paramètres de réponse
|
Nom |
Type |
Exemple |
Description |
|
HttpStatusCode |
String |
200 |
Le code d'état HTTP. |
|
RequestId |
String |
224DB9F7-3100-4899-AB9C-C938BCCB**** |
L'identifiant de la requête. |
|
ErrCode |
String |
InternalError |
Le code d'erreur renvoyé en cas d'échec de l'appel. |
|
DtsJobId |
String |
k2gm967v16f**** |
L'identifiant de la tâche de migration ou de synchronisation des données. |
|
DtsInstanceId |
String |
dtsk2gm967v16f**** |
L'identifiant de l'instance de migration ou de synchronisation des données. |
|
Success |
String |
true |
Indique si la requête a abouti. |
|
ErrMessage |
String |
The request processing has failed due to some unknown error. |
Le message d'erreur renvoyé en cas d'échec de l'appel. |
Exemples
Exemple de requête
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>
Exemples de réponses
Format 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>
Format JSON
HTTP/1.1 200 OK
Content-Type:application/json
{
"DtsJobId" : "k2gm967v16f****",
"RequestId" : "224DB9F7-3100-4899-AB9C-C938BCCB****",
"HttpStatusCode" : 200,
"DtsInstanceId" : "dtsk2gm967v16f****",
"Success" : true
}
Codes d'erreur
|
HttpCode |
Code d'erreur |
Message d'erreur |
Description |
|
403 |
InvalidParameter.KafkaBrokerInvalid |
kafka broker configuration must be intranet IP |
Le courtier du cluster Kafka auto-géré sur une instance ECS doit être configuré à l'aide d'une adresse IP. Les noms d'hôte ne sont pas pris en charge. |
|
403 |
InvalidParameter.KafkaHostInvalid |
kafaka host name should be intranet IP |
Le nom d'hôte du cluster Kafka n'est pas pris en charge. Saisissez une adresse IP interne. |
|
403 |
UpdateJob.OperationDenied.InitStatus |
The operation is not permitted due to Dts job status is init. |
La tâche a démarré et ne peut pas être modifiée. Reconfigurez la tâche ou modifiez les objets de synchronisation. |
|
403 |
GetMongoDbShardInfo.NoShardAddress |
MongoDb has not yet opened the shard connection address, please try again after opening. |
Échec de l'obtention des informations de connexion au shard. Vérifiez les configurations des paramètres pour confirmer que la base de données est une base de données MongoDB fragmentée et que l'adresse de shard est activée. |
|
403 |
GetMongoDbShardInfo.EmptyInstances |
Failed to get MongoDb shard information, the return is empty. |
Échec de l'obtention des informations de shard. Vérifiez les configurations des paramètres pour confirmer que la base de données est une base de données MongoDB fragmentée. |
|
403 |
CheckJobFailed.ServerUnAvailable |
Unable to check whether the node can connect to the database because the node service is unavailable. |
Certains nœuds DTS sont indisponibles. Réessayez. Si le problème persiste, contactez le support technique. |
|
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 ne prend pas en charge la synchronisation des données pour les instances DRDS qui utilisent PolarDB pour les bases de données MySQL dans le cadre du sharding de base de données. |
|
403 |
DbTypeNotSupport.OnlyReadRDS |
Synchronization is not currently supported due to latency issues with read-only DRDS instances. |
DTS ne prend pas en charge la synchronisation des données pour les instances DRDS qui utilisent des bases de données en lecture seule dans le cadre du sharding de base de données. |
|
403 |
DTS.Msg.InvalidParameter.KafkaBrokerInvalid |
kafka broker configuration must be intranet IP |
Le courtier du cluster Kafka auto-géré sur une instance ECS doit être configuré à l'aide d'une adresse IP. Les noms d'hôte ne sont pas pris en charge. |
|
403 |
DTS.Msg.InvalidParameter.KafkaHostInvalid |
kafaka host name should be intranet IP |
Le nom d'hôte du cluster Kafka n'est pas pris en charge. Saisissez une adresse IP interne. |
|
403 |
DTS.Msg.UpdateJob.OperationDenied.InitStatus |
The operation is not permitted due to Dts job status is init. |
La tâche a démarré et ne peut pas être modifiée. Reconfigurez la tâche ou modifiez les objets de synchronisation. |
|
403 |
DTS.Msg.GetMongoDbShardInfo.NoShardAddress |
MongoDb has not yet opened the shard connection address, please try again after opening. |
Échec de l'obtention des informations de connexion au shard. Vérifiez les configurations des paramètres pour confirmer que la base de données est une base de données MongoDB fragmentée et que l'adresse de shard est activée. |
|
403 |
DTS.Msg.GetMongoDbShardInfo.EmptyInstances |
Failed to get MongoDb shard information, the return is empty. |
Échec de l'obtention des informations de shard. Vérifiez les configurations des paramètres pour confirmer que la base de données est une base de données MongoDB fragmentée. |
|
403 |
DTS.Msg.CheckJobFailed.ServerUnAvailable |
Unable to check whether the node can connect to the database because the node service is unavailable. |
Certains nœuds DTS sont indisponibles. Réessayez. Si le problème persiste, contactez le support technique. |
|
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 ne prend pas en charge la synchronisation des données pour les instances DRDS qui utilisent PolarDB pour les bases de données MySQL dans le cadre du sharding de base de données. |
|
403 |
DTS.Msg.DbTypeNotSupport.OnlyReadRDS |
Synchronization is not currently supported due to latency issues with read-only DRDS instances. |
DTS ne prend pas en charge la synchronisation des données pour les instances DRDS qui utilisent des bases de données en lecture seule dans le cadre du sharding de base de données. |
|
403 |
InvalidSecurityToken.Expired |
Specified SecurityToken is expired. |
La signature a expiré. Mettez à jour la signature. |
|
400 |
Throttling.User |
Request was denied due to user flow control. |
La requête a été refusée car la fréquence des requêtes a atteint la limite. Réessayez ultérieurement. |
|
500 |
ServiceUnavailable |
The request has failed due to a temporary failure of the server. |
La requête a échoué car le serveur a expiré ou était indisponible. Réessayez. Si la requête échoue à nouveau, contactez le support technique. |
Pour plus d'informations sur les autres codes d'erreur, consultez le Centre d'erreurs API pour le site international.