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

Depuração

Execute esta API diretamente no OpenAPI Explorer, que calcula automaticamente o valor da assinatura. Após a execução bem-sucedida, o OpenAPI Explorer gera amostras de código SDK automaticamente.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeMigrationJobs	A operação a ser executada. Defina o valor como `DescribeMigrationJobs`.
RegionId	String	Não	cn-hangzhou	O ID da região da instância de migração de dados. Para mais informações, consulte Lista de regiões suportadas.
PageSize	Integer	Não	30	O número de entradas por página. Valores válidos: 10, 20 e 30. Valor padrão: 30. Valor máximo: 30.
PageNum	Integer	Não	1	O número da página a retornar. O valor deve ser um inteiro positivo que não exceda o valor máximo do tipo de dados Integer. Valor padrão: 1.
MigrationJobName	String	Não	MySQL Migration	O nome da tarefa de migração de dados. Nota Há suporte para correspondência aproximada.
AccountId	String	Não	12323344****	O ID da conta Alibaba Cloud. Não é necessário especificar este parâmetro, pois ele será removido futuramente.
Tag.N.Key	String	Sim	testkey1	A chave da tag. Chame a operação ListTagResources para consultar as chaves das tags. 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	O valor da tag. Chame a operação ListTagResources para consultar os valores das tags. 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****	O ID do grupo de recursos.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	0ED4846D-ED60-435D-88C0-7EC0CE4D****	O ID da solicitação.
ErrCode	String	InternalError	O código de erro retornado se a solicitação falhar.
PageRecordCount	Integer	30	O número de entradas na página atual.
Success	String	true	Indica se a solicitação foi bem-sucedida.
TotalRecordCount	Long	300	O número total de instâncias de migração de dados pertencentes à sua conta Alibaba Cloud.
ErrMessage	String	The request processing has failed due to some unknown error.	A mensagem de erro retornada se a solicitação falhar.
PageNumber	Integer	1	O número da página retornada.
MigrationJobs	Array of MigrationJob		A lista de instâncias de migração de dados e os detalhes de cada instância.
MigrationJob
MigrationJobName	String	MySQL Migration	O nome da tarefa de migração de dados.
MigrationJobStatus	String	Migrating	O status da tarefa de migraçã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`: A tarefa não passou na verificação prévia. `Migrating`: A tarefa está migrando dados. `Suspending`: A tarefa está pausada. `MigrationFailed`: Falha na migração de dados da tarefa. `Finished`: A tarefa foi concluída.
PayType	String	PostPaid	O método de faturamento da instância de migração de dados. O valor é `PostPaid` (pagamento conforme o uso).
MigrationJobClass	String	2xlarge	A especificação da instância de migração de dados. Valores válidos: small, medium, large, xlarge e 2xlarge. Consulte Especificações de instâncias de migração de dados.
InstanceCreateTime	String	2021-06-22T09:02:13Z	O horário de criação da instância de migração de dados no formato aaaa-MM-ddTHH:mm:ssZ (UTC).
MigrationJobID	String	dtson2z28evm33****	O ID da instância de migração de dados.
JobCreateTime	String	2021-06-22T08:53:55Z	O horário de criação da tarefa de sincronização no formato aaaa-MM-ddTHH:mm:ssZ (UTC).
MigrationObject	Array of SynchronousObject		Os objetos migrados pela tarefa.
SynchronousObject
DatabaseName	String	dtstestdata	O nome do banco de dados que contém os objetos a serem migrados da instância de source.
WholeDatabase	String	false	Indica se um banco de dados inteiro foi migrado. Valores válidos: `true`: sim. `false`: não.
TableList	Array of String	customer	Os nomes das tabelas migradas.
Tags	Array of Tag		As tags.
Tag
Key	String	testkey1	A chave da tag.
Value	String	testvalue1	O valor da tag.
DataInitialization	Object		Os detalhes da migração completa de dados.
Percent	String	100	O progresso da migração completa de dados. Unidade: %.
status	String	Finished	O status da migração completa de dados. Valores válidos: `NotStarted`: A migração completa de dados não foi iniciada. `Migrating`: A migração completa de dados está em andamento. `Failed`: Falha na migração completa de dados. `Finished`: A migração completa de dados foi concluída.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	A mensagem de erro retornada se a migração completa de dados falhar.
Progress	String	200001	O número de registros migrados durante a migração completa de dados.
DataSynchronization	Object		Os detalhes da migração incremental de dados.
Delay	String	0	A latência da migração incremental de dados. Unidade: segundos.
Percent	String	95	O progresso da migração incremental de dados. Unidade: %.
status	String	Catched	O status da migração incremental de dados. Valores válidos: `NotStarted`: A migração incremental de dados não foi iniciada. `Migrating`: A migração incremental de dados está em andamento. `Failed`: Falha na migração incremental de dados. `Finished`: A migração incremental de dados foi concluída. `Catched`: A migração incremental de dados não apresenta atrasos.
ErrorMessage	String	The task has failed for a long time and cannot be recovered.	A mensagem de erro retornada se a migração incremental de dados falhar.
DestinationEndpoint	Object		As configurações de conexão da instância de destino.
OracleSID	String	testsid	O SID do Oracle. Este parâmetro é retornado apenas se o tipo de banco de dados da instância de destino for Oracle.
DatabaseName	String	dtstestdata	O nome do banco de dados ao qual o objeto de migração na instância de destino pertence.
InstanceID	String	rm-bp1zc3iyqe3qw****	O ID da instância de destino.
Port	String	3306	A porta de serviço do banco de dados da instância de destino.
IP	String	172.16.88.***	O endpoint da instância de destino.
InstanceType	String	RDS	O tipo da instância de destino.
UserName	String	dtstest	A conta do banco de dados da instância de destino.
EngineName	String	MySQL	O tipo de banco de dados da instância de destino.
MigrationMode	Object		O tipo de migração.
DataInitialization	Boolean	true	Indica se a migração completa de dados foi executada. Valores válidos: `true`: sim. `false`: não.
DataSynchronization	Boolean	true	Indica se a migração incremental de dados foi executada. Valores válidos: `true`: sim. `false`: não.
StructureInitialization	Boolean	true	Indica se a migração de esquema foi executada. Valores válidos: `true`: sim. `false`: não.
Precheck	Object		Os detalhes da verificação prévia.
Status	String	Success	O resultado da verificação prévia. Valores válidos: `Success`: A tarefa passou na verificação prévia. `Failed`: A tarefa não passou na verificação prévia.
Percent	String	100	O progresso da verificação prévia. Unidade: %.
SourceEndpoint	Object		As configurações de conexão da instância de source.
OracleSID	String	testsid	O SID do Oracle. Este parâmetro é retornado apenas se o tipo de banco de dados da instância de source for Oracle.
DatabaseName	String	dtstestdata	O nome do banco de dados ao qual o objeto de migração na instância de source pertence.
InstanceID	String	rm-bp1i99e8l7913****	O ID da instância de source.
Port	String	3306	A porta de serviço do banco de dados da instância de source.
IP	String	172.16.88.***	O endpoint da instância de source.
InstanceType	String	RDS	O tipo da instância de source.
UserName	String	dtstest	A conta do banco de dados da instância de source.
EngineName	String	MySQL	O tipo de banco de dados da instância de source.
StructureInitialization	Object		Os detalhes da migração de esquema.
Percent	String	100	O progresso da migração de esquema. Unidade: %.
status	String	Finished	O status da migração de esquema. Valores válidos: `NotStarted`: A migração de esquema não foi iniciada. `Migrating`: A migração de esquema está em andamento. `Failed`: Falha na migração de esquema. `Finished`: A migração de esquema foi concluída.
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	A mensagem de erro retornada se a migração de esquema falhar.
Progress	String	1	O número de tabelas cujos esquemas foram migrados.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

XML formato

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 formato

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 erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError	The request processing has failed due to some unknown error.	Mensagem de erro retornada devido à ocorrência de um erro interno. 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.
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.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	A assinatura expirou. Utilize uma nova assinatura.

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