DescribeSynchronizationJobs - Data Transmission Service - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer, qui 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	DescribeSynchronizationJobs	Opération de l'API. Valeur valide : `DescribeSynchronizationJobs`.
RegionId	String	Non	cn-hangzhou	ID de région de l'instance de synchronisation de données. Pour plus d'informations, consultez Liste des régions prises en charge.
PageSize	Integer	Non	30	Nombre d'entrées à retourner par page. Valeurs valides : 10, 20 et 30. Valeur par défaut : 30. Valeur maximale : 30.
PageNum	Integer	Non	1	Numéro de page. La valeur doit être supérieure à 0 et ne pas dépasser la valeur maximale du type de données Integer. Valeur par défaut : 1.
SynchronizationJobName	String	Non	MySQL Synchronization	Nom de la tâche de synchronisation de données. Remarque La correspondance floue est prise en charge.
ClientToken	String	Non	0c593ea1-3bea-11e9-b96b-88e9fe63****	Valeur unique générée par le client pour chaque requête afin de garantir son idempotence. Elle accepte uniquement les caractères ASCII et ne peut pas dépasser 64 caractères.
AccountId	String	Non	12323344****	ID de votre compte Alibaba Cloud. Ce paramètre sera bientôt obsolète ; il n'est pas nécessaire de le définir.
Tag.N.Key	String	Oui	testkey1	Clé du tag. Vous pouvez l'obtenir en appelant l'API ListTagResources. Remarque N indique le numéro de série du tag. Par exemple, Tag.1.Key désigne la clé du premier tag et Tag.2.Key celle du deuxième. Vous pouvez spécifier de 1 à 20 clés de tag simultanément. Ce paramètre ne peut pas être une chaîne vide.
Tag.N.Value	String	Non	testvalue1	Valeur du tag. Vous pouvez l'obtenir en appelant l'API ListTagResources. Remarque N indique le numéro de série du tag. Par exemple, Tag.1.Value désigne la valeur du premier tag et Tag.2.Value celle du deuxième. Vous pouvez spécifier de 1 à 20 valeurs de tag simultanément. La valeur du tag peut être une chaîne vide.
ResourceGroupId	String	Non	rg-acfmzawhxxc****	ID du groupe de ressources.

Paramètres de réponse

