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

Obtém uma lista de tarefas de sincronização.

Descrição da operação

Você pode chamar esta operação para obter apenas as informações básicas sobre as tarefas. Se desejar obter os detalhes de uma tarefa, chame a operação GetDIJob.

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:*

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Sim	O ID do workspace.	1967
JobName	string	Não	O nome da tarefa. Há suporte para correspondência aproximada. Se você não configurar este parâmetro, nenhum limite será imposto às tarefas.	mysql_to_holo_sync_8772
SourceDataSourceType	string	Não	O tipo de origem. Se você não configurar este parâmetro, nenhum limite será imposto às tarefas.	MySQL
DestinationDataSourceType	string	Não	O tipo de destino. Se você não configurar este parâmetro, nenhum limite será imposto às tarefas.	Hologres
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O resultado retornado.
RequestId	string	O ID da solicitação.	7263E4AC-9D2E-5B29-B8AF-7C5012E92A41
DIJobPaging	object	As informações de paginação.
TotalCount	integer	O número total de entradas retornadas.	6
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	10
DIJobs	array<object>	A lista de tarefas.
	object
DIJobId	integer	The task ID.	16626
ProjectId	integer	The workspace ID.	1967
JobName	string	The task name.	mysql_to_holo_sync_8772
MigrationType	string	The synchronization type. Valid values: FullAndRealtimeIncremental: one-time full synchronization and real-time incremental synchronization RealtimeIncremental: real-time incremental synchronization Full: one-time full synchronization Valores válidos: FullAndRealtimeIncremental : RealtimeIncremental : Full :	Full
SourceDataSourceType	string	The type of the source. The value MySQL is returned. Valores válidos: MySQL : MySQL	MySQL
DestinationDataSourceType	string	The type of the destination. The value Hologres is returned. Valores válidos: Hologres : Hologres	Hologres
JobStatus	string	The task status. Valid values: Finished Initialized Stopped Failed Running Stopping Valores válidos: Finished : Initialized : Stopped : Failed : Running : Stopping :	Finished

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "7263E4AC-9D2E-5B29-B8AF-7C5012E92A41",
  "DIJobPaging": {
    "TotalCount": 6,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobs": [
      {
        "DIJobId": 16626,
        "ProjectId": 1967,
        "JobName": "mysql_to_holo_sync_8772",
        "MigrationType": "Full",
        "SourceDataSourceType": "MySQL",
        "DestinationDataSourceType": "Hologres",
        "JobStatus": "Finished"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.