ConfigureMigrationJob - Data Transmission Service - Centre de documentation Alibaba Cloud

Configure une tâche de migration de données.

Après avoir appelé cette opération pour configurer une tâche de migration de données, celle-ci démarre automatiquement. Inutile d'appeler l'opération StartMigrationJob pour lancer la tâche.

Le démarrage d'une tâche de migration peut échouer en raison d'échecs lors de la pré-vérification. Appelez l'opération DescribeMigrationJobStatus pour obtenir les messages d'erreur relatifs à ces échecs. Corrigez ensuite le problème en vous basant sur ces messages. Une fois le problème résolu, appelez l'opération StartMigrationJob pour redémarrer la tâche de migration de données.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	ConfigureMigrationJob	Opération à effectuer. Définissez la valeur sur ConfigureMigrationJob.
DestinationEndpoint.InstanceType	String	Oui	RDS	Type d'instance de la base de données de destination. Valeurs possibles : ECS : base de données auto-gérée hébergée sur Elastic Compute Service (ECS) LocalInstance : base de données auto-gérée disposant d'une adresse IP publique RDS : instance ApsaraDB RDS DRDS : instance PolarDB-X MongoDB : instance ApsaraDB for MongoDB Redis : instance ApsaraDB for Redis PetaData : instance HybridDB for MySQL POLARDB : cluster PolarDB for MySQL ou cluster PolarDB for PostgreSQL PolarDB_o : cluster PolarDB O Edition AnalyticDB : cluster AnalyticDB for MySQL V3.0 ou V2.0 Greenplum : instance AnalyticDB for PostgreSQL
MigrationJobId	String	Oui	dtsl3m1213ye7l****	ID de l'instance de migration de données. Appelez l'opération DescribeMigrationJobs pour interroger l'ID de l'instance.
MigrationJobName	String	Oui	MySQL_TO_RDS	Nom de la tâche de migration de données. Le nom peut comporter jusqu'à 32 caractères. Nous vous recommandons de spécifier un nom explicite pour identifier la tâche. Le nom de la tâche n'a pas besoin d'être unique.
MigrationMode.DataIntialization	Boolean	Oui	true	Indique s'il faut effectuer la migration complète des données. Valeurs possibles : true : oui false : non Remarque Pour plus d'informations sur les bases de données qui prennent en charge la migration complète des données, consultez Bases de données et types de migration pris en charge.
MigrationMode.DataSynchronization	Boolean	Oui	true	Indique s'il faut effectuer la migration incrémentielle des données. Valeurs possibles : true : oui false : non Remarque Pour plus d'informations sur les bases de données qui prennent en charge la migration incrémentielle des données, consultez Bases de données et types de migration pris en charge.
MigrationMode.StructureIntialization	Boolean	Oui	true	Indique s'il faut effectuer la migration du schéma. Valeurs possibles : true : oui false : non Remarque Pour plus d'informations sur les bases de données qui prennent en charge la migration du schéma, consultez Bases de données et types de migration pris en charge.
MigrationObject	String	Oui	[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]	Objets à migrer. La valeur est une chaîne JSON et peut contenir des expressions régulières. Pour plus d'informations, consultez MigrationObject.
SourceEndpoint.InstanceType	String	Oui	RDS	Type d'instance de la base de données source. Valeurs possibles : RDS : instance ApsaraDB RDS ECS : base de données auto-gérée hébergée sur ECS LocalInstance : base de données auto-gérée disposant d'une adresse IP publique Express : base de données auto-gérée connectée via Express Connect, VPN Gateway ou Smart Access Gateway dg : base de données auto-gérée connectée via Database Gateway cen : base de données auto-gérée connectée via Cloud Enterprise Network (CEN) MongoDB : instance ApsaraDB for MongoDB POLARDB : cluster PolarDB for MySQL ou cluster PolarDB for PostgreSQL PolarDB_o : cluster PolarDB O Edition
RegionId	String	Non	cn-hangzhou	ID de la région où réside l'instance de migration de données. Pour plus d'informations, consultez Liste des régions prises en charge. Remarque L'ID de région de l'instance de migration de données est identique à celui de la base de données de destination.
SourceEndpoint.InstanceID	String	Non	rm-bp1i99e8l7913****	ID de l'instance qui héberge la base de données source. Remarque Spécifiez l'ID de l'instance uniquement si le paramètre SourceEndpoint.InstanceType est défini sur RDS, ECS, Express, MongoDB, POLARDB ou PolarDB_o. Par exemple, si le paramètre SourceEndpoint.InstanceType est défini sur ECS, spécifiez l'ID de l'instance ECS. Si le paramètre SourceEndpoint.InstanceType est défini sur Express, spécifiez l'ID du réseau privé virtuel (VPC).
SourceEndpoint.EngineName	String	Non	MySQL	Type de moteur de la base de données source. Valeurs possibles : MySQL, TiDB, SQLServer, PostgreSQL, Oracle, MongoDB, Redis, POLARDB et polardb_pg. Remarque Spécifiez le type de moteur uniquement si le paramètre DestinationEndpoint.InstanceType est défini sur RDS, POLARDB, ECS, LocalInstance ou Express.
SourceEndpoint.Region	String	Non	cn-hangzhou	ID de la région de la base de données source. Remarque Si le paramètre SourceEndpoint.InstanceType est défini sur LocalInstance, saisissez cn-hangzhou ou l'ID de la région la plus proche de la base de données auto-gérée. Pour plus d'informations, consultez Liste des régions prises en charge.
SourceEndpoint.IP	String	Non	172.16.88.***	Point de terminaison de la base de données source. Remarque Spécifiez le point de terminaison uniquement si le paramètre SourceEndpoint.InstanceType est défini sur LocalInstance ou Express.
SourceEndpoint.Port	String	Non	3306	Numéro de port de service de la base de données source. Remarque Spécifiez le numéro de port de service uniquement si le paramètre SourceEndpoint.InstanceType est défini sur ECS, LocalInstance ou Express.
SourceEndpoint.OracleSID	String	Non	testsid	Identifiant système (SID) de la base de données Oracle. Remarque Spécifiez ce paramètre uniquement si le paramètre SourceEndpoint.EngineName est défini sur Oracle et que la base de données Oracle est déployée dans une architecture non-RAC.
SourceEndpoint.DatabaseName	String	Non	dtstestdatabase	Nom de la base de données source ou de la base de données d'authentification. Remarque Spécifiez le nom de la base de données uniquement si le paramètre SourceEndpoint.EngineName est défini sur PostgreSQL ou MongoDB. Si le paramètre SourceEndpoint.EngineName est défini sur PostgreSQL, spécifiez le nom de la base de données source. Si le paramètre SourceEndpoint.EngineName est défini sur MongoDB, spécifiez le nom de la base de données d'authentification.
SourceEndpoint.UserName	String	Non	dtstestaccount	Compte de la base de données source. Remarque Les autorisations requises pour les comptes de base de données varient selon le scénario de migration. Pour plus d'informations, consultez Présentation des scénarios de migration de données.
SourceEndpoint.Password	String	Non	Test123456	Mot de passe du compte de la base de données source.
SourceEndpoint.OwnerID	String	Non	140692647406****	ID du compte Alibaba Cloud auquel appartient l'instance source. Remarque Spécifiez ce paramètre uniquement lorsque vous configurez une migration de données entre différents comptes Alibaba Cloud.
SourceEndpoint.Role	String	Non	ram-for-dts	Rôle RAM autorisé de l'instance source. Spécifiez le rôle RAM uniquement si l'instance source et l'instance de destination appartiennent à différents comptes Alibaba Cloud. Utilisez le rôle RAM pour permettre au compte Alibaba Cloud propriétaire de l'instance de destination d'accéder à l'instance source. Remarque Pour plus d'informations sur les autorisations et les méthodes d'autorisation du rôle RAM, consultez Configurer l'autorisation RAM pour la migration et la synchronisation de données inter-comptes.
DestinationEndpoint.InstanceID	String	Non	rm-bp1r46452ai50****	ID de l'instance qui héberge la base de données de destination. Remarque Spécifiez l'ID de l'instance uniquement si le paramètre DestinationEndpoint.InstanceType est défini sur RDS, ECS, MongoDB, Redis, DRDS, PetaData, OceanBase, POLARDB, PolarDB_o, AnalyticDB ou Greenplum. Par exemple, si le paramètre DestinationEndpoint.InstanceType est défini sur ECS, spécifiez l'ID de l'instance ECS.
DestinationEndpoint.EngineName	String	Non	MySQL	Type de moteur de la base de données de destination. Valeurs possibles : MySQL, DRDS, SQLServer, PostgreSQL, PPAS, MongoDB, Redis, POLARDB et polardb_pg. Remarque Spécifiez le type de moteur uniquement si le paramètre DestinationEndpoint.InstanceType est défini sur RDS, POLARDB, ECS, LocalInstance ou Express.
DestinationEndpoint.Region	String	Non	cn-hangzhou	ID de la région de la base de données de destination. Remarque Si le paramètre DestinationEndpoint.InstanceType est défini sur LocalInstance, saisissez cn-hangzhou ou l'ID de la région la plus proche de la base de données auto-gérée. Pour plus d'informations, consultez Liste des régions prises en charge.
DestinationEndpoint.IP	String	Non	172.16.88.***	Point de terminaison de la base de données de destination. Remarque Spécifiez le point de terminaison uniquement si le paramètre DestinationEndpoint.InstanceType est défini sur LocalInstance ou Express.
DestinationEndpoint.Port	String	Non	3306	Numéro de port de service de la base de données de destination. Remarque Spécifiez le numéro de port de service uniquement si le paramètre DestinationEndpoint.InstanceType est défini sur ECS, LocalInstance ou Express.
DestinationEndpoint.DataBaseName	String	Non	dtstestdatabase	Nom de la base de données de destination ou de la base de données d'authentification. Remarque Spécifiez le nom de la base de données uniquement si le paramètre DestinationEndpoint.EngineName est défini sur PostgreSQL, DRDS ou MongoDB. Si le paramètre DestinationEndpoint.EngineName est défini sur PostgreSQL ou DRDS, spécifiez le nom de la base de données de destination. Si le paramètre DestinationEndpoint.EngineName est défini sur MongoDB, spécifiez le nom de la base de données d'authentification.
DestinationEndpoint.UserName	String	Non	dtstestaccount	Compte de la base de données de destination. Remarque Les autorisations requises pour les comptes de base de données varient selon le scénario de migration. Pour plus d'informations, consultez Présentation des scénarios de migration de données.
DestinationEndpoint.Password	String	Non	Test123456	Mot de passe du compte de la base de données de destination.
MigrationReserved	String	Non	{ "autoStartModulesAfterConfig": "none", "targetTableMode": 2 }	Paramètre réservé de DTS. La valeur est une chaîne JSON. Spécifiez ce paramètre pour répondre à des exigences particulières, par exemple pour indiquer s'il faut démarrer automatiquement une pré-vérification. Pour plus d'informations, consultez MigrationReserved.
Checkpoint	String	Non	111	Décalage de départ de la migration incrémentielle des données. La valeur est un horodatage UNIX. Unité : secondes.
AccountId	String	Non	12323344****	ID du compte Alibaba Cloud. Il n'est pas nécessaire de spécifier ce paramètre car il sera supprimé à l'avenir.
DestinationEndpoint.OracleSID	String	Non	testsid	SID de la base de données Oracle. Remarque Spécifiez ce paramètre uniquement si le paramètre DestinationEndpoint.EngineName est défini sur Oracle et que la base de données Oracle est déployée dans une architecture non-RAC.

