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

Obtém os detalhes de um workflow especificado.

Descrição da operação

Este recurso requer o DataWorks Basic Edition ou uma edição superior.

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 resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	integer	Sim	O identificador exclusivo do workflow.	1234
EnvType	string	Não	O ambiente do projeto. Valores válidos: Prod: Ambiente de produção. Dev: Ambiente de desenvolvimento. Valores válidos: Prod : Produção. Dev : Desenvolvimento.	Prod

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação. Você pode usar o ID para localizar logs e solucionar problemas.	22C97E95-F023-56B5-8852-B1A77A17XXXX
Workflow	object	Os detalhes do workflow.
Id	integer	O identificador exclusivo do workflow.	1234
ProjectId	integer	O ID do projeto.	100
EnvType	string	O ambiente do projeto. Valores válidos: Prod: Ambiente de produção. Dev: Ambiente de desenvolvimento.	Prod
Owner	string	O ID da conta do proprietário.	1000
Name	string	O nome.	Workflow
Description	string	A descrição.	Test workflow
Trigger	object	A configuração do gatilho.
Type	string	O tipo do método de gatilho. Valores válidos: Scheduler: acionado por um ciclo de agendamento Manual: acionado manualmente	Scheduler
Recurrence	string	O modo de execução quando o gatilho é acionado. Este parâmetro entra em vigor apenas quando Type é definido como Scheduler. Valores válidos: Pause: pausado Skip: dry run Normal: execução normal	Normal
Cron	string	A expressão cron. Este parâmetro entra em vigor apenas quando Type é definido como Scheduler.	00 00 00 * * ?
StartTime	string	O horário em que o acionamento periódico entra em vigor. Este parâmetro entra em vigor apenas quando Type é definido como Scheduler. O formato é `yyyy-MM-dd HH:mm:ss`, como `1970-01-01 00:00:00`. O exemplo não inclui um identificador de fuso horário.	1970-01-01 00:00:00
EndTime	string	O horário de expiração do gatilho periódico. Este parâmetro entra em vigor apenas quando Type é definido como Scheduler. O formato é `yyyy-MM-dd HH:mm:ss`, como `1970-01-01 00:00:00`. O exemplo não inclui um identificador de fuso horário.	1970-01-01 00:00:00
Dependencies	array<object>	As informações de dependência.
	object
Type	string	O tipo de dependência. Valores válidos: CrossCycleDependsOnChildren: dependência entre ciclos em nós filho de primeiro nível CrossCycleDependsOnSelf: dependência entre ciclos no próprio nó CrossCycleDependsOnOtherNode: dependência entre ciclos em outros nós Normal: dependência no mesmo ciclo	Normal
UpstreamOutput	string	O identificador de saída da tarefa upstream. Este campo é retornado quando o tipo de dependência é dependência no mesmo ciclo e o conteúdo de entrada está configurado.	pre.odps_sql_demo_0
UpstreamTaskId	integer	O ID da tarefa upstream. Este campo é retornado quando o tipo de dependência é dependência entre ciclos em outros nós ou dependência no mesmo ciclo sem conteúdo de entrada configurado. Não é retornado em outros casos.	1234
Parameters	string	A lista de parâmetros.	para1=$bizdate para2=$[yyyymmdd]
Tasks	array<object>	A lista de tarefas.
	array<object>
