Tous les produits
Search

Ce produit

    Data Transmission Service:ConfigureSynchronizationJob

    Centre de documentation

    Data Transmission Service:ConfigureSynchronizationJob

    Dernière mise à jour :Aug 10, 2026

    Configure une tâche de synchronisation des données.

    Avant d'appeler cette opération, appelez l'opération CreateSynchronizationJob pour créer une instance de synchronisation des données.

    Remarque

    • Une fois la configuration terminée, la tâche démarre automatiquement et exécute une pré-vérification. Il n'est pas nécessaire d'appeler l'opération StartSynchronizationJob.

    • Si le démarrage de la tâche échoue en raison d'un échec de la pré-vérification, appelez l'opération DescribeSynchronizationJobStatus pour identifier l'erreur et résoudre le problème. Appelez ensuite l'opération StartSynchronizationJob pour redémarrer la tâche.

    Débogage

    OpenAPI Explorer calcule automatiquement la valeur de la signature. Appelez cette opération dans OpenAPI Explorer pour générer du code exemple pour différents SDK.

    Paramètres de requête

    Parameter Type Required Example Description
    Action String Yes ConfigureSynchronizationJob

    Opération à effectuer. Définissez ce paramètre sur ConfigureSynchronizationJob.

    DataInitialization Boolean Yes true

    Indique s'il faut effectuer la synchronisation initiale complète des données. Valeurs possibles :

    • true : oui
    • false : non
    Remarque Valeur par défaut : true.
    StructureInitialization Boolean Yes true

    Indique s'il faut effectuer la synchronisation initiale du schéma. Valeurs possibles :

    • true : oui
    • false : non
    Remarque Valeur par défaut : true.
    SynchronizationJobId String Yes dtsz4ao1dor13d****

    ID de l'instance de synchronisation des données. Appelez l'opération DescribeSynchronizationJobs pour interroger les ID des instances.

    SynchronizationObjects String Yes [{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]

    Objets à synchroniser. La valeur est une chaîne JSON qui prend en charge les expressions régulières. Consultez SynchronizationObjects.

    RegionId String No cn-hangzhou

    ID de la région de l'instance de synchronisation des données. Consultez la List of supported regions.

    SynchronizationJobName String No MySQL Synchronization

    Nom de la tâche de synchronisation des données.

    Remarque Utilisez un nom explicite pour faciliter l'identification. Un nom unique n'est pas requis.
    SynchronizationDirection String No Forward

    Direction de la synchronisation. Valeurs possibles :

    • Forward
    • Reverse
    Remarque
    • Valeur par défaut : Forward.
    • La valeur Reverse prend effet uniquement si la topologie de l'instance de synchronisation des données est une synchronisation bidirectionnelle.
    SourceEndpoint.InstanceId String No rm-bp1i99e8l7913****

    ID de l'instance source.

    SourceEndpoint.InstanceType String No RDS

    Type de l'instance source. Valeurs possibles :

    • RDS : instance ApsaraDB RDS
    • Redis : instance ApsaraDB for Redis
    • PolarDB : cluster PolarDB for MySQL ou cluster PolarDB O Edition
    • ECS : base de données auto-gérée hébergée sur Elastic Compute Service (ECS)
    • Express : base de données auto-gérée connectée via Express Connect
    • 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)
    Remarque La valeur par défaut est RDS.
    SourceEndpoint.IP String No 172.16.88.***

    Adresse IP de la base de données source.

    Remarque Spécifiez ce paramètre uniquement si le paramètre SourceEndpoint.InstanceType est défini sur ECS, Express, dg ou cen.
    SourceEndpoint.Port String No 3306

    Numéro de port de service de la base de données source.

    Remarque Spécifiez ce paramètre uniquement si le paramètre SourceEndpoint.InstanceType est défini sur ECS, Express, dg ou cen.
    SourceEndpoint.UserName String No dtstestaccount

    Compte de base de données de la base de données source.

    Remarque
    • Spécifiez ce paramètre uniquement si le paramètre SourceEndpoint.InstanceType est défini sur ECS, Express, dg ou cen.
    • Si le paramètre SourceEndpoint.InstanceType est défini sur Redis, vous n'avez pas besoin de spécifier le compte de base de données.
    • Les autorisations requises varient selon le scénario de synchronisation. Consultez la rubrique Overview of data synchronization scenarios.
    SourceEndpoint.Password String No Test123456

    Mot de passe du compte de la base de données source.

    Remarque Spécifiez ce paramètre uniquement si le paramètre SourceEndpoint.InstanceType est défini sur ECS, Express, dg ou cen.
    DestinationEndpoint.InstanceId String No rm-bp1r46452ai50****

    ID de l'instance de destination.

    Remarque Si le paramètre DestinationEndpoint.InstanceType est défini sur MaxCompute ou DataHub, vous devez spécifier le nom du projet MaxCompute ou du projet DataHub.

    Si l'instance de destination est un cluster AnalyticDB for MySQL, spécifiez l'ID du cluster AnalyticDB for MySQL.

    DestinationEndpoint.InstanceType String No RDS

    Type de l'instance de destination. Valeurs possibles :

    • Redis : instance ApsaraDB for Redis
    • RDS : instance ApsaraDB RDS
    • PolarDB : cluster PolarDB for MySQL ou cluster PolarDB O Edition
    • ECS : base de données auto-gérée hébergée sur ECS
    • Express : base de données auto-gérée connectée via Express Connect
    • DataHub : projet DataHub
    • MaxCompute : projet MaxCompute
    • AnalyticDB : cluster AnalyticDB for MySQL V3.0 ou V2.0
    • Greenplum : instance AnalyticDB for PostgreSQL
    Remarque La valeur par défaut est RDS.
    DestinationEndpoint.IP String No 172.16.88.***

    Adresse IP de la base de données de destination.

    Remarque Spécifiez ce paramètre uniquement si le paramètre DestinationEndpoint.InstanceType est défini sur Express, dg ou cen.
    DestinationEndpoint.Port String No 3306

    Numéro de port de service de la base de données de destination.

    Remarque Spécifiez ce paramètre uniquement si le paramètre DestinationEndpoint.InstanceType est défini sur ECS, Express, dg ou cen.
    DestinationEndpoint.UserName String No dtstestaccount

    Compte de base de données de la base de données de destination.

    Remarque
    • Les autorisations requises varient selon le scénario de synchronisation. Consultez la rubrique Overview of data synchronization scenarios.
    • Si le paramètre DestinationEndpoint.InstanceType est défini sur ECS, Express, dg ou cen, vous devez spécifier le paramètre DestinationEndpoint.UserName.
    • Si le paramètre DestinationEndpoint.InstanceType est défini sur RDS et que la version de la base de données est MySQL 5.5 ou MySQL 5.6, vous n'avez pas besoin de spécifier les paramètres DestinationEndpoint.UserName et DestinationEndpoint.Password.
    • Si le paramètre DestinationEndpoint.InstanceType est défini sur Redis, vous n'avez pas besoin de spécifier le paramètre DestinationEndpoint.UserName.
    DestinationEndpoint.Password String No Test654321

    Mot de passe du compte de la base de données de destination.

    Remarque
    • Si le paramètre DestinationEndpoint.InstanceType est défini sur ECS, Express, dg ou cen, vous devez spécifier le paramètre DestinationEndpoint.Password.
    SourceEndpoint.OwnerID String No 140692647406****

    ID du compte Alibaba Cloud du propriétaire de l'instance RDS source.

    Remarque Requis pour la synchronisation inter-comptes. Spécifiez également le paramètre SourceEndpoint.Role.
    SourceEndpoint.Role String No ram-for-dts

    Nom du rôle RAM configuré pour le compte Alibaba Cloud propriétaire de l'instance source.

    Remarque Requis pour la synchronisation inter-comptes. Consultez la rubrique Configure RAM authorization for cross-account data migration and synchronization.
    PartitionKey.ModifyTime_Year Boolean No true

    Indique si la table de données incrémentielles contient des partitions définies par le champ modifytime_year. Valeurs possibles : true et false.

    Remarque Ce paramètre est disponible uniquement si le paramètre DestinationEndpoint.InstanceType est défini sur MaxCompute.
    PartitionKey.ModifyTime_Month Boolean No true

    Indique si la table de données incrémentielles contient des partitions définies par le champ modifytime_month. Valeurs possibles : true et false.

    Remarque Ce paramètre est disponible uniquement si le paramètre DestinationEndpoint.InstanceType est défini sur MaxCompute.
    PartitionKey.ModifyTime_Day Boolean No true

    Indique si la table de données incrémentielles contient des partitions définies par le champ modifytime_day. Valeurs possibles : true et false.

    Remarque Ce paramètre est disponible uniquement si le paramètre DestinationEndpoint.InstanceType est défini sur MaxCompute.
    PartitionKey.ModifyTime_Hour Boolean No true

    Indique si la table de données incrémentielles contient des partitions définies par le champ modifytime_hour. Valeurs possibles : true et false.

    Remarque Ce paramètre est disponible uniquement si le paramètre DestinationEndpoint.InstanceType est défini sur MaxCompute.
    PartitionKey.ModifyTime_Minute Boolean No true

    Indique si la table de données incrémentielles contient des partitions définies par le champ modifytime_minute. Valeurs possibles : true et false.

    Remarque Ce paramètre est disponible uniquement si le paramètre DestinationEndpoint.InstanceType est défini sur MaxCompute.
    MigrationReserved String No { "autoStartModulesAfterConfig": "none", "targetTableMode": 2 }

    Paramètre réservé DTS. Une chaîne JSON pour les exigences spéciales, telles que le démarrage automatique d'une pré-vérification. Consultez la rubrique MigrationReserved.

    Remarque Également utilisé pour la synchronisation des données entre les instances ApsaraDB for Redis Enterprise Edition. Consultez la rubrique Use OpenAPI Explorer to configure one-way or two-way data synchronization between ApsaraDB for Redis Enterprise Edition instances.
    Checkpoint String No 1610540493

    Point de contrôle de synchronisation.

    AccountId String No 12323344****

    ID du compte Alibaba Cloud. Obsolète ; sera supprimé dans une future version.

    SourceEndpoint.DatabaseName String No dtstestdata

    Nom de la base de données à laquelle appartient l'objet de synchronisation dans l'instance source.

    DestinationEndpoint.DataBaseName String No dtstestdata

    Nom de la base de données à laquelle appartient l'objet de synchronisation dans l'instance de destination.

    Paramètres de réponse

    Parameter Type Example Description

    | ErrCode | String | InternalError |


    Code d'erreur renvoyé si la requête a échoué.

    |

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


    Message d'erreur renvoyé si la requête a échoué.

    |

    | RequestId | String | 2690E467-7773-43BC-A009-370EE2E7**** |


    ID de la requête.

    |

    | Success | String | true |


    Indique si la requête a abouti.

    |

    Exemples

    Exemple de requête

    http(s)://dts.aliyuncs.com/?Action=ConfigureSynchronizationJob
&DataInitialization=true
&StructureInitialization=true
&SynchronizationJobId=dtsz4ao1dor13d****
&SynchronizationObjects=[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]
&<Common request parameters>

    Exemple de réponses réussies

    XML format

    <ConfigureSynchronizationJobResponse>
      <RequestId>2690E467-7773-43BC-A009-370EE2E7****</RequestId>
      <Success>true</Success>
</ConfigureSynchronizationJobResponse>

    JSON format

    {
    "RequestId": "2690E467-7773-43BC-A009-370EE2E7****",
    "Success": true
}

    Codes d'erreur

    Pour obtenir la liste des codes d'erreur, consultez le API Error Center.