Paramètre	Type	Exemple	Description
PageNumber	Integer	1	Numéro de page des résultats retournés.
RequestId	String	92E1E99D-5224-4AD3-8C94-23A3516B****	ID unique de la requête.
PageRecordCount	Integer	30	Nombre maximal d'entrées affichables sur la page actuelle.
TotalRecordCount	Long	100	Nombre total d'instances de synchronisation de données associées à votre compte Alibaba Cloud.
SynchronizationInstances	Array of SynchronizationInstance		Liste des instances de synchronisation de données et leurs détails.
DataInitialization	String	true	Indique si une synchronisation complète des données est effectuée. Valeurs valides : `true` : oui. `false` : non.
Status	String	synchronizing	État actuel de la tâche de synchronisation de données. Valeurs valides : `NotStarted` : Tâche non démarrée. `Prechecking` : Prévalidation en cours. `PrecheckFailed` : Échec de la prévalidation. `Initializating` : Synchronisation initiale en cours. `InitializeFailed` : Échec de la synchronisation initiale. `Synchronizing` : Synchronisation des données en cours. `Failed` : Échec de la synchronisation des données. `Suspending` : Tâche suspendue. `Modifying` : Modification des objets de la tâche en cours. `Finished` : Tâche terminée.
SynchronizationJobName	String	MySQL Synchronization	Nom de la tâche de synchronisation de données.
Delay	String	0	Latence de synchronisation. Unité : secondes.
ErrorMessage	String	DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\n\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].	Message d'erreur retourné en cas d'échec de la synchronisation des données.
ExpireTime	String	2021-07-07T16:00:00Z	Date d'expiration de l'instance de synchronisation de données au format yyyy-MM-ddTHH:mm:ssZ (UTC). Remarque Ce paramètre est retourné uniquement si la valeur du paramètre `PayType` est `PrePaid`.
CreateTime	String	2021-06-28 17:34:53.0	Date de création de la tâche de synchronisation de données au format yyyy-MM-dd HH:mm:ss.0 (UTC+8).
PayType	String	PrePaid	Mode de facturation de l'instance de synchronisation de données. Valeurs valides : `PrePaid` : abonnement. `PostPaid` : paiement à l'utilisation.
StructureInitialization	String	true	Indique si une synchronisation de schéma est effectuée. Valeurs valides : `true` : oui. `false` : non.
SynchronizationJobClass	String	large	Spécification de l'instance de synchronisation de données.
InstanceCreateTime	String	2021-06-28T09:36:32Z	Date de création de l'instance au format yyyy-MM-ddTHH:mm:ssZ (UTC).
SynchronizationJobId	String	dtsexjk1alb116****	ID de l'instance de synchronisation de données.
SynchronizationDirection	String	Forward	Direction de synchronisation. Valeurs valides : Forward : directe. Reverse : inverse.
JobCreateTime	String	2021-06-28T09:34:53Z	Date de création de la tâche de synchronisation de données au format yyyy-MM-ddTHH:mm:ssZ (UTC).
Tags	Array of Tag		Ensemble de tags.
Key	String	testkey1	Clé du tag.
Value	String	testvalue1	Valeur correspondant à la clé du tag.
SynchronizationObjects	Array of SynchronizationObject		Objets synchronisés par la tâche.
NewSchemaName	String	newdtstestdatabase	Nom de la base de données dans l'instance de destination.
SchemaName	String	dtstestdatabase	Nom de la base de données synchronisée.
TableExcludes	Array of TableExclude		Tables source exclues de la tâche de synchronisation de données.
TableName	String	order	Nom de la table exclue.
TableIncludes	Array of TableInclude		Tables synchronisées par la tâche.
TableName	String	customer	Nom de la table synchronisée.
DataInitializationStatus	Object		État de la synchronisation complète des données.
Status	String	Finished	État de la synchronisation complète des données. Valeurs valides : `NotStarted` : Synchronisation complète des données non démarrée. `Migrating` : Synchronisation complète des données en cours. `Failed` : Échec de la synchronisation complète des données. `Finished` : Synchronisation complète des données terminée.
Percent	String	100	Progression de la synchronisation complète des données. Unité : %.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	Message d'erreur retourné en cas d'échec de la synchronisation complète des données.
Progress	String	200001	Nombre d'entrées synchronisées lors de la synchronisation complète des données.
DataSynchronizationStatus	Object		État de la synchronisation incrémentielle des données. Remarque Ce paramètre et ses sous-paramètres ne sont plus disponibles.
Status	String	Finished	État de la synchronisation incrémentielle des données. Remarque Ce paramètre n'est plus disponible.
Delay	String	0	Latence de la synchronisation incrémentielle des données. Remarque Ce paramètre n'est plus disponible.
Percent	String	100	Progression de la synchronisation incrémentielle des données. Remarque Ce paramètre n'est plus disponible.
ErrorMessage	String	The task has failed for a long time and cannot be recovered	Message d'erreur retourné en cas d'échec de la synchronisation incrémentielle des données. Remarque Ce paramètre n'est plus disponible.
DestinationEndpoint	Object		Paramètres de connexion de l'instance de destination.
InstanceId	String	rm-bp162d4tp0500****	ID de l'instance de destination.
IP	String	172.16.88.***	Endpoint de l'instance de destination.
InstanceType	String	RDS	Type de l'instance de destination.
Port	String	3306	Port de service de base de données de l'instance de destination.
UserName	String	dtstest	Compte de base de données de l'instance de destination.
EngineName	String	MySQL	Type de base de données de l'instance de destination.
Performance	Object		Performances de l'instance de synchronisation de données.
RPS	String	100	Nombre d'instructions SQL synchronisées par seconde, y compris les instructions `BEGIN`, `COMMIT`, `DML` et `DDL`. Les instructions DML incluent `INSERT`, `DELETE` et `UPDATE`.
FLOW	String	1	Trafic de données synchronisé par seconde. Unité : Mo/s.
PrecheckStatus	Object		État de la prévalidation.
Status	String	Success	Résultat de la prévalidation. Valeurs valides : `Success` : Prévalidation réussie. `Failed` : Échec de la prévalidation.
Percent	String	100	Progression de la prévalidation. Unité : %.
Detail	Array of CheckItem		Résultat de chaque élément de prévalidation.
CheckStatus	String	Success	Résultat de la prévalidation. Valeurs valides : `Success` : Prévalidation réussie. `Failed` : Échec de la prévalidation.
ErrorMessage	String	Original error: Access denied for user 'dtstest'@'100.104.*.' (using password: YES)	Message d'erreur retourné en cas d'échec de la prévalidation. Remarque Ce paramètre est retourné uniquement si la valeur du paramètre `CheckStatus` est `Failed`.
ItemName	String	CHECK_CONN_SRC	Nom de l'élément de prévalidation.
RepairMethod	String	CHECK_ERROR_DEST_CONN_REPAIR2	Méthode de correction de l'échec de prévalidation. Remarque Ce paramètre est retourné uniquement si la valeur du paramètre `CheckStatus` est `Failed`.
SourceEndpoint	Object		Paramètres de connexion de l'instance source.
InstanceId	String	rm-bp1i99e8l7913****	ID de l'instance source.
IP	String	172.16.88.***	Endpoint de l'instance source.
InstanceType	String	RDS	Type de l'instance source.
Port	String	3306	Port de service de base de données de l'instance source.
UserName	String	dtstest	Compte de base de données de l'instance source.
EngineName	String	MySQL	Type de base de données de l'instance source.
StructureInitializationStatus	Object		État de la synchronisation de schéma.
Status	String	Finished	État de la synchronisation de schéma. Valeurs valides : `NotStarted` : Synchronisation de schéma non démarrée. `Migrating` : Synchronisation de schéma en cours. `Failed` : Échec de la synchronisation de schéma. `Finished` : Synchronisation de schéma terminée.
Percent	String	100	Progression de la synchronisation de schéma. Unité : %.
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	Message d'erreur retourné en cas d'échec de la synchronisation de schéma.
Progress	String	1	Nombre de tables dont les schémas ont été synchronisés.

