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

Consulta os detalhes do DAG para fluxos de negócios manuais, tarefas manuais e backfill de dados. Não há suporte para detalhes de DAG de tarefas agendadas regularmente.

Descrição da operação

Tipos de DAG suportados:

MANUAL: DAG para um fluxo de trabalho de tarefa manual
SMOKE_TEST: DAG para um fluxo de trabalho de teste de fumaça
SUPPLY_DATA: DAG para uma instância de backfill de dados
BUSINESS_PROCESS_DAG: DAG para um fluxo de trabalho de processo de negócios pontual

Estados de DAG suportados:

CREATED: O DAG foi criado.
RUNNING: O DAG está em execução.
FAILURE: O DAG falhou ao ser executado.
SUCCESS: O DAG foi executado com sucesso.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DagId	integer	Sim	O ID do DAG. Você pode usar um dos seguintes métodos para obter o ID: Chame a operação RunCycleDagNodes e obtenha o valor do parâmetro de resposta Data. Chame a operação RunSmokeTest e obtenha o valor do parâmetro de resposta Data. Chame a operação RunManualDagNodes e obtenha o valor do parâmetro de resposta DagId.	123141452344525
ProjectEnv	string	Sim	O ambiente de agendamento e operações. PROD especifica o ambiente de produção e DEV especifica o ambiente de desenvolvimento. Valores válidos: PROD : 生产环境 DEV : 开发环境	PROD

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
HttpStatusCode	integer	O código de status HTTP.	200
RequestId	string	O ID da solicitação.	7782a299-b291-4fee-8424-cf8058efa8e8
ErrorMessage	string	A mensagem de erro.	The connection does not exist.
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Data	object	Os detalhes do DAG.
Type	string	O tipo do DAG. Valores válidos: MANUAL, SMOKE_TEST, SUPPLY_DATA e BUSINESS_PROCESS_DAG. O valor MANUAL indica o DAG para um fluxo de trabalho de tarefa manual. O valor SMOKE_TEST indica o DAG para um fluxo de trabalho de teste de fumaça. O valor SUPPLY_DATA indica o DAG para uma instância de backfill de dados. O valor BUSINESS_PROCESS_DAG indica o DAG para um fluxo de trabalho de processo de negócios pontual.	MANUAL_FLOW
Status	string	O status do DAG. Valores válidos: CREATED (criado), RUNNING (em execução), FAILURE (falhou) e SUCCESS (bem-sucedido).	FAILURE
FinishTime	integer	A hora em que o DAG terminou a execução.	1605052800000
CreateTime	integer	A hora em que o DAG foi criado.	1605052800000
ProjectId	integer	O ID do espaço de trabalho.	112345
DagId	integer	O ID do DAG.	351249682
Gmtdate	integer	A hora em que o DAG foi agendado para execução.	1605052800000
StartTime	integer	A hora em que o DAG começou a ser executado.	1605052800000
CreateUser	string	O criador.	1736629400048545
Bizdate	integer	A data de negócios.	1605052800000
Name	string	O nome do DAG.	test_dag
ModifyTime	integer	A hora em que o DAG foi modificado pela última vez.	1605052800000
OpSeq	integer	O número de sequência da operação.	123

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "7782a299-b291-4fee-8424-cf8058efa8e8",
  "ErrorMessage": "The connection does not exist.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "Type": "MANUAL_FLOW",
    "Status": "FAILURE",
    "FinishTime": 1605052800000,
    "CreateTime": 1605052800000,
    "ProjectId": 112345,
    "DagId": 351249682,
    "Gmtdate": 1605052800000,
    "StartTime": 1605052800000,
    "CreateUser": "1736629400048545",
    "Bizdate": 1605052800000,
    "Name": "test_dag",
    "ModifyTime": 1605052800000,
    "OpSeq": 123
  }
}

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.