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

Consulta as informações de uma tarefa.

Descrição da operação

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

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 tarefa.	1234
ProjectEnv	string	Não	O ambiente do workspace. Valores válidos:\n\n- Prod: ambiente de produção\n\n- Dev: ambiente de desenvolvimento.	Prod

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	22C97E95-F023-56B5-8852-B1A77A17XXXX
Task	object	Os detalhes da tarefa.
Name	string	O nome da tarefa.	SQL node
Description	string	A descrição da tarefa.	test
WorkflowId	integer	O ID do fluxo de trabalho.	1234
InstanceMode	string	O modo de geração de instâncias. Valores válidos: T+1: gerada no dia seguinte Immediately: gerada imediatamente	T+1
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 período de tempo limite de execução da tarefa. Unidade: segundos.	3600
RerunMode	string	O modo de nova execução. Valores válidos: AllDenied: A tarefa não pode ser executada novamente, independentemente de ser executada com sucesso ou falhar. FailureAllowed: A tarefa pode ser executada novamente somente após falhar na execução. AllAllowed: A tarefa pode ser executada novamente, independentemente de ser executada com sucesso ou falhar.	AllAllowed
RerunTimes	integer	O número de vezes que a tarefa é executada novamente. Este parâmetro entra em vigor apenas se o parâmetro RerunMode estiver definido como AllAllowed ou FailureAllowed.	3
RerunInterval	integer	O intervalo de nova execução. Unidade: segundos.	60
Script	object	As informações do script.
Content	string	O conteúdo do script.	echo "helloWorld"
Parameters	string	Os parâmetros do script.	para1=$bizdate
Trigger	object	O método para acionar o agendamento da tarefa.
Type	string	O tipo de gatilho. Valores válidos: Scheduler: agendamento periódico Manual: agendamento manual	Scheduler
Recurrence	string	O modo de execução da tarefa após ser acionada. Este parâmetro entra em vigor apenas se o parâmetro Type estiver definido como Scheduler. Valores válidos: Pause: pausada Skip: dry run Normal: operação normal	Normal
Cron	string	A expressão CRON da tarefa. Este parâmetro entra em vigor apenas se o parâmetro Type estiver definido como Scheduler.	00 00 00 * * ?
StartTime	string	A hora de início do intervalo de tempo durante o qual a tarefa é agendada periodicamente. Este parâmetro entra em vigor apenas se o parâmetro Type estiver definido como Scheduler.	1970-01-01 00:00:00
EndTime	string	A hora de término do intervalo de tempo durante o qual a tarefa é agendada periodicamente. Este parâmetro entra em vigor apenas se o parâmetro Type estiver definido como Scheduler.	9999-01-01 00:00:00
RuntimeResource	object	As configurações do ambiente de execução, como as informações do grupo de recursos.
ResourceGroupId	string	O ID 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 número de unidades de computação (CUs) configuradas para a execução da tarefa.	0.25
DataSource	object	As informações sobre a fonte de dados associada.
Name	string	O nome da fonte de dados.	mysql_test
Inputs	object	As informações de entrada.
Variables	array<object>	As variáveis.
	object
Name	string	O nome da variável.	key1
Type	string	O tipo. Valores válidos: Constant: constante PassThrough: saída do nó de parâmetro System: variável NodeOutput: saída do script	Constant
Value	string	O valor da variável.	Value1
Outputs	object	As informações de saída.
TaskOutputs	array<object>	As saídas da tarefa.
	object
Output	string	O identificador da saída.	pre.odps_sql_demo_0
Variables	array<object>	As variáveis.
	object