Paramètres de réponse

Paramètre

Type

Exemple

Description

| ErrCode | String | InternalError |

Code d'erreur renvoyé en cas d'échec de l'appel.

| ErrMessage | String | The request processing has failed due to some unknown error. |

Message d'erreur renvoyé en cas d'échec de l'appel.

| RequestId | String | 40E35BD9-002E-4D63-9BE5-FBA48833**** |

ID de la requête.

| Success | String | true |

Indique si l'appel a réussi.

Exemples

Exemples de requêtes

http(s)://dts.aliyuncs.com/?Action=ConfigureMigrationJob
&DestinationEndpoint.InstanceType=RDS
&MigrationJobId=dtsl3m1213ye7l****
&MigrationJobName=MySQL_TO_RDS
&MigrationMode.DataIntialization=true
&MigrationMode.DataSynchronization=true
&MigrationMode.StructureIntialization=true
&MigrationObject=[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]
&SourceEndpoint.InstanceType=RDS
&<Common request parameters>

Exemples de réponses réussies

XML format

<ConfigureMigrationJobResponse>
      <RequestId>40E35BD9-002E-4D63-9BE5-FBA48833****</RequestId>
      <Success>true</Success>
</ConfigureMigrationJobResponse>

JSON format

{
    "RequestId": "40E35BD9-002E-4D63-9BE5-FBA48833****",
    "Success": true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs de l'API.