DescribeMigrationJobs - Data Transmission Service - Centre de documentation Alibaba Cloud

Débogage

Exécutez cette API directement dans l'OpenAPI Explorer, qui calcule automatiquement la valeur de signature. Après une exécution réussie, OpenAPI Explorer génère automatiquement des exemples de code SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeMigrationJobs	Opération à effectuer. Définissez la valeur sur `DescribeMigrationJobs`.
RegionId	String	No	cn-hangzhou	ID de région de l'instance de migration de données. Pour plus d'informations, consultez la rubrique List of supported regions.
PageSize	Integer	No	30	Nombre d'entrées par page. Valeurs valides : 10, 20 et 30. Valeur par défaut : 30. Valeur maximale : 30.
PageNum	Integer	No	1	Numéro de la page à renvoyer. La valeur doit être un entier positif inférieur ou égal à la valeur maximale du type de données Integer. Valeur par défaut : 1.
MigrationJobName	String	No	MySQL Migration	Nom de la tâche de migration de données. Remarque La correspondance floue est prise en charge.
AccountId	String	No	12323344****	ID du compte Alibaba Cloud. Ce paramètre sera supprimé à l'avenir ; il n'est pas nécessaire de le spécifier.
Tag.N.Key	String	Yes	testkey1	Clé du tag. Appelez l'opération ListTagResources pour interroger les clés de tag. Remarque N spécifie le numéro de série du tag. Par exemple, Tag.1.Key spécifie la clé du premier tag et Tag.2.Key spécifie la clé du deuxième tag. Vous pouvez spécifier de 1 à 20 clés de tag à la fois. Ce paramètre ne peut pas être une chaîne vide.
Tag.N.Value	String	No	testvalue1	Valeur du tag. Appelez l'opération ListTagResources pour interroger les valeurs de tag. Remarque N spécifie le numéro de série du tag. Par exemple, Tag.1.Value spécifie la valeur du premier tag et Tag.2.Value spécifie la valeur du deuxième tag. Vous pouvez spécifier de 1 à 20 valeurs de tag à la fois. La valeur du tag peut être une chaîne vide.
ResourceGroupId	String	No	rg-acfmzawhxxc****	ID du groupe de ressources.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	0ED4846D-ED60-435D-88C0-7EC0CE4D****	ID de la requête.
ErrCode	String	InternalError	Code d'erreur renvoyé en cas d'échec de la requête.
PageRecordCount	Integer	30	Nombre d'entrées sur la page actuelle.
Success	String	true	Indique si la requête a abouti.
TotalRecordCount	Long	300	Nombre total d'instances de migration de données appartenant à votre compte Alibaba Cloud.
ErrMessage	String	The request processing has failed due to some unknown error.	Message d'erreur renvoyé en cas d'échec de la requête.
PageNumber	Integer	1	Numéro de la page renvoyée.
MigrationJobs	Array of MigrationJob		Liste des instances de migration de données et détails de chaque instance.
MigrationJob
MigrationJobName	String	MySQL Migration	Nom de la tâche de migration de données.
MigrationJobStatus	String	Migrating	État de la tâche de migration de données. Valeurs valides : `NotStarted` : la tâche n'a pas démarré. `Prechecking` : la tâche est en cours de précontrôle. `PrecheckFailed` : la tâche n'a pas passé le précontrôle. `Migrating` : la tâche migre les données. `Suspending` : la tâche est suspendue. `MigrationFailed` : la tâche a échoué lors de la migration des données. `Finished` : la tâche est terminée.
PayType	String	PostPaid	Mode de facturation de l'instance de migration de données. La valeur est `PostPaid` (paiement à l'utilisation).
MigrationJobClass	String	2xlarge	Spécification de l'instance de migration de données. Valeurs valides : small, medium, large, xlarge et 2xlarge. Consultez la rubrique Specifications of data migration instances.
InstanceCreateTime	String	2021-06-22T09:02:13Z	Heure de création de l'instance de migration de données au format yyyy-MM-ddTHH:mm:ssZ (UTC).
MigrationJobID	String	dtson2z28evm33****	ID de l'instance de migration de données.
JobCreateTime	String	2021-06-22T08:53:55Z	Heure de création de la tâche de synchronisation au format yyyy-MM-ddTHH:mm:ssZ (UTC).
MigrationObject	Array of SynchronousObject		Objets migrés par la tâche.
SynchronousObject
DatabaseName	String	dtstestdata	Nom de la base de données contenant les objets à migrer depuis l'instance source.
WholeDatabase	String	false	Indique si une base de données entière est migrée. Valeurs valides : `true` : oui. `false` : non.
TableList	Array of String	customer	Noms des tables migrées.
Tags	Array of Tag		Tags.
Tag
Key	String	testkey1	Clé du tag.
Value	String	testvalue1	Valeur du tag.
DataInitialization	Object		Détails de la migration complète des données.
Percent	String	100	Progression de la migration complète des données. Unité : %.
status	String	Finished	État de la migration complète des données. Valeurs valides : `NotStarted` : la migration complète des données n'a pas démarré. `Migrating` : la migration complète des données est en cours. `Failed` : la migration complète des données a échoué. `Finished` : la migration complète des données est terminée.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	Message d'erreur renvoyé en cas d'échec de la migration complète des données.
Progress	String	200001	Nombre d'enregistrements migrés lors de la migration complète des données.
DataSynchronization	Object		Détails de la migration incrémentielle des données.
Delay	String	0	Latence de la migration incrémentielle des données. Unité : secondes.
Percent	String	95	Progression de la migration incrémentielle des données. Unité : %.
status	String	Catched	État de la migration incrémentielle des données. Valeurs valides : `NotStarted` : la migration incrémentielle des données n'a pas démarré. `Migrating` : la migration incrémentielle des données est en cours. `Failed` : la migration incrémentielle des données a échoué. `Finished` : la migration incrémentielle des données est terminée. `Catched` : la migration incrémentielle des données n'est pas retardée.
ErrorMessage	String	The task has failed for a long time and cannot be recovered.	Message d'erreur renvoyé en cas d'échec de la migration incrémentielle des données.
DestinationEndpoint	Object		Paramètres de connexion de l'instance de destination.
OracleSID	String	testsid	SID Oracle. Ce paramètre est renvoyé uniquement si le type de base de données de l'instance de destination est Oracle.
DatabaseName	String	dtstestdata	Nom de la base de données à laquelle appartient l'objet de migration dans l'instance de destination.
InstanceID	String	rm-bp1zc3iyqe3qw****	ID de l'instance de destination.
Port	String	3306	Port de service de base de données 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.
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.
MigrationMode	Object		Type de migration.
DataInitialization	Boolean	true	Indique si la migration complète des données est effectuée. Valeurs valides : `true` : oui. `false` : non.
DataSynchronization	Boolean	true	Indique si la migration incrémentielle des données est effectuée. Valeurs valides : `true` : oui. `false` : non.
StructureInitialization	Boolean	true	Indique si la migration du schéma est effectuée. Valeurs valides : `true` : oui. `false` : non.
Precheck	Object		Détails du précontrôle.
Status	String	Success	Résultat du précontrôle. Valeurs valides : `Success` : la tâche a passé le précontrôle. `Failed` : la tâche n'a pas passé le précontrôle.
Percent	String	100	Progression du précontrôle. Unité : %.
SourceEndpoint	Object		Paramètres de connexion de l'instance source.
OracleSID	String	testsid	SID Oracle. Ce paramètre est renvoyé uniquement si le type de base de données de l'instance source est Oracle.
DatabaseName	String	dtstestdata	Nom de la base de données à laquelle appartient l'objet de migration dans l'instance source.
InstanceID	String	rm-bp1i99e8l7913****	ID de l'instance source.
Port	String	3306	Port de service de base de données de l'instance source.
IP	String	172.16.88.***	Endpoint de l'instance source.
InstanceType	String	RDS	Type 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.
StructureInitialization	Object		Détails de la migration du schéma.
Percent	String	100	Progression de la migration du schéma. Unité : %.
status	String	Finished	État de la migration du schéma. Valeurs valides : `NotStarted` : la migration du schéma n'a pas démarré. `Migrating` : la migration du schéma est en cours. `Failed` : la migration du schéma a échoué. `Finished` : la migration du schéma est terminée.
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	Message d'erreur renvoyé en cas d'échec de la migration du schéma.
Progress	String	1	Nombre de tables dont les schémas ont été migrés.

Exemples

Exemple de requêtes

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

Exemple de réponses réussies

XML format

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

<DescribeMigrationJobsResponse>
    <TotalRecordCount>300</TotalRecordCount>
    <PageRecordCount>30</PageRecordCount>
    <RequestId>0ED4846D-ED60-435D-88C0-7EC0CE4D****</RequestId>
    <PageNumber>1</PageNumber>
    <MigrationJobs>
        <MigrationJob>
            <DataSynchronization>
                <Percent>95</Percent>
                <Delay>0</Delay>
                <status>Catched</status>
            </DataSynchronization>
            <Precheck/>
            <InstanceCreateTime>2021-06-22T09:02:13Z</InstanceCreateTime>
            <JobCreateTime>2021-06-22T08:53:55Z</JobCreateTime>
            <MigrationJobName>MySQL Migration</MigrationJobName>
            <PayType>PostPaid</PayType>
            <MigrationJobStatus>Migrating</MigrationJobStatus>
            <MigrationMode>
                <DataInitialization>true</DataInitialization>
                <DataSynchronization>true</DataSynchronization>
                <StructureInitialization>true</StructureInitialization>
            </MigrationMode>
            <MigrationJobID>dtson2z28evm33****</MigrationJobID>
            <MigrationObject>
                <SynchronousObject>
                    <DatabaseName>dtstest</DatabaseName>
                    <WholeDatabase>false</WholeDatabase>
                    <TableList>
                        <Table>customer</Table>
                    </TableList>
                </SynchronousObject>
            </MigrationObject>
            <DataInitialization>
                <Progress>200001</Progress>
                <Percent>100</Percent>
                <status>Finished</status>
            </DataInitialization>
            <DestinationEndpoint>
                <UserName>dtstest</UserName>
                <InstanceID>rm-bp1zc3iyqe3qw****</InstanceID>
                <InstanceType>RDS</InstanceType>
                <EngineName>MySQL</EngineName>
            </DestinationEndpoint>
            <MigrationJobClass>2xlarge</MigrationJobClass>
            <SourceEndpoint>
                <UserName>dtstest</UserName>
                <InstanceID>rm-bp1i99e8l7913****</InstanceID>
                <InstanceType>RDS</InstanceType>
                <EngineName>MySQL</EngineName>
            </SourceEndpoint>
            <StructureInitialization>
                <Progress>1</Progress>
                <Percent>100</Percent>
                <status>Finished</status>
            </StructureInitialization>
            <Tags></Tags>
        </MigrationJob>
    </MigrationJobs>
    <Success>true</Success>
</DescribeMigrationJobsResponse>

JSON format

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

{
  "TotalRecordCount" : 300,
  "PageRecordCount" : 30,
  "RequestId" : "0ED4846D-ED60-435D-88C0-7EC0CE4D****",
  "PageNumber" : 1,
  "MigrationJobs" : {
    "MigrationJob" : [ {
      "DataSynchronization" : {
        "Percent" : "95",
        "Delay" : "0",
        "status" : "Catched"
      },
      "Precheck" : { },
      "InstanceCreateTime" : "2021-06-22T09:02:13Z",
      "JobCreateTime" : "2021-06-22T08:53:55Z",
      "MigrationJobName" : "MySQL Migration",
      "PayType" : "PostPaid",
      "MigrationJobStatus" : "Migrating",
      "MigrationMode" : {
        "DataInitialization" : true,
        "DataSynchronization" : true,
        "StructureInitialization" : true
      },
      "MigrationJobID" : "dtson2z28evm33****",
      "MigrationObject" : {
        "SynchronousObject" : [ {
          "DatabaseName" : "dtstest",
          "WholeDatabase" : false,
          "TableList" : {
            "Table" : [ "customer" ]
          }
        } ]
      },
      "DataInitialization" : {
        "Progress" : "200001",
        "Percent" : "100",
        "status" : "Finished"
      },
      "DestinationEndpoint" : {
        "UserName" : "dtstest",
        "InstanceID" : "rm-bp1zc3iyqe3qw****",
        "InstanceType" : "RDS",
        "EngineName" : "MySQL"
      },
      "MigrationJobClass" : "2xlarge",
      "SourceEndpoint" : {
        "UserName" : "dtstest",
        "InstanceID" : "rm-bp1i99e8l7913****",
        "InstanceType" : "RDS",
        "EngineName" : "MySQL"
      },
      "StructureInitialization" : {
        "Progress" : "1",
        "Percent" : "100",
        "status" : "Finished"
      },
      "Tags" : {
        "Tag" : [ ]
      }
    } ]
  },
  "Success" : true
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.	Le message d'erreur indique qu'une erreur interne s'est produite. Réessayez ultérieurement.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	Le délai d'attente de la réponse du serveur a expiré ou le serveur était indisponible. Réessayez. Si l'erreur persiste, contactez le support technique.
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.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	La signature a expiré. Utilisez une nouvelle signature.

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