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

Obtém os detalhes de uma instância de tarefa especificada.

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou 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 resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	integer	Sim	O identificador exclusivo da instância de tarefa.	1234

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura da resposta.
RequestId	string	O ID da solicitação. Você pode usar o ID para localizar logs e solucionar problemas.	22C97E95-F023-56B5-8852-B1A77****
TaskInstance	object	Os detalhes da instância da tarefa.
TaskId	integer	O ID da tarefa.	1234
TaskType	string	O tipo da tarefa.	ODPS_SQL
TaskName	string	O nome da tarefa.	SQL node
Description	string	A descrição.	test
WorkflowId	integer	O ID do workflow ao qual a instância da tarefa pertence.	1234
WorkflowName	string	O nome do workflow ao qual a instância da tarefa pertence.	Test workflow
TriggerType	string	O tipo de gatilho. Você pode obter o tipo de gatilho a partir do parâmetro de resposta Trigger.Type da operação GetTask. Valores válidos: Scheduler: A tarefa é acionada por um ciclo de agendamento. Manual: A tarefa é acionada manualmente.	Scheduler
TriggerRecurrence	string	O modo de execução ao ser acionado. Este parâmetro entra em vigor apenas quando TriggerType é definido como Scheduler. Valores válidos: Normal: A tarefa é uma tarefa agendada normal e é agendada diariamente. Manual: A tarefa é uma tarefa manual e não é agendada diariamente. Pause: A tarefa está pausada. Ela é agendada diariamente, mas é definida diretamente como com falha quando o agendamento é acionado. Skip: A tarefa realiza um dry run. Ela é agendada diariamente, mas é definida diretamente como bem-sucedida quando o agendamento é acionado. SkipUnchoose: A tarefa é uma tarefa não selecionada em um workflow temporário. Ela existe apenas em workflows temporários e é definida diretamente como bem-sucedida quando o agendamento é acionado. SkipCycle: A tarefa é uma tarefa semanal ou mensal que não atingiu seu ciclo de execução. Ela é agendada diariamente, mas é definida diretamente como bem-sucedida quando o agendamento é acionado. ConditionUnchoose: O nó downstream não é selecionado por um nó de ramificação (IF) upstream. A tarefa é definida diretamente como um dry run. RealtimeDeprecated: A tarefa é uma instância periódica expirada gerada em tempo real. Ela é definida diretamente como bem-sucedida. PauseCalendar: A instância é pausada devido a um calendário referenciado. SkipCalendar: A instância realiza um dry run devido a um calendário referenciado.	Normal
WorkflowInstanceId	integer	O ID da instância do workflow à qual a instância da tarefa pertence.	1234
WorkflowInstanceType	string	O tipo da instância do workflow à qual a instância da tarefa pertence. Valores válidos: SmokeTest: A instância é um smoke test. SupplementData: A instância é para backfill de dados. Manual: A instância é uma tarefa manual. ManualWorkflow: A instância é um workflow manual. Normal: A instância usa agendamento periódico. ManualFlow: A instância é um fluxo de negócios executado manualmente.	Normal
UnifiedWorkflowInstanceId	integer	O ID unificado da instância do workflow. O valor deste campo é o mesmo para todas as instâncias de tarefa dentro de uma data de negócios específica sob um único gatilho.	1234
Timeout	integer	O período de tempo limite para a execução da tarefa, em segundos. Nota: O sistema de agendamento arredonda o valor configurado para a hora mais próxima.	3600
RerunMode	string	A configuração que especifica se a tarefa pode ser executada novamente. Valores válidos: AllDenied: A tarefa não pode ser executada novamente, independentemente de falhar ou ser bem-sucedida. AllAllowed: A tarefa pode ser executada novamente, independentemente de falhar ou ser bem-sucedida. FailureAllowed: A tarefa pode ser executada novamente apenas se falhar.	AllAllowed
RunNumber	integer	O número atual de execuções. Valor padrão: 1.	1
PeriodNumber	integer	O número do período. Isso indica a sequência do ciclo de execução para a instância da tarefa no dia atual.	1
BaselineId	integer	O ID da linha de base.	1234
Priority	integer	A prioridade de execução da tarefa. Valores válidos: 1 a 8. Um valor maior indica uma prioridade mais alta. Valor padrão: 1.	1
Script	object	As informações sobre o script de execução.
Content	string	O conteúdo do script.	echo "helloWorld"
Parameters	string	A lista de parâmetros do script.	para1=$bizdate
RuntimeResource	object	As informações sobre o grupo de recursos associado à instância.
ResourceGroupId	string	O identificador do grupo de recursos de 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 unidade de computação (CU) configurado para a execução da tarefa.	0.25
Runtime	object	As informações de tempo de execução da instância.
ProcessId	string	O ID exclusivo do processo de execução.	T3_123
Gateway	string	A máquina na qual a tarefa é executada.	cn-shanghai.1.2
DataSource	object	As informações sobre a fonte de dados associada à instância.
Name	string	O nome da fonte de dados.	mysql_test
Inputs	object	As informações de entrada.
Variables	array<object>	A lista de definições de variáveis.
	object	A lista de definições de variáveis.
Name	string	O nome da variável.	Key1
Type	string	O tipo da variável. Valores válidos: Constant: A variável é uma constante. PassThrough: A variável é a saída de um nó de parâmetro. System: A variável é uma variável de sistema. NodeOutput: A variável é a saída do script.	Constant
Value	string	O valor da variável.	Value1
Outputs	object	As informações de saída.
TaskOutputs	array<object>	A lista de definições de saída da tarefa.
	object	A lista de definições de saída da tarefa.
Output	string	O identificador de saída.	pre.odps_sql_demo_0
Variables	array<object>	A lista de definições de variáveis.
	object	A lista de definições de variáveis.
Name	string	O nome da variável.	key1
Type	string	O tipo da variável. Valores válidos: Constant: A variável é uma constante. PassThrough: A variável é a saída de um nó de parâmetro. System: A variável é uma variável de sistema. NodeOutput: A variável é a saída do script.	Constant
Value	string	O valor da variável.	value1
Tags	array<object>	A lista de tags da tarefa.
	object	A lista de tags da tarefa.
Key	string	A chave da tag.	key1
Value	string	O valor da tag.	value1
Status	string	O status de execução da instância. Valores válidos: NotRun: Não executado. Running: Em execução. WaitTime: Aguardando o horário de acionamento. CheckingCondition: Verificando condições de ramificação. WaitResource: Aguardando recursos. Failure: Falha na execução. Success: Execução bem-sucedida. Checking: Enviado para verificação de qualidade de dados. WaitTrigger: Aguardando um acionamento externo. Os nós acionados mudam para este status após o tempo de espera.	Success
TriggerTime	integer	O horário de acionamento agendado. O valor é um carimbo de data/hora UNIX de 13 dígitos em milissegundos.	1710239005403
Bizdate	integer	A data de negócios. O valor é um carimbo de data/hora UNIX de 13 dígitos em milissegundos.	1710239005403
StartedTime	integer	A hora de início. O valor é um carimbo de data/hora UNIX de 13 dígitos em milissegundos.	1710239005403
FinishedTime	integer	A hora de conclusão. O valor é um carimbo de data/hora UNIX de 13 dígitos em milissegundos.	1710239005403
Id	integer	O identificador exclusivo da instância de tarefa.	1234
ProjectId	integer	O ID do projeto.	100
ProjectEnv	string	O ambiente do projeto. Valores válidos: Prod: Produção. Dev: Desenvolvimento.	Prod
Owner	string	O ID da conta do proprietário da tarefa.	1000
CreateTime	integer	A hora de criação. O valor é um carimbo de data/hora UNIX de 13 dígitos em milissegundos.	1710239005403
ModifyTime	integer	A hora de atualização. O valor é um carimbo de data/hora UNIX de 13 dígitos em milissegundos.	1710239005403
CreateUser	string	O ID da conta do usuário que criou a instância.	1000
ModifyUser	string	O ID da conta do usuário que atualizou a instância.	1000
WaitingResourceTime	integer	A hora em que a instância começa a aguardar recursos.	1710239005403
WaitingTriggerTime	integer	A hora em que a instância começa a aguardar o acionamento agendado. O valor é um carimbo de data/hora UNIX de 13 dígitos em milissegundos.	1710239005403
OperationType	string	O tipo da operação mais recente na instância.	TriggerDqc

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77****",
  "TaskInstance": {
    "TaskId": 1234,
    "TaskType": "ODPS_SQL",
    "TaskName": "SQL node\n",
    "Description": "test",
    "WorkflowId": 1234,
    "WorkflowName": "Test workflow",
    "TriggerType": "Scheduler",
    "TriggerRecurrence": "Normal",
    "WorkflowInstanceId": 1234,
    "WorkflowInstanceType": "Normal",
    "UnifiedWorkflowInstanceId": 1234,
    "Timeout": 3600,
    "RerunMode": "AllAllowed",
    "RunNumber": 1,
    "PeriodNumber": 1,
    "BaselineId": 1234,
    "Priority": 1,
    "Script": {
      "Content": "echo \"helloWorld\"",
      "Parameters": "para1=$bizdate"
    },
    "RuntimeResource": {
      "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
      "Image": "i-xxxxxx",
      "Cu": "0.25"
    },
    "Runtime": {
      "ProcessId": "T3_123",
      "Gateway": "cn-shanghai.1.2"
    },
    "DataSource": {
      "Name": "mysql_test"
    },
    "Inputs": {
      "Variables": [
        {
          "Name": "Key1",
          "Type": "Constant",
          "Value": "Value1"
        }
      ]
    },
    "Outputs": {
      "TaskOutputs": [
        {
          "Output": "pre.odps_sql_demo_0"
        }
      ],
      "Variables": [
        {
          "Name": "key1",
          "Type": "Constant",
          "Value": "value1"
        }
      ]
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "Status": "Success",
    "TriggerTime": 1710239005403,
    "Bizdate": 1710239005403,
    "StartedTime": 1710239005403,
    "FinishedTime": 1710239005403,
    "Id": 1234,
    "ProjectId": 100,
    "ProjectEnv": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000",
    "ModifyUser": "1000",
    "WaitingResourceTime": 1710239005403,
    "WaitingTriggerTime": 1710239005403,
    "OperationType": "TriggerDqc"
  }
}

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.