Name	string	O nome da variável.	key1
Type	string	O tipo. Valores válidos: Constant: constante PassThrough: saída do nó de parâmetro System: variável NodeOutput: saída do script	Constant
Value	string	O valor da variável.	value1
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 descendentes de nível 1 CrossCycleDependsOnSelf: dependência entre ciclos no nó atual CrossCycleDependsOnOtherNode: dependência entre ciclos em outros nós Normal: dependência de agendamento no mesmo ciclo	Normal
UpstreamOutput	string	O identificador da saída da tarefa ancestral. Este parâmetro é retornado apenas se as dependências de agendamento no mesmo ciclo e a entrada do nó estiverem configuradas.	pre.odps_sql_demo_0
UpstreamTaskId	string	O ID da tarefa upstream. Este campo é retornado para dependências entre ciclos em outros nós, ou para dependências no mesmo ciclo quando o conteúdo de entrada não está configurado. Não é retornado em outros casos.	1234
SubTasks	object	As configurações das subtarefas, como um nó do-while.
SubTasks	array<object>	As subtarefas.
	array<object>
Name	string	O nome da tarefa.	SQL node
Description	string	A descrição da tarefa.	test
WorkflowId	integer	O ID do fluxo de trabalho ao qual a tarefa pertence.	1234
Type	string	O tipo da tarefa.	ODPS_SQL
BaselineId	integer	O ID da linha de base.	The baseline ID.
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 período de tempo limite de execução da tarefa. Unidade: segundos.	3600
RerunMode	string	O modo de nova execução. Valores válidos: AllDenied: A tarefa não pode ser executada novamente, independentemente de ser executada com sucesso ou falhar. FailureAllowed: A tarefa pode ser executada novamente somente após falhar na execução. AllAllowed: A tarefa pode ser executada novamente, independentemente de ser executada com sucesso ou falhar.	AllAllowed
RerunTimes	integer	O número de vezes que a tarefa é executada novamente. Este parâmetro entra em vigor apenas se o parâmetro RerunMode estiver definido como AllAllowed ou FailureAllowed.	3
RerunInterval	integer	O intervalo de nova execução. Unidade: segundos.	180
Trigger	object	O método para acionar o agendamento da tarefa.
Type	string	O tipo de gatilho. Valores válidos: Scheduler: agendamento periódico Manual: agendamento manual	Scheduler
Recurrence	string	O modo de execução da tarefa após ser acionada. Este parâmetro entra em vigor apenas se o parâmetro Type estiver definido como Scheduler. Valores válidos: Pause: pausada Skip: dry run Normal: operação normal	Normal
Cron	string	A expressão CRON da tarefa. Este parâmetro entra em vigor apenas se o parâmetro Type estiver definido como Scheduler.	00 00 00 * * ?
StartTime	string	A hora de início do intervalo de tempo durante o qual a tarefa é agendada periodicamente. Este parâmetro entra em vigor apenas se o parâmetro Type estiver definido como Scheduler.	1970-01-01 00:00:00
EndTime	string	A hora de término do intervalo de tempo durante o qual a tarefa é agendada periodicamente. Este parâmetro entra em vigor apenas se o parâmetro Type estiver definido como Scheduler.	9999-01-01 00:00:00
RuntimeResource	object	A configuração do ambiente de execução da tarefa, como o grupo de recursos.
ResourceGroupId	string	O ID 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 número de CUs configuradas para a execução da tarefa.	0.25
DataSource	object	As informações sobre a fonte de dados associada.
Name	string	O nome da fonte de dados.	mysql_test
Id	integer	O ID da tarefa.	1234
ProjectId	integer	O ID do espaço de trabalho.	100
ProjectEnv `deprecated`	string	O ambiente do espaço de trabalho. Este parâmetro foi descontinuado e substituído pelo parâmetro EnvType. Valores válidos: Prod: ambiente de produção Dev: ambiente de desenvolvimento	Prod
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 da tarefa.	1000
CreateTime	integer	A hora de criação.	1710239005403
ModifyTime	integer	A hora de modificação.	1710239005403
CreateUser	string	O ID da conta do criador.	1000
ModifyUser	string	O ID da conta do modificador.	1000
Type	string	O tipo da subtarefa. Valores válidos: DoWhile: nó do-while Combined: grupo de nós ForEach: nó for-each	Combined
Tags	array<object>	As tags.
	object
