ListMigrations - DataWorks: Central de Documentação do Alibaba Cloud

Obtém uma lista de tarefas de migração de importação e exportação.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:*

none

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Sim	O ID do workspace do DataWorks. Você pode fazer logon no console do DataWorks e acessar a página de Configuração do Workspace para obter o ID do workspace.	12345
MigrationType	string	Sim	O tipo de operação da tarefa de migração. Valores válidos: IMPORT e EXPORT.	IMPORT
Owner	string	Não	O ID do proprietário.	193379****
PageNumber	integer	Não	O número da página dos dados solicitados. Valor padrão: 1. Valor máximo: 100.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valor padrão: 10. Valor máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura de dados da resposta.
RequestId	string	O ID da solicitação, que identifica exclusivamente a solicitação.	F9198AA3-9010-53D5-9714-DC4****
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Data	object	Os dados da resposta.
Migrations	array<object>	A lista de tarefas de migração.
	object	A tarefa de migração.
Id	integer	O ID da chave primária.	436064
Name	string	O nome da tarefa.	test_task_1638498642279
PackageType	string	O tipo do pacote de importação e exportação. Valores válidos: DWMA: Formato padrão. DATAWORKS_MODEL: Formato padrão. DATAWORKS_V2: Apsara Stack (V3.6.1 a V3.11). DATAWORKS_V3: Apsara Stack (V3.12 e posterior). DWMA e DATAWORKS_MODEL são intercambiáveis.	DATAWORKS_MODEL
MigrationType	string	O tipo de operação da tarefa de migração. Valores válidos: IMPORT EXPORT	EXPORT
CreateTime	integer	A hora de criação.	123124123123123
UpdateTime	integer	A hora de atualização.	123123123123123
CreateUser	string	O criador.	123123****
CreateUserName	string	O nome do criador.	3h1_test
UpdateUser	string	O atualizador.	1231****
UpdateUserName	string	O nome do atualizador.	3h1_test
ProjectId	integer	O ID do workspace do DataWorks ao qual a tarefa pertence.	72132
TenantId	integer	O ID do locatário.	16307
Status	string	O status de execução da tarefa de migração de importação e exportação. Valores válidos: INIT: A tarefa está no estado inicial. EDITING: A tarefa está sendo editada. RUNNING: A tarefa está em execução. FAILURE: A tarefa falhou. SUCCESS: A tarefa foi bem-sucedida.	SUCCESS
Message	string	A mensagem de erro.	An internal system error occurred. datasource kafka region is not cn-chengdu, can't open network for it
DownloadUrl	string	A URL de download do pacote da tarefa de exportação. Você pode usar esta URL para baixar o pacote.	http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=*****&Signature=qxxxxx
Description	string	A descrição da tarefa de exportação.	Automated Test creation
PageNumber	integer	O número da página atual.	1
PageSize	integer	O número de entradas retornadas por página. Valor padrão: 10. Valor máximo: 50.	10
TotalCount	integer	O número total de registros.	20

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "F9198AA3-9010-53D5-9714-DC4****",
  "Success": true,
  "Data": {
    "Migrations": [
      {
        "Id": 436064,
        "Name": "test_task_1638498642279",
        "PackageType": "DATAWORKS_MODEL",
        "MigrationType": "EXPORT",
        "CreateTime": 123124123123123,
        "UpdateTime": 123123123123123,
        "CreateUser": "123123****",
        "CreateUserName": "3h1_test",
        "UpdateUser": "1231****",
        "UpdateUserName": "3h1_test",
        "ProjectId": 72132,
        "TenantId": 16307,
        "Status": "SUCCESS",
        "Message": "An internal system error occurred. datasource kafka region is not cn-chengdu, can't open network for it",
        "DownloadUrl": "[http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=\\*\\*\\*\\*\\*&Signature=qxxxxx](http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=*****&Signature=qxxxxx)",
        "Description": "Automated Test creation"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 20
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.