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

Consulta as informações de uma instância de fluxo de trabalho.

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou uma edição superior para usar este recurso.

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
Id	integer	Sim	O ID da instância de fluxo de trabalho.	1234

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	22C97E95-F023-56B5-8852-B1A77A17XXXX
WorkflowInstance	object	As informações da instância de fluxo de trabalho.
Id	integer	O ID da instância de fluxo de trabalho.	1234
WorkflowId	integer	O ID do fluxo de trabalho ao qual a instância pertence.	1234
WorkflowTaskInstanceId	integer	O ID da instância da tarefa correspondente à instância de fluxo de trabalho.	1234
UnifiedWorkflowInstanceId	integer	O ID unificado da instância de fluxo de trabalho. Este campo tem o mesmo valor para todas as instâncias de fluxo de trabalho para a mesma data de negócios dentro de um único gatilho.	1234
Name	string	O nome da instância de fluxo de trabalho.	WorkInstance1
Type	string	O tipo da instância de fluxo de trabalho. Valores válidos: Normal: Execução agendada Manual: Nó acionado manualmente SmokeTest: Teste SupplementData: Preenchimento de dados ManualWorkflow: Fluxo de trabalho acionado manualmente TriggerWorkflow: Fluxo de trabalho acionado	Normal
Status	string	O status da instância de fluxo de trabalho. Valores válidos: NotRun: A instância não foi executada. Running: A instância está em execução. WaitTime: A instância está aguardando o horário de agendamento. CheckingCondition: As condições de ramificação estão sendo verificadas para a instância. WaitResource: A instância está aguardando recursos. Failure: A execução da instância falhou. Success: A instância foi executada com sucesso. Checking: A qualidade dos dados está sendo verificada para a instância.	Success
BizDate	integer	A data de negócios.	1710239005403
StartedTime	integer	O horário em que a instância começou a ser executada.	1710239005403
FinishedTime	integer	O horário em que a instância concluiu a execução.	1710239005403
ProjectId	integer	O ID do espaço de trabalho.	100
EnvType	string	O ambiente do espaço de trabalho. Valores válidos: Prod: ambiente de produção Dev: ambiente de desenvolvimento	Prod
Owner	string	O ID da conta do proprietário do fluxo de trabalho.	1000
CreateTime	integer	O horário de criação.	1710239005403
ModifyTime	integer	O horário de modificação.	1710239005403
CreateUser	string	O ID da conta do criador.	1000
ModifyUser	string	O ID da conta do modificador.	1000
WorkflowParameters	string	Os parâmetros do fluxo de trabalho.	Scheduled workflow： key1=value1 key2=value2 Manual workflow： {"key1":"value1", "key2": "value2"}
Tags	array<object>	A tag da tarefa.
	object
Key	string	A chave de uma tag.	key1
Value	string	O valor de uma tag.	value1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "WorkflowInstance": {
    "Id": 1234,
    "WorkflowId": 1234,
    "WorkflowTaskInstanceId": 1234,
    "UnifiedWorkflowInstanceId": 1234,
    "Name": "WorkInstance1",
    "Type": "Normal",
    "Status": "Success",
    "BizDate": 1710239005403,
    "StartedTime": 1710239005403,
    "FinishedTime": 1710239005403,
    "ProjectId": 100,
    "EnvType": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000",
    "ModifyUser": "1000",
    "WorkflowParameters": "周期工作流：\nkey1=value1 key2=value2\n手动业务流程：\n{\"key1\":\"value1\", \"key2\": \"value2\"}",
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ]
  }
}

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.