CreateSynchronizationJob - DTS API Reference - Data Transmission Service

Avant d'appeler cette opération, familiarisez-vous avec les méthodes de facturation et la tarification de DTS.

Une fois l'instance de synchronisation achetée, appelez ConfigureSynchronizationJob pour configurer la tâche de synchronisation. Celle-ci démarre automatiquement.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature et génère un exemple de code SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	CreateSynchronizationJob	Opération à effectuer. Définissez la valeur sur CreateSynchronizationJob.
DestRegion	String	Oui	cn-hangzhou	ID de la région de la base de données de destination. Pour obtenir la liste des ID de région valides, consultez la page Liste des régions prises en charge. Remarque Si SourceRegion est défini sur Chine (Hong Kong) ou sur une région hors de Chine continentale, attribuez la même valeur à DestRegion.
PayType	String	Oui	PostPaid	Méthode de facturation de l'instance de synchronisation. PrePaid : abonnement PostPaid (valeur par défaut) : paiement à l'utilisation
SourceRegion	String	Oui	cn-hangzhou	ID de la région de la base de données source. Pour obtenir la liste des ID de région valides, consultez la page Liste des régions prises en charge.
SynchronizationJobClass	String	Oui	small	Spécification de l'instance de synchronisation. Valeurs valides : micro, small, medium et large. Remarque Pour consulter les benchmarks de performance de chaque spécification, reportez-vous à la page Spécifications des instances de synchronisation de données.
RegionId	String	Non	cn-hangzhou	ID de la région de l'instance de synchronisation. Attribuez à ce paramètre la même valeur que DestRegion.
Topology	String	Non	oneway	Topologie de synchronisation. Valeurs valides : oneway : synchronisation unidirectionnelle bidirectional : synchronisation bidirectionnelle Remarque Valeur par défaut : oneway. La valeur bidirectional n'est prise en charge que si SourceEndpoint.InstanceType et DestinationEndpoint.InstanceType sont définis sur MySQL, PolarDB ou Redis.
Period	String	Non	Year	Cycle de facturation de l'instance d'abonnement. Valeurs valides : Year Month Remarque Requis uniquement si PayType est défini sur PrePaid.
UsedTime	Integer	Non	1	Durée de l'abonnement. Si le cycle de facturation est Year, la plage de valeurs va de 1 à 5. Si le cycle de facturation est Month, la plage de valeurs va de 1 à 60. Remarque Requis uniquement si PayType est défini sur PrePaid.
ClientToken	String	Non	0c593ea1-3bea-11e9-b96b-88e9fe63****	Jeton client garantissant l'idempotence de la requête. Utilisez une valeur unique pour chaque requête. La valeur ClientToken ne peut contenir que des caractères ASCII et ne doit pas dépasser 64 caractères.
SourceEndpoint.InstanceType	String	Non	MySQL	Type d'instance de la base de données source. Valeurs valides : MySQL : Instance ApsaraDB RDS for MySQL ou base de données MySQL autogérée PolarDB : Cluster PolarDB for MySQL ou cluster PolarDB O Edition Redis : Base de données Redis DRDS : Instance PolarDB-X V1.0 Remarque Valeur par défaut : MySQL. Pour connaître les bases de données source et de destination prises en charge, consultez la page Types de bases de données, types de synchronisation initiale et topologies de synchronisation.
DestinationEndpoint.InstanceType	String	Non	MySQL	Type d'instance de la base de données de destination. Valeurs valides : MySQL : Instance ApsaraDB RDS for MySQL ou base de données MySQL autogérée PolarDB : Cluster PolarDB for MySQL ou cluster PolarDB O Edition Redis : Base de données Redis MaxCompute : Projet MaxCompute Remarque Valeur par défaut : MySQL. Pour connaître les bases de données source et de destination prises en charge, consultez la page Types de bases de données, types de synchronisation initiale et topologies de synchronisation.
networkType	String	Non	Intranet	Type de réseau. Valeur valide : Intranet (VPC).
AccountId	String	Non	12323344****	ID du compte Alibaba Cloud. Ce paramètre est obsolète et sera supprimé prochainement.
DBInstanceCount	Integer	Non	3	Requis si SourceEndpoint.InstanceType est défini sur DRDS. Nombre d'instances RDS privées associées à l'instance PolarDB-X source. Valeur par défaut : 1.

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	9056C8B0-5799-493A-9655-70F607B8****	ID de la requête.
Success	String	true	Indique si la requête a abouti.
SynchronizationJobId	String	dtshvj11k25255****	ID de l'instance de synchronisation de données.

Exemples

Exemples de requêtes

http(s)://dts.aliyuncs.com/?Action=CreateSynchronizationJob
&SourceRegion=cn-hangzhou
&DestRegion=cn-hangzhou
&SynchronizationJobClass=small
&PayType=PostPaid 
&<Common request parameters>

Exemples de réponses réussies

Format XML

<CreateSynchronizationJobResponse>
      <SynchronizationJobId>dtshvj11k25255****</SynchronizationJobId>
      <RequestId>9056C8B0-5799-493A-9655-70F607B8****</RequestId>
      <Success>true</Success>
</CreateSynchronizationJobResponse>

Format JSON

{
    "SynchronizationJobId": "dtshvj11k25255****",
    "RequestId": "9056C8B0-5799-493A-9655-70F607B8****",
    "Success": true
}

Codes d'erreur

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