Consultar o status de uma tarefa de sincronização de dados - Data Transmission Service: Central de Documentação do Alibaba Cloud

Testar

Chame esta operação no OpenAPI Explorer. Após uma chamada bem-sucedida, o OpenAPI Explorer gera automaticamente o código de exemplo do SDK.

Parâmetros da solicitação

Nome	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeSynchronizationJobStatus	Defina o valor como DescribeSynchronizationJobStatus.
RegionId	String	Não	cn-hangzhou	ID da região onde reside a instância de sincronização de dados. Para mais informações, consulte Regiões suportadas.
SynchronizationJobId	String	Sim	dtsexjk1alb116****	ID da tarefa de sincronização de dados. Chame a operação DescribeSynchronizationJobs para consultar o ID da tarefa.
SynchronizationDirection	String	Não	Forward	Direção da sincronização. Valores válidos: Forward: Sincroniza dados do banco de dados de origem para o banco de dados de destino. Reverse: Sincroniza dados do banco de dados de destino para o banco de dados de origem. Nota O valor padrão é Forward. O valor Reverse só tem efeito se a topologia da tarefa de sincronização de dados for bidirecional.
ClientToken	String	Não	0c593ea1-3bea-11e9-b96b-88e9fe63****	Token de cliente que garante a idempotência da solicitação. O valor deve ser único entre diferentes solicitações e conter apenas caracteres ASCII. Comprimento máximo: 64 caracteres.
AccountId	String	Não	12323344****	ID da conta Alibaba Cloud. Não é necessário definir este parâmetro porque ele será descontinuado.
ResourceGroupId	String	Não	rg-acfmzawhxxc****	ID do grupo de recursos.

Parâmetros de resposta

Nome	Tipo	Exemplo	Descrição
SynchronizationJobName	String	MySQL synchronization	Nome da tarefa de sincronização de dados.
Status	String	synchronizing	Status da tarefa de sincronização de dados. Valores válidos: notStarted: A tarefa não foi iniciada. prechecking: A tarefa está em pré-verificação. precheckFailed: A tarefa falhou na pré-verificação. initializating: A tarefa está na sincronização inicial. initializeFailed: A tarefa falhou na sincronização inicial. synchronizing: A tarefa está em sincronização. failed: A tarefa falhou. suspending: A tarefa está pausada. modifying: Os objetos de sincronização estão sendo modificados. finished: A tarefa foi concluída.
DataInitialization	String	true	Indica se houve sincronização inicial completa de dados. true: Sim. false: Não.
Delay	String	0	Latência de sincronização, em 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].	Mensagem de erro retornada se a sincronização de dados falhar.
ExpireTime	String	2021-03-07T16:00:00Z	Horário de expiração da tarefa de sincronização de dados. O horário segue o formato aaaa-MM-ddTHH:mm:ssZ e é exibido em UTC. Nota Este parâmetro é retornado apenas se o valor do parâmetro PayType for PrePaid.
ErrCode	String	InternalError	Código de erro retornado se a chamada falhar.
Success	String	true	Indica se a solicitação foi bem-sucedida.
StructureInitialization	String	true	Indica se houve sincronização inicial de esquema. true: Sim. false: Não.
PayType	String	PrePaid	Método de faturamento da tarefa de sincronização de dados. Valores válidos: PrePaid: assinatura. PostPaid: pagamento conforme o uso.
ErrMessage	String	The request processing has failed due to some unknown error.	Mensagem de erro retornada se a chamada falhar.
SynchronizationJobClass	String	large	Especificação da tarefa de sincronização de dados.
RequestId	String	DACDF659-AFC6-4DC8-ADB8-4569419A4****	ID da solicitação.
SynchronizationJobId	String	dtsexjk1alb116****	ID da tarefa de sincronização de dados.
DelayMillis	Long	506	Latência de sincronização, em milissegundos.
SynchronizationDirection	String	Forward	Direção da sincronização. Valores válidos: Forward: Sincroniza dados do banco de dados de origem para o banco de dados de destino. Reverse: Sincroniza dados do banco de dados de destino para o banco de dados de origem.
TaskId	String	exjk1alb116****	ID da tarefa de sincronização de dados.
Checkpoint	String	1610616144	Timestamp UNIX do registro de dados sincronizado mais recente. Nota Use um mecanismo de busca para encontrar um conversor de timestamp UNIX.
DataInitializationStatus	Object		Status da sincronização inicial completa de dados.
Status	String	Finished	Status da sincronização inicial completa de dados. Valores válidos: NotStarted: A sincronização não foi iniciada. Migrating: A sincronização está em andamento. Failed: A sincronização falhou. Finished: A sincronização foi concluída.
Percent	String	100	Progresso da sincronização inicial completa de dados, em porcentagem.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	Mensagem de erro retornada se a sincronização inicial completa de dados falhar.
Progress	String	200001	Número de registros sincronizados durante a sincronização inicial completa de dados.
DataSynchronizationStatus	Object		Status da sincronização incremental de dados.
Status	String	Finished	Status da sincronização incremental de dados. Valores válidos: NotStarted: A sincronização não foi iniciada. Migrating: A sincronização está em andamento. Failed: A sincronização falhou. Finished: A sincronização foi concluída.
Delay	String	0	Latência da sincronização incremental de dados, em segundos.
Percent	String	100	Progresso da sincronização incremental de dados, em porcentagem.
ErrorMessage	String	The task has failed for too long and cannot be recovered.	Mensagem de erro retornada se a sincronização incremental de dados falhar.
DelayMillis	Long	856	Latência da sincronização incremental de dados, em milissegundos.
Checkpoint	String	1610709865	Timestamp UNIX do registro de dados sincronizado mais recente.
DestinationEndpoint	Object		Configurações de conexão da instância de destino.
InstanceId	String	rm-bp162d4tp0500****	ID da instância de destino.
IP	String	172.16.88.***	Endpoint da instância de destino.
InstanceType	String	RDS	Tipo da instância de destino.
Port	String	3306	Porta de serviço do banco de dados de destino.
UserName	String	dtstest	Conta de banco de dados da instância de destino.
EngineName	String	MySQL	Tipo de banco de dados da instância de destino.
Performance	Object		Visão geral do link de sincronização.
RPS	String	100	Número de instruções SQL sincronizadas por segundo, incluindo instruções BEGIN, COMMIT, DML e DDL.
FLOW	String	1	Tráfego de dados sincronizado por segundo, em MB/s.
PrecheckStatus	Object		Status da pré-verificação.
Status	String	Success	Resultado da pré-verificação. Valores válidos: Success: A tarefa passou na pré-verificação. Failed: A tarefa falhou na pré-verificação.
Percent	String	100	Progresso geral da pré-verificação, em porcentagem.
Detail	Array of CheckItem		Detalhes de cada item de pré-verificação.
CheckStatus	String	Success	Resultado da verificação. Valores válidos: Success: O item passou na verificação. Failed: O item falhou na verificação.
ErrorMessage	String	Original error: Access denied for user 'dtstest'@'100.104.*.' (using password: YES)	Mensagem de erro retornada se a pré-verificação falhar. Nota Este parâmetro é retornado apenas se o valor do parâmetro CheckStatus for Failed.
ItemName	String	CHECK_CONN_SRC	Item de pré-verificação.
RepairMethod	String	CHECK_ERROR_DEST_CONN_REPAIR2	Método para corrigir uma falha na pré-verificação. Nota Este parâmetro é retornado apenas se o valor do parâmetro CheckStatus for Failed.
SourceEndpoint	Object		Configurações de conexão da instância de origem.
InstanceId	String	rm-bp1i99e8l7913****	ID da instância de origem.
IP	String	172.16.88.***	Endpoint da instância de origem.
InstanceType	String	RDS	Tipo da instância de origem.
Port	String	3306	Porta de serviço do banco de dados de origem.
UserName	String	dtstest	Conta de banco de dados da instância de origem.
EngineName	String	MySQL	Tipo de banco de dados da instância de origem.
StructureInitializationStatus	Object		Status da sincronização inicial de esquema.
Status	String	Finished	Status da sincronização inicial de esquema. Valores válidos: NotStarted: A sincronização não foi iniciada. Migrating: A sincronização está em andamento. Failed: A sincronização falhou. Finished: A sincronização foi concluída.
Percent	String	100	Progresso da sincronização inicial de esquema, em porcentagem.
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	Mensagem de erro retornada se ocorrer uma exceção durante a sincronização inicial de esquema.
Progress	String	1	Número de tabelas cujos esquemas foram sincronizados durante a sincronização inicial de esquema.
SynchronizationObjects	Array of SynchronizationObject		Objetos de sincronização.
NewSchemaName	String	newdtstestdatabase	Nome do banco de dados para o qual o banco de dados de origem é mapeado no destino.
SchemaName	String	dtstestdatabase	Nome do banco de dados de origem a ser sincronizado.
TableExcludes	Array of TableExclude		Tabelas excluídas da sincronização no banco de dados.
TableName	String	order	Nome da tabela excluída.
TableIncludes	Array of TableInclude		Tabelas a serem sincronizadas.
TableName	String	customer	Nome da tabela a ser sincronizada.

Exemplos

Exemplo de solicitação

http(s)://dts.aliyuncs.com/?Action=DescribeSynchronizationJobStatus
&SynchronizationJobId=dtsexjk1alb116****
&<Common request parameters>

Exemplo de resposta de sucesso

Formato XML

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

<DescribeSynchronizationJobStatusResponse>
    <TaskId>exjk1alb116****</TaskId>
    <SynchronizationObjects>
        <SchemaName>newdtstestdatabase</SchemaName>
        <NewSchemaName>dtstestdatabase</NewSchemaName>
    </SynchronizationObjects>
    <DataInitializationStatus>
        <Status>Finished</Status>
        <Progress>200001</Progress>
        <Percent>100</Percent>
    </DataInitializationStatus>
    <Delay>0</Delay>
    <Success>true</Success>
    <DelayMillis>0</DelayMillis>
    <DataInitialization>true</DataInitialization>
    <SynchronizationJobClass>large</SynchronizationJobClass>
    <Status>synchronizing</Status>
    <RequestId>DACDF659-AFC6-4DC8-ADB8-4569419A****</RequestId>
    <SynchronizationJobName>MySQL synchronization</SynchronizationJobName>
    <PayType>PostPaid</PayType>
    <ErrMessage/>
    <PrecheckStatus>
        <Status>Finished</Status>
        <Percent>100</Percent>
        <Detail>
            <CheckStatus>Success</CheckStatus>
            <ItemName>CHECK_CONN_SRC</ItemName>
        </Detail>
        <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>
    <Checkpoint>1610616144</Checkpoint>
    <SynchronizationJobId>dtsexjk1alb116****</SynchronizationJobId>
    <DestinationEndpoint>
        <InstanceId>rm-bp1u40w1ip917****</InstanceId>
        <InstanceType>RDS</InstanceType>
        <EngineName>MySQL</EngineName>
    </DestinationEndpoint>
    <SourceEndpoint>
        <InstanceId>rm-bp1i99e8l7913****</InstanceId>
        <InstanceType>RDS</InstanceType>
        <EngineName>MySQL</EngineName>
    </SourceEndpoint>
    <StructureInitialization>true</StructureInitialization>
    <Performance>
        <RPS>0</RPS>
        <FLOW>0.00MB/s</FLOW>
    </Performance>
    <StructureInitializationStatus>
        <Status>Finished</Status>
        <Progress>1</Progress>
        <Percent>100</Percent>
    </StructureInitializationStatus>
</DescribeSynchronizationJobStatusResponse>

Formato JSON

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

{
  "TaskId" : "exjk1alb116****",
  "SynchronizationObjects" : [ {
    "TableIncludes" : [ ],
    "TableExcludes" : [ ],
    "SchemaName" : "newdtstestdatabase",
    "NewSchemaName" : "dtstestdatabase"
  } ],
  "DataInitializationStatus" : {
    "Status" : "Finished",
    "Progress" : "200001",
    "Percent" : "100"
  },
  "Delay" : "0",
  "Success" : true,
  "DelayMillis" : 0,
  "DataInitialization" : true,
  "SynchronizationJobClass" : "large",
  "Status" : "synchronizing",
  "RequestId" : "DACDF659-AFC6-4DC8-ADB8-4569419A****",
  "SynchronizationJobName" : "MySQL synchronization",
  "PayType" : "PostPaid",
  "ErrMessage" : "",
  "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"
    } ]
  },
  "Checkpoint" : "1610616144",
  "SynchronizationJobId" : "dtsexjk1alb116****",
  "DestinationEndpoint" : {
    "InstanceId" : "rm-bp1u40w1ip917****",
    "InstanceType" : "RDS",
    "EngineName" : "MySQL"
  },
  "SourceEndpoint" : {
    "InstanceId" : "rm-bp1i99e8l7913****",
    "InstanceType" : "RDS",
    "EngineName" : "MySQL"
  },
  "StructureInitialization" : true,
  "Performance" : {
    "RPS" : "0",
    "FLOW" : "0.00MB/s"
  },
  "StructureInitializationStatus" : {
    "Status" : "Finished",
    "Progress" : "1",
    "Percent" : "100"
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Throttling.User	Request was denied due to user flow control.	A solicitação foi rejeitada porque a frequência de solicitações atingiu o limiar. Tente novamente mais tarde.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	O token de segurança especificado expirou. Atualize a assinatura.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	A solicitação falhou porque o servidor atingiu o tempo limite ou estava indisponível. Tente novamente. Se a falha persistir, entre em contato com o suporte técnico.

Para obter uma lista de códigos de erro, consulte o Error Center.