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

Utilice esta API para obtener una lista de las instancias de sincronización de datos y sus detalles.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeSynchronizationJobs	Acción de la API. Valor válido: `DescribeSynchronizationJobs`
RegionId	String	No	cn-hangzhou	ID de región de la instancia de sincronización de datos. Para obtener más información, consulte List of supported regions.
PageSize	Integer	No	30	Número de registros que se devuelven en cada página. Valores válidos: 10, 20 y 30. Valor predeterminado: 30. Valor máximo: 30.
PageNum	Integer	No	1	Número de página. El valor debe ser mayor que 0 y no exceder el valor máximo del tipo de dato Integer. Valor predeterminado: 1.
SynchronizationJobName	String	No	MySQL Synchronization	Nombre de la tarea de sincronización de datos. Nota Este parámetro es compatible con la coincidencia aproximada.
ClientToken	String	No	0c593ea1-3bea-11e9-b96b-88e9fe63****	Valor único que genera el cliente para cada solicitud a fin de garantizar la idempotencia. Solo admite caracteres ASCII y no puede exceder los 64 caracteres.
AccountId	String	No	12323344****	ID de su cuenta de Alibaba Cloud. No es necesario establecerlo, ya que pronto quedará obsoleto.
Tag.N.Key	String	Sí	testkey1	Clave de la etiqueta. Puede obtenerla si llama a la API ListTagResources. Nota N especifica el número de serie de la etiqueta. Por ejemplo, Tag.1.Key especifica la clave de la primera etiqueta y Tag.2.Key especifica la clave de la segunda etiqueta. Se pueden especificar 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	Valor de la etiqueta. Puede obtenerlo si llama a la API ListTagResources. Nota N especifica el número de serie de la etiqueta. Por ejemplo, Tag.1.Value especifica el valor de la primera etiqueta y Tag.2.Value especifica el valor de la segunda etiqueta. Se pueden especificar 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****	ID del resource group.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
PageNumber	Integer	1	Número de página de los resultados devueltos.
RequestId	String	92E1E99D-5224-4AD3-8C94-23A3516B****	ID único de la solicitud.
PageRecordCount	Integer	30	Número máximo de registros que se pueden mostrar en la página actual.
TotalRecordCount	Long	100	Número total de instancias de sincronización de datos que pertenecen a su cuenta de Alibaba Cloud.
SynchronizationInstances	Array of SynchronizationInstance		Lista de instancias de sincronización de datos y sus detalles.
DataInitialization	String	true	Indica si se realiza la sincronización completa de datos. Valores válidos: `true`: sí. `false`: no.
Status	String	synchronizing	Estado actual de la tarea de sincronización de datos. Valores válidos: `NotStarted`: La tarea no se ha iniciado. `Prechecking`: La tarea está en precomprobación. `PrecheckFailed`: La tarea finalizó con errores en la precomprobación. `Initializating` : La tarea está en sincronización inicial. `InitializeFailed`: La sincronización inicial finalizó con errores. `Synchronizing`: La tarea está sincronizando datos. `Failed`: La tarea finalizó con errores al sincronizar datos. `Suspending`: La tarea está en pausa. `Modifying`: Los objetos de la tarea se están modificando. `Finished`: La tarea se completó.
SynchronizationJobName	String	MySQL Synchronization	Nombre de la tarea de sincronización de datos.
Delay	String	0	Latencia de sincronización. Unidad: segundos.
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].	Mensaje de error que se devuelve si la sincronización de datos finalizó con errores.
ExpireTime	String	2021-07-07T16:00:00Z	Hora en que expira la instancia de sincronización de datos, en formato yyyy-MM-ddTHH:mm:ssZ, en UTC. Nota Este parámetro se devuelve solo si el valor devuelto del parámetro `PayType` es `PrePaid`.
CreateTime	String	2021-06-28 17:34:53.0	Hora en que se creó la tarea de sincronización de datos, en formato yyyy-MM-dd HH:mm:ss.0 (UTC+8).
PayType	String	PrePaid	Método de facturación de la instancia de sincronización de datos. Valores válidos: `PrePaid`: suscripción. `PostPaid`: pay-as-you-go.
StructureInitialization	String	true	Indica si se realiza la sincronización de esquema. Valores válidos: `true`: sí `false`: no
SynchronizationJobClass	String	large	Especificación de la instancia de sincronización de datos.
InstanceCreateTime	String	2021-06-28T09:36:32Z	Hora en que se creó la instancia, en formato yyyy-MM-ddTHH:mm:ssZ, en UTC.
SynchronizationJobId	String	dtsexjk1alb116****	ID de la instancia de sincronización de datos.
SynchronizationDirection	String	Forward	Dirección de sincronización. Valores válidos: Forward: hacia adelante. Reverse: hacia atrás.
JobCreateTime	String	2021-06-28T09:34:53Z	Hora en que se creó la tarea de sincronización de datos, en formato yyyy-MM-ddTHH:mm:ssZ, en UTC.
Tags	Array of Tag		Conjunto de etiquetas.
Key	String	testkey1	Clave de la etiqueta.
Value	String	testvalue1	Valor de la etiqueta correspondiente a la clave de la etiqueta.
SynchronizationObjects	Array of SynchronizationObject		Objetos que se sincronizan en la tarea.
NewSchemaName	String	newdtstestdatabase	Nombre de la base de datos que se usa en la instancia de destino.
SchemaName	String	dtstestdatabase	Nombre de la base de datos sincronizada.
TableExcludes	Array of TableExclude		Tablas de origen que se excluyen de la tarea de sincronización de datos.
TableName	String	order	Nombre de la tabla excluida.
TableIncludes	Array of TableInclude		Tablas que se sincronizan en la tarea.
TableName	String	customer	Nombre de la tabla sincronizada.
DataInitializationStatus	Object		Estado de la sincronización completa de datos.
Status	String	Finished	Estado de la sincronización completa de datos. Valores válidos: `NotStarted`: La sincronización completa de datos no se ha iniciado. `Migrating`: La sincronización completa de datos está en curso. `Failed`: La sincronización completa de datos finalizó con errores. `Finished`: La sincronización completa de datos se completó.
Percent	String	100	Progreso de la sincronización completa de datos. Unidad: %.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	Mensaje de error que se devuelve si la sincronización completa de datos finalizó con errores.
Progress	String	200001	Número de registros que se han sincronizado durante la sincronización completa de datos.
DataSynchronizationStatus	Object		Estado de la sincronización incremental de datos. Nota Este parámetro y sus subparámetros ya no están disponibles.
Status	String	Finished	Estado de la sincronización incremental de datos. Nota Este parámetro ya no está disponible.
Delay	String	0	Latencia de la sincronización incremental de datos. Nota Este parámetro ya no está disponible.
Percent	String	100	Progreso de la sincronización incremental de datos. Nota Este parámetro ya no está disponible.
ErrorMessage	String	The task has failed for a long time and cannot be recovered	Mensaje de error que se devuelve si la sincronización incremental de datos finalizó con errores. Nota Este parámetro ya no está disponible.
DestinationEndpoint	Object		Configuración de conexión de la instancia de destino.
InstanceId	String	rm-bp162d4tp0500****	ID de la instancia de destino.
IP	String	172.16.88.***	Endpoint de la instancia de destino.
InstanceType	String	RDS	Tipo de la instancia de destino.
Port	String	3306	Puerto de servicio de la base de datos de la instancia de destino.
UserName	String	dtstest	Cuenta de la base de datos de la instancia de destino.
EngineName	String	MySQL	Tipo de base de datos de la instancia de destino.
Performance	Object		Rendimiento de la instancia de sincronización de datos.
RPS	String	100	Número de sentencias SQL que se sincronizan por segundo, incluidas las sentencias `BEGIN`, `COMMIT`, `DML` y `DDL`. Las sentencias DML incluyen `INSERT`, `DELETE` y `UPDATE`.
FLOW	String	1	Tráfico de datos que se sincroniza por segundo. Unidad: MB/s.
PrecheckStatus	Object		Estado de la precomprobación.
Status	String	Success	Resultado de la precomprobación. Valores válidos: `Success`: La tarea superó la precomprobación. `Failed`: La tarea finalizó con errores en la precomprobación.
Percent	String	100	Progreso de la precomprobación. Unidad: %.
Detail	Array of CheckItem		Resultado de cada elemento de precomprobación.
CheckStatus	String	Success	Resultado de la precomprobación. Valores válidos: `Success`: La tarea superó la precomprobación. `Failed`: La tarea finalizó con errores en la precomprobación.
ErrorMessage	String	Original error: Access denied for user 'dtstest'@'100,104.*.' (using password: YES)	Mensaje de error que se devuelve si la tarea finalizó con errores en la precomprobación. Nota Este parámetro se devuelve solo si el valor devuelto del parámetro `CheckStatus` es `Failed`.
ItemName	String	CHECK_CONN_SRC	Nombre del elemento de precomprobación.
RepairMethod	String	CHECK_ERROR_DEST_CONN_REPAIR2	Método para corregir el error de la precomprobación. Nota Este parámetro se devuelve solo si el valor devuelto del parámetro `CheckStatus` es `Failed`.
SourceEndpoint	Object		Configuración de conexión de la instancia de origen.
InstanceId	String	rm-bp1i99e8l7913****	ID de la instancia de origen.
IP	String	172.16.88.***	Endpoint de la instancia de origen.
InstanceType	String	RDS	Tipo de la instancia de origen.
Port	String	3306	Puerto de servicio de la base de datos de la instancia de origen.
UserName	String	dtstest	Cuenta de la base de datos de la instancia de origen.
EngineName	String	MySQL	Tipo de base de datos de la instancia de origen.
StructureInitializationStatus	Object		Estado de la sincronización de esquema.
Status	String	Finished	Estado de la sincronización de esquema. Valores válidos: `NotStarted`: La sincronización de esquema no se ha iniciado. `Migrating` : La sincronización de esquema está en curso. `Failed` : La sincronización de esquema finalizó con errores. `Finished`: La sincronización de esquema se completó.
Percent	String	100	Progreso de la sincronización de esquema. Unidad: %.
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	Mensaje de error que se devuelve si la sincronización de esquema finalizó con errores.
Progress	String	1	Número de tablas cuyos esquemas se han sincronizado.

Ejemplos

Solicitudes de ejemplo

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

Respuestas correctas de ejemplo

XML formato

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 formato

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
}

Códigos de error

HttpCode	Código de error	Mensaje de error	Descripción
400	Throttling.User	Request was denied due to user flow control.	El número de solicitudes alcanzó el límite y se rechazó la solicitud. 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 expiró o el servidor no estaba disponible. Inténtelo de nuevo. Si el error persiste, comuníquese con el soporte técnico.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	La firma expiró. Utilice una firma nueva.

Para obtener una lista de códigos de error, visite el Centro de errores de API.