Id	integer	O ID da tarefa.	1234
ProjectId	integer	O ID do projeto.	100
EnvType	string	O ambiente do projeto. Valores válidos: Prod: Ambiente de produção. Dev: Ambiente de desenvolvimento.	Prod
Owner	string	O ID da conta do proprietário da tarefa.	1000
Name	string	O nome da tarefa.	SQL node
Description	string	A descrição.	Test
WorkflowId	integer	O ID do workflow ao qual a tarefa pertence.	1234
Type	string	O tipo da tarefa.	ODPS_SQL
BaselineId	integer	O ID da linha de base.	1234
Priority	integer	A prioridade da tarefa. Valores válidos: 1 a 8. Um valor maior indica uma prioridade maior. Valor padrão: 1.	1
Timeout	integer	O tempo limite para a execução da tarefa, em segundos.	3600
RerunMode	string	A configuração que especifica se a tarefa pode ser reexecutada. Valores válidos: AllDenied: A tarefa não pode ser reexecutada, independentemente de ter sucesso ou falhar. FailureAllowed: A tarefa pode ser reexecutada apenas quando falhar. AllAllowed: A tarefa pode ser reexecutada, independentemente de ter sucesso ou falhar.	AllAllowed
RerunTimes	integer	O número de tentativas. Este parâmetro entra em vigor apenas quando a tarefa está configurada para ser reexecutável.	3
RerunInterval	integer	O intervalo de tempo para nova tentativa, em segundos.	60
RuntimeResource	object	A configuração do ambiente de execução, como as informações do grupo de recursos.
ResourceGroupId	string	O identificador do grupo de recursos para agendamento configurado para a execução da tarefa.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	O ID da imagem configurada para a execução da tarefa.	i-xxxxxx
Cu	string	O consumo de CU configurado para a execução da tarefa.	0.25
DataSource	object	As informações da fonte de dados associada.
Name	string	O nome da fonte de dados.	mysql_test
CreateTime	integer	A hora de criação. O valor é um número de 13 dígitos, como `1710239005403`.	1710239005403
ModifyTime	integer	A hora de atualização. O valor é um número de 13 dígitos, como `1710239005403`.	1710239005403
CreateUser	string	O ID da conta do usuário que criou a tarefa.	1000
ModifyUser	string	O ID da conta do usuário que atualizou a tarefa.	1000
TriggerRecurrence	string	O modo de execução quando o gatilho é acionado. Valores válidos: Pause: pausado Skip: dry run Normal: execução normal	Normal
ClientUniqueCode	string	O código exclusivo do cliente da tarefa, que é usado para implementar operações assíncronas e idempotentes. Se você não especificar este parâmetro ao criar a tarefa, o sistema gerará automaticamente um código e o vinculará exclusivamente ao ID do recurso. Se você especificar este parâmetro ao atualizar ou excluir o recurso, ele deverá ser igual ao código exclusivo do cliente usado durante a criação.	Task_0bc5213917368545132902xxxxxxxx
Outputs	object	As informações de saída.
TaskOutputs	array<object>	A lista de definições de saída da tarefa.
	object
Output	string	O identificador de saída.	pre.odps_sql_demo_0
Tags	array<object>	A lista de tags.
	object
Key	string	A chave da tag.	key1
Value	string	O valor da tag.	value1
CreateTime	integer	A hora de criação. O valor é um número de 13 dígitos, como `1710239005403`.	1710239005403
ModifyTime	integer	A hora de atualização. O valor é um número de 13 dígitos, como `1710239005403`.	1710239005403
CreateUser	string	O ID da conta do usuário que criou o workflow.	1000
ModifyUser	string	O ID da conta do usuário que atualizou o workflow.	1000
ClientUniqueCode	string	O código exclusivo do cliente do workflow, que é usado para implementar operações assíncronas e idempotentes. Se você não especificar este parâmetro ao criar o workflow, o sistema gerará automaticamente um código e o vinculará exclusivamente ao ID do recurso. Se você especificar este parâmetro ao atualizar ou excluir o recurso, ele deverá ser igual ao código exclusivo do cliente usado durante a criação.	Workflow_0bc5213917368545132902xxxxxxxx

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Workflow": {
    "Id": 1234,
    "ProjectId": 100,
    "EnvType": "Prod",
    "Owner": "1000",
    "Name": "Workflow",
    "Description": "Test workflow",
    "Trigger": {
      "Type": "Scheduler",
      "Recurrence": "Normal",
      "Cron": "00 00 00 * * ?",
      "StartTime": "1970-01-01 00:00:00",
      "EndTime": "1970-01-01 00:00:00"
    },
    "Dependencies": [
      {
        "Type": "Normal",
        "UpstreamOutput": "pre.odps_sql_demo_0",
        "UpstreamTaskId": 1234
      }
    ],
    "Parameters": "para1=$bizdate para2=$[yyyymmdd] ",
    "Tasks": [
      {
        "Id": 1234,
        "ProjectId": 100,
        "EnvType": "Prod",
        "Owner": "1000",
        "Name": "SQL node",
        "Description": "Test",
        "WorkflowId": 1234,
        "Type": "ODPS_SQL",
        "BaselineId": 1234,
        "Priority": 1,
        "Timeout": 3600,
        "RerunMode": "AllAllowed",
        "RerunTimes": 3,
        "RerunInterval": 60,
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx",
          "Cu": "0.25"
        },
        "DataSource": {
          "Name": "mysql_test"
        },
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000",
        "TriggerRecurrence": "Normal",
        "ClientUniqueCode": "Task_0bc5213917368545132902xxxxxxxx"
      }
    ],
    "Outputs": {
      "TaskOutputs": [
        {
          "Output": "pre.odps_sql_demo_0"
        }
      ]
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000",
    "ModifyUser": "1000",
    "ClientUniqueCode": "Workflow_0bc5213917368545132902xxxxxxxx"
  }
}

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.