Exemples

Exemples de requêtes

http(s)://dts.aliyuncs.com/?Action=DescribeSynchronizationJobs
&Tag.1.Key=testkey1
&<Common request parameters>

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSynchronizationJobsResponse>
    <TotalRecordCount>100</TotalRecordCount>
    <SynchronizationInstances>
        <Status>synchronizing</Status>
        <SynchronizationObjects>
            <SchemaName>dtstestdatabase</SchemaName>
            <NewSchemaName>newdtstestdatabase</NewSchemaName>
        </SynchronizationObjects>
        <DataInitializationStatus>
            <Status>Finished</Status>
            <Progress>200001</Progress>
            <Percent>100</Percent>
        </DataInitializationStatus>
        <SynchronizationJobName>MySQL Synchronization</SynchronizationJobName>
        <InstanceCreateTime>2021-06-28T09:36:32Z</InstanceCreateTime>
        <CreateTime>2021-06-28 17:34:53.0</CreateTime>
        <JobCreateTime>2021-06-28T09:34:53Z</JobCreateTime>
        <PayType>PostPaid</PayType>
        <Delay>0</Delay>
        <PrecheckStatus>
            <Status>Finished</Status>
            <Percent>100</Percent>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_CONN_SRC</ItemName>
            
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_AUTH_SRC</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_CONN_DEST</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_AUTH_DEST</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_BINLOG_ON</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_BINLOG_MODE</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_BINLOG_ROW_IMAGE</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_SERVER_ID</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_BINLOG_EXIST</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_ENGINE</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_MYSQL_PASSOWRD_FORMAT</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_SRC</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_SAME_OBJ</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_SQL_MODE</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_SAME_USER</ItemName>
            </Detail>
            <Detail>
                <CheckStatus>Success</CheckStatus>
                <ItemName>CHECK_TOPOLOGY</ItemName>
            </Detail>
        </PrecheckStatus>
        <SynchronizationJobId>dtsexjk1alb116lbf1</SynchronizationJobId>
        <DataInitialization>true</DataInitialization>
        <DestinationEndpoint>
            <InstanceId>rm-bp162d4tp0500****</InstanceId>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
        </DestinationEndpoint>
        <SourceEndpoint>
            <InstanceId>rm-bp1i99e8l7913****</InstanceId>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
        </SourceEndpoint>
        <StructureInitialization>true</StructureInitialization>
        <ExpireTime>2021-07-07T16:00:00Z</ExpireTime>
        <Performance>
            <RPS>0</RPS>
            <FLOW>0.00MB/s</FLOW>
        </Performance>
        <SynchronizationJobClass>large</SynchronizationJobClass>
        <DataSynchronizationStatus/>
        <StructureInitializationStatus>
            <Status>Finished</Status>
            <Progress>1</Progress>
            <Percent>100</Percent>
        </StructureInitializationStatus>
    </SynchronizationInstances>
    <PageRecordCount>30</PageRecordCount>
    <RequestId>92E1E99D-5224-4AD3-8C94-23A3516B****</RequestId>
    <PageNumber>1</PageNumber>
</DescribeSynchronizationJobsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecordCount" : 100,
  "SynchronizationInstances" : [ {
    "Status" : "synchronizing",
    "SynchronizationObjects" : [ {
      "TableIncludes" : [ ],
      "TableExcludes" : [ ],
      "SchemaName" : "dtstestdatabase",
      "NewSchemaName" : "newdtstestdatabase"
    } ],
    "DataInitializationStatus" : {
      "Status" : "Finished",
      "Progress" : "200001",
      "Percent" : "100"
    },
    "SynchronizationJobName" : "MySQL Synchronization",
    "InstanceCreateTime" : "2021-06-28T09:36:32Z",
    "CreateTime" : "2021-06-28 17:34:53.0",
    "JobCreateTime" : "2021-06-28T09:34:53Z",
    "PayType" : "PostPaid",
    "Delay" : "0",
    "PrecheckStatus" : {
      "Status" : "Finished",
      "Percent" : "100",
      "Detail" : [ {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_CONN_SRC"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_AUTH_SRC"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_CONN_DEST"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_AUTH_DEST"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_BINLOG_ON"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_BINLOG_MODE"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_BINLOG_ROW_IMAGE"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_SERVER_ID"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_BINLOG_EXIST"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_ENGINE"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_MYSQL_PASSOWRD_FORMAT"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_SRC"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_SAME_OBJ"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_SQL_MODE"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_SAME_USER"
      }, {
        "CheckStatus" : "Success",
        "ItemName" : "CHECK_TOPOLOGY"
      } ]
    },
    "SynchronizationJobId" : "dtsexjk1alb116lbf1",
    "DataInitialization" : true,
    "DestinationEndpoint" : {
      "InstanceId" : "rm-bp162d4tp0500****",
      "InstanceType" : "RDS",
      "EngineName" : "MySQL"
    },
    "SourceEndpoint" : {
      "InstanceId" : "rm-bp1i99e8l7913****",
      "InstanceType" : "RDS",
      "EngineName" : "MySQL"
    },
    "StructureInitialization" : true,
    "ExpireTime" : "2021-07-07T16:00:00Z",
    "Performance" : {
      "RPS" : "0",
      "FLOW" : "0.00MB/s"
    },
    "SynchronizationJobClass" : "large",
    "Tags" : [ ],
    "DataSynchronizationStatus" : { },
    "StructureInitializationStatus" : {
      "Status" : "Finished",
      "Progress" : "1",
      "Percent" : "100"
    }
  } ],
  "PageRecordCount" : 30,
  "RequestId" : "92E1E99D-5224-4AD3-8C94-23A3516B****",
  "PageNumber" : 1
}

Codes d'erreur

HttpCode

Code d'erreur

Message d'erreur

Description

400

Throttling.User

Request was denied due to user flow control.

Le nombre de requêtes a atteint la limite et la requête a été rejetée. Réessayez ultérieurement.

500

ServiceUnavailable

The request has failed due to a temporary failure of the server.

Délai d'attente dépassé ou serveur indisponible. Réessayez. Si l'erreur persiste, contactez le support technique.

403

InvalidSecurityToken.Expired

Specified SecurityToken is expired.

Signature expirée. Utilisez une nouvelle signature.

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