Key	string	A chave da tag.	key1
Value	string	O valor da tag.	value1
Id	integer	O identificador único da tarefa.	1234
ProjectId	integer	O ID do espaço de trabalho.	100
ProjectEnv `deprecated`	string	O ambiente do espaço de trabalho. Este parâmetro foi descontinuado e substituído pelo parâmetro EnvType. Valores válidos: Prod: ambiente de produção Dev: ambiente de desenvolvimento	Prod
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 da tarefa.	1000
CreateTime	integer	A hora de criação.	1710239005403
ModifyTime	integer	A hora de modificação.	1710239005403
CreateUser	string	O ID da conta do criador.	1000
ModifyUser	string	O ID da conta do modificador.	1000

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Task": {
    "Name": "SQL node",
    "Description": "test",
    "WorkflowId": 1234,
    "InstanceMode": "T+1",
    "Type": "ODPS_SQL",
    "BaselineId": 1234,
    "Priority": 1,
    "Timeout": 3600,
    "RerunMode": "AllAllowed",
    "RerunTimes": 3,
    "RerunInterval": 60,
    "Script": {
      "Content": "echo \"helloWorld\"",
      "Parameters": "para1=$bizdate"
    },
    "Trigger": {
      "Type": "Scheduler",
      "Recurrence": "Normal",
      "Cron": "00 00 00 * * ?",
      "StartTime": "1970-01-01 00:00:00",
      "EndTime": "9999-01-01 00:00:00"
    },
    "RuntimeResource": {
      "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
      "Image": "i-xxxxxx\n",
      "Cu": "0.25"
    },
    "DataSource": {
      "Name": "mysql_test"
    },
    "Inputs": {
      "Variables": [
        {
          "Name": "key1",
          "Type": "Constant\n",
          "Value": "Value1\n"
        }
      ]
    },
    "Outputs": {
      "TaskOutputs": [
        {
          "Output": "pre.odps_sql_demo_0"
        }
      ],
      "Variables": [
        {
          "Name": "key1",
          "Type": "Constant\n",
          "Value": "value1"
        }
      ]
    },
    "Dependencies": [
      {
        "Type": "Normal",
        "UpstreamOutput": "pre.odps_sql_demo_0",
        "UpstreamTaskId": "1234"
      }
    ],
    "SubTasks": {
      "SubTasks": [
        {
          "Name": "SQL node\n",
          "Description": "test",
          "WorkflowId": 1234,
          "Type": "ODPS_SQL\n",
          "BaselineId": 0,
          "Priority": 1,
          "Timeout": 3600,
          "RerunMode": "AllAllowed",
          "RerunTimes": 3,
          "RerunInterval": 180,
          "Trigger": {
            "Type": "Scheduler",
            "Recurrence": "Normal\n",
            "Cron": "00 00 00 * * ?\n",
            "StartTime": "1970-01-01 00:00:00\n",
            "EndTime": "9999-01-01 00:00:00\n"
          },
          "RuntimeResource": {
            "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
            "Image": "i-xxxxxx",
            "Cu": "0.25"
          },
          "DataSource": {
            "Name": "mysql_test\n"
          },
          "Id": 1234,
          "ProjectId": 100,
          "ProjectEnv": "Prod",
          "EnvType": "Prod",
          "Owner": "1000\n",
          "CreateTime": 1710239005403,
          "ModifyTime": 1710239005403,
          "CreateUser": "1000\n",
          "ModifyUser": "1000\n"
        }
      ],
      "Type": "Combined"
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "Id": 1234,
    "ProjectId": 100,
    "ProjectEnv": "Prod",
    "EnvType": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000\n",
    "ModifyUser": "1000"
  }
}

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.