DescribeSynchronizationJobs - Data Transmission Service: Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeSynchronizationJobs	Ação da API. Valor válido: `DescribeSynchronizationJobs`.
RegionId	String	Não	cn-hangzhou	ID da região da instância de sincronização de dados. Para mais informações, consulte Lista de regiões suportadas.
PageSize	Integer	Não	30	Número de entradas retornadas em cada página. Valores válidos: 10, 20 e 30. Valor padrão: 30. Valor máximo: 30.
PageNum	Integer	Não	1	Número da página. O valor deve ser maior que 0 e não pode exceder o valor máximo do tipo de dados Integer. Valor padrão: 1.
SynchronizationJobName	String	Não	MySQL Synchronization	Nome da tarefa de sincronização de dados. Nota Há suporte para correspondência difusa (fuzzy matching).
ClientToken	String	Não	0c593ea1-3bea-11e9-b96b-88e9fe63****	Valor exclusivo gerado pelo cliente para cada solicitação, garantindo sua idempotência. Aceita apenas caracteres ASCII e não pode exceder 64 caracteres.
AccountId	String	Não	12323344****	ID da sua conta Alibaba Cloud. Não é necessário definir este parâmetro, pois ele será descontinuado em breve.
Tag.N.Key	String	Sim	testkey1	Chave da tag. Obtenha-a chamando a API ListTagResources. Nota N indica o número de série da tag. Por exemplo, Tag.1.Key especifica a chave da primeira tag e Tag.2.Key especifica a chave da segunda tag. É possível especificar de 1 a 20 chaves de tag por vez. Este parâmetro não pode ser uma string vazia.
Tag.N.Value	String	Não	testvalue1	Valor da tag. Obtenha-o chamando a API ListTagResources. Nota N indica o número de série da tag. Por exemplo, Tag.1.Value especifica o valor da primeira tag e Tag.2.Value especifica o valor da segunda tag. É possível especificar de 1 a 20 valores de tag por vez. O valor da tag pode ser uma string vazia.
ResourceGroupId	String	Não	rg-acfmzawhxxc****	ID do grupo de recursos.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageNumber	Integer	1	Número da página dos resultados retornados.
RequestId	String	92E1E99D-5224-4AD3-8C94-23A3516B****	ID exclusivo da solicitação.
PageRecordCount	Integer	30	Número máximo de entradas exibidas na página atual.
TotalRecordCount	Long	100	Número total de instâncias de sincronização de dados pertencentes à sua conta Alibaba Cloud.
SynchronizationInstances	Array of SynchronizationInstance		Lista de instâncias de sincronização de dados e seus respectivos detalhes.
DataInitialization	String	true	Indica se a sincronização completa de dados foi executada. Valores válidos: `true`: sim. `false`: não.
Status	String	synchronizing	Status atual da tarefa de sincronização de dados. Valores válidos: `NotStarted`: A tarefa não foi iniciada. `Prechecking`: A verificação prévia da tarefa está em andamento. `PrecheckFailed`: Falha na verificação prévia da tarefa. `Initializating`: A sincronização inicial está em execução. `InitializeFailed`: Falha na sincronização inicial. `Synchronizing`: A tarefa está sincronizando dados. `Failed`: Falha na sincronização de dados da tarefa. `Suspending`: A tarefa está pausada. `Modifying`: Os objetos da tarefa estão sendo modificados. `Finished`: A tarefa foi concluída.
SynchronizationJobName	String	MySQL Synchronization	Nome da tarefa de sincronização de dados.
Delay	String	0	Latência da sincronização. Unidade: 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 em caso de falha na sincronização de dados.
ExpireTime	String	2021-07-07T16:00:00Z	Horário de expiração da instância de sincronização de dados, no formato aaaa-MM-ddTHH:mm:ssZ (UTC). Nota Este parâmetro é retornado apenas se o valor do parâmetro `PayType` for `PrePaid`.
CreateTime	String	2021-06-28 17:34:53.0	Horário de criação da tarefa de sincronização de dados, no formato aaaa-MM-dd HH:mm:ss.0 (UTC+8).
PayType	String	PrePaid	Método de faturamento da instância de sincronização de dados. Valores válidos: `PrePaid`: assinatura. `PostPaid`: pagamento conforme o uso.
StructureInitialization	String	true	Indica se a sincronização de esquema foi executada. Valores válidos: `true`: sim `false`: não
SynchronizationJobClass	String	large	Especificação da instância de sincronização de dados.
InstanceCreateTime	String	2021-06-28T09:36:32Z	Horário de criação da instância, no formato aaaa-MM-ddTHH:mm:ssZ (UTC).
SynchronizationJobId	String	dtsexjk1alb116****	ID da instância de sincronização de dados.
SynchronizationDirection	String	Forward	Direção da sincronização. Valores válidos: Forward: direta. Reverse: reversa.
JobCreateTime	String	2021-06-28T09:34:53Z	Horário de criação da tarefa de sincronização de dados, no formato aaaa-MM-ddTHH:mm:ssZ (UTC).
Tags	Array of Tag		Conjunto de tags.
Key	String	testkey1	Chave da tag.
Value	String	testvalue1	Valor correspondente à chave da tag.
SynchronizationObjects	Array of SynchronizationObject		Objetos sincronizados pela tarefa.
NewSchemaName	String	newdtstestdatabase	Nome do banco de dados utilizado na instância de destino.
SchemaName	String	dtstestdatabase	Nome do banco de dados sincronizado.
TableExcludes	Array of TableExclude		Tabelas de origem excluídas da tarefa de sincronização de dados.
TableName	String	order	Nome da tabela excluída.
TableIncludes	Array of TableInclude		Tabelas sincronizadas pela tarefa.
TableName	String	customer	Nome da tabela sincronizada.
DataInitializationStatus	Object		Estado da sincronização completa de dados.
Status	String	Finished	Estado da sincronização completa de dados. Valores válidos: `NotStarted`: A sincronização completa de dados não foi iniciada. `Migrating`: A sincronização completa de dados está em andamento. `Failed`: Falha na sincronização completa de dados. `Finished`: A sincronização completa de dados foi concluída.
Percent	String	100	Progresso da sincronização completa de dados. Unidade: %.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	Mensagem de erro retornada em caso de falha na sincronização completa de dados.
Progress	String	200001	Quantidade de entradas sincronizadas durante a sincronização completa de dados.
DataSynchronizationStatus	Object		Estado da sincronização incremental de dados. Nota Este parâmetro e seus subparâmetros não estão mais disponíveis.
Status	String	Finished	Estado da sincronização incremental de dados. Nota Este parâmetro não está mais disponível.
Delay	String	0	Latência da sincronização incremental de dados. Nota Este parâmetro não está mais disponível.
Percent	String	100	Progresso da sincronização incremental de dados. Nota Este parâmetro não está mais disponível.
ErrorMessage	String	The task has failed for a long time and cannot be recovered	Mensagem de erro retornada em caso de falha na sincronização incremental de dados. Nota Este parâmetro não está mais disponível.
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 do serviço de banco de dados da instância 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		Desempenho da instância de sincronização de dados.
RPS	String	100	Número de instruções SQL sincronizadas por segundo, incluindo instruções `BEGIN`, `COMMIT`, `DML` e `DDL`. As instruções DML incluem `INSERT`, `DELETE` e `UPDATE`.
FLOW	String	1	Tráfego de dados sincronizado por segundo. Unidade: MB/s.
PrecheckStatus	Object		Status da verificação prévia.
Status	String	Success	Resultado da verificação prévia. Valores válidos: `Success`: A tarefa passou na verificação prévia. `Failed`: Falha na verificação prévia da tarefa.
Percent	String	100	Progresso da verificação prévia. Unidade: %.
Detail	Array of CheckItem		Resultado de cada item da verificação prévia.
CheckStatus	String	Success	Resultado da verificação prévia. Valores válidos: `Success`: A tarefa passou na verificação prévia. `Failed`: Falha na verificação prévia da tarefa.
ErrorMessage	String	Original error: Access denied for user 'dtstest'@'100.104.*.' (using password: YES)	Mensagem de erro retornada se a tarefa falhar na verificação prévia. Nota Este parâmetro é retornado apenas se o valor do parâmetro `CheckStatus` for `Failed`.
ItemName	String	CHECK_CONN_SRC	Nome do item da verificação prévia.
RepairMethod	String	CHECK_ERROR_DEST_CONN_REPAIR2	Método para corrigir a falha na verificação prévia. 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 do serviço de banco de dados da instância 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		Estado da sincronização de esquema.
Status	String	Finished	Estado da sincronização de esquema. Valores válidos: `NotStarted`: A sincronização de esquema não foi iniciada. `Migrating`: A sincronização de esquema está em andamento. `Failed`: Falha na sincronização de esquema. `Finished`: A sincronização de esquema foi concluída.
Percent	String	100	Progresso da sincronização de esquema. Unidade: %.
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	Mensagem de erro retornada em caso de falha na sincronização de esquema.
Progress	String	1	Número de tabelas cujos esquemas foram sincronizados.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

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 erro

HttpCode	Código de erro	Mensagem de erro	Descrição
400	Throttling.User	Request was denied due to user flow control.	O número de solicitações atingiu o limite e a solicitação foi rejeitada. Tente novamente mais tarde.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	A resposta do servidor expirou ou o servidor estava indisponível. Tente novamente. Se o erro persistir, entre em contato com o suporte técnico.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	A assinatura expirou. Use uma nova assinatura.

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