DescribeMigrationJobs - Data Transmission Service - Centro de documentación de Alibaba Cloud

Consulta la lista de instancias de migración de datos y los detalles de cada instancia.

Depuración

Ejecute esta API directamente en el OpenAPI Explorer, que calcula automáticamente el valor de la firma. Cuando la ejecución es exitosa, OpenAPI Explorer genera de forma automática los ejemplos de código del SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeMigrationJobs	La operación que desea ejecutar. Establezca el valor en `DescribeMigrationJobs`.
RegionId	String	No	cn-hangzhou	El identificador de la región de la instancia de migración de datos. Para obtener más información, consulte List of supported regions.
PageSize	Integer	No	30	El número de entradas por página. Valores válidos: 10, 20 y 30. Valor predeterminado: 30. Valor máximo: 30.
PageNum	Integer	No	1	El número de página que se va a devolver. El valor debe ser un entero positivo que no supere el valor máximo del tipo de dato Integer. Valor predeterminado: 1.
MigrationJobName	String	No	MySQL Migration	El nombre de la tarea de migración de datos. Nota Se admiten coincidencias parciales.
AccountId	String	No	12323344****	El identificador de la cuenta de Alibaba Cloud. No es necesario especificar este parámetro porque se eliminará en el futuro.
Tag.N.Key	String	Sí	testkey1	La clave de la etiqueta. Llame a la operación ListTagResources para consultar las claves de las etiquetas. Nota N indica el número de serie de la etiqueta. Por ejemplo, Tag.1.Key representa la clave de la primera etiqueta y Tag.2.Key la de la segunda. Especifique de 1 a 20 claves de etiqueta a la vez. Este parámetro no puede ser una cadena vacía.
Tag.N.Value	String	No	testvalue1	El valor de la etiqueta. Llame a la operación ListTagResources para consultar los valores de las etiquetas. Nota N indica el número de serie de la etiqueta. Por ejemplo, Tag.1.Value representa el valor de la primera etiqueta y Tag.2.Value el de la segunda. Especifique de 1 a 20 valores de etiqueta a la vez. El valor de la etiqueta puede ser una cadena vacía.
ResourceGroupId	String	No	rg-acfmzawhxxc****	El identificador del resource group.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	0ED4846D-ED60-435D-88C0-7EC0CE4D****	El identificador de la solicitud.
ErrCode	String	InternalError	El código de error devuelto si la solicitud terminó con errores.
PageRecordCount	Integer	30	El número de entradas en la página actual.
Success	String	true	Indica si la solicitud fue exitosa.
TotalRecordCount	Long	300	El número total de instancias de migración de datos asociadas a su cuenta de Alibaba Cloud.
ErrMessage	String	The request processing has failed due to some unknown error.	El mensaje de error devuelto si la solicitud terminó con errores.
PageNumber	Integer	1	El número de la página devuelta.
MigrationJobs	Array of MigrationJob		La lista de instancias de migración de datos y los detalles de cada instancia.
MigrationJob
MigrationJobName	String	MySQL Migration	El nombre de la tarea de migración de datos.
MigrationJobStatus	String	Migrating	El estado de la tarea de migración de datos. Valores válidos: `NotStarted`: la tarea no ha iniciado. `Prechecking`: la comprobación previa de la tarea está en curso. `PrecheckFailed`: la tarea no superó la comprobación previa. `Migrating`: la tarea está migrando datos. `Suspending`: la tarea está en pausa. `MigrationFailed`: la migración de datos de la tarea terminó con errores. `Finished`: la tarea finalizó.
PayType	String	PostPaid	El método de facturación de la instancia de migración de datos. El valor es `PostPaid` (pay-as-you-go).
MigrationJobClass	String	2xlarge	La especificación de la instancia de migración de datos. Valores válidos: small, medium, large, xlarge y 2xlarge. Consulte Specifications of data migration instances.
InstanceCreateTime	String	2021-06-22T09:02:13Z	La hora de creación de la instancia de migración de datos, con el formato yyyy-MM-ddTHH:mm:ssZ (UTC).
MigrationJobID	String	dtson2z28evm33****	El identificador de la instancia de migración de datos.
JobCreateTime	String	2021-06-22T08:53:55Z	La hora de creación de la tarea de sincronización, con el formato yyyy-MM-ddTHH:mm:ssZ (UTC).
MigrationObject	Array of SynchronousObject		Los objetos que migra la tarea.
SynchronousObject
DatabaseName	String	dtstestdata	El nombre de la base de datos que contiene los objetos por migrar desde la instancia de origen.
WholeDatabase	String	false	Indica si se migra una base de datos completa. Valores válidos: `true`: sí. `false`: no.
TableList	Array of String	customer	Los nombres de las tablas migradas.
Tags	Array of Tag		Las etiquetas.
Tag
Key	String	testkey1	La clave de la etiqueta.
Value	String	testvalue1	El valor de la etiqueta.
DataInitialization	Object		Los detalles de la migración completa de datos.
Percent	String	100	El progreso de la migración completa de datos. Unidad: %.
status	String	Finished	El estado de la migración completa de datos. Valores válidos: `NotStarted`: la migración completa de datos no ha iniciado. `Migrating`: la migración completa de datos está en curso. `Failed`: la migración completa de datos terminó con errores. `Finished`: la migración completa de datos finalizó.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	El mensaje de error devuelto si la migración completa de datos terminó con errores.
Progress	String	200001	El número de registros migrados durante la migración completa de datos.
DataSynchronization	Object		Los detalles de la migración incremental de datos.
Delay	String	0	La latencia de la migración incremental de datos. Unidad: segundos.
Percent	String	95	El progreso de la migración incremental de datos. Unidad: %.
status	String	Catched	El estado de la migración incremental de datos. Valores válidos: `NotStarted`: la migración incremental de datos no ha iniciado. `Migrating`: la migración incremental de datos está en curso. `Failed`: la migración incremental de datos terminó con errores. `Finished`: la migración incremental de datos finalizó. `Catched`: la migración incremental de datos no presenta retrasos.
ErrorMessage	String	The task has failed for a long time and cannot be recovered.	El mensaje de error devuelto si la migración incremental de datos terminó con errores.
DestinationEndpoint	Object		La configuración de conexión de la instancia de destino.
OracleSID	String	testsid	El SID de Oracle. Este parámetro se devuelve únicamente si el tipo de base de datos de la instancia de destino es Oracle.
DatabaseName	String	dtstestdata	El nombre de la base de datos a la que pertenece el objeto de migración en la instancia de destino.
InstanceID	String	rm-bp1zc3iyqe3qw****	El identificador de la instancia de destino.
Port	String	3306	El puerto del servicio de base de datos de la instancia de destino.
IP	String	172.16.88.***	El endpoint de la instancia de destino.
InstanceType	String	RDS	El tipo de la instancia de destino.
UserName	String	dtstest	La cuenta de base de datos de la instancia de destino.
EngineName	String	MySQL	El tipo de base de datos de la instancia de destino.
MigrationMode	Object		El tipo de migración.
DataInitialization	Boolean	true	Indica si se ejecuta la migración completa de datos. Valores válidos: `true`: sí. `false`: no.
DataSynchronization	Boolean	true	Indica si se ejecuta la migración incremental de datos. Valores válidos: `true`: sí. `false`: no.
StructureInitialization	Boolean	true	Indica si se ejecuta la migración de esquemas. Valores válidos: `true`: sí. `false`: no.
Precheck	Object		Los detalles de la comprobación previa.
Status	String	Success	El resultado de la comprobación previa. Valores válidos: `Success`: la tarea superó la comprobación previa. `Failed`: la tarea no superó la comprobación previa.
Percent	String	100	El progreso de la comprobación previa. Unidad: %.
SourceEndpoint	Object		La configuración de conexión de la instancia de origen.
OracleSID	String	testsid	El SID de Oracle. Este parámetro se devuelve únicamente si el tipo de base de datos de la instancia de origen es Oracle.
DatabaseName	String	dtstestdata	El nombre de la base de datos a la que pertenece el objeto de migración en la instancia de origen.
InstanceID	String	rm-bp1i99e8l7913****	El identificador de la instancia de origen.
Port	String	3306	El puerto del servicio de base de datos de la instancia de origen.
IP	String	172.16.88.***	El endpoint de la instancia de origen.
InstanceType	String	RDS	El tipo de la instancia de origen.
UserName	String	dtstest	La cuenta de base de datos de la instancia de origen.
EngineName	String	MySQL	El tipo de base de datos de la instancia de origen.
StructureInitialization	Object		Los detalles de la migración de esquemas.
Percent	String	100	El progreso de la migración de esquemas. Unidad: %.
status	String	Finished	El estado de la migración de esquemas. Valores válidos: `NotStarted`: la migración de esquemas no ha iniciado. `Migrating`: la migración de esquemas está en curso. `Failed`: la migración de esquemas terminó con errores. `Finished`: la migración de esquemas finalizó.
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	El mensaje de error devuelto si la migración de esquemas terminó con errores.
Progress	String	1	El número de tablas cuyos esquemas ya se migraron.

Ejemplos

Ejemplos de solicitudes

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

Ejemplos de respuestas exitosas

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
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
500	InternalError	The request processing has failed due to some unknown error.	El mensaje de error devuelto porque ocurrió un error interno. Inténtelo de nuevo más tarde.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	La respuesta del servidor excedió el tiempo de espera o el servidor no estaba available. Inténtelo de nuevo. Si el error persiste, póngase en contacto con el soporte técnico.
400	Throttling.User	Request was denied due to user flow control.	El número de solicitudes alcanzó el límite y se rechazó la petición. Inténtelo de nuevo más tarde.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	La firma caducó. Utilice una firma nueva.

Para consultar la lista de códigos de error, visite el Centro de errores.