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

Obtém uma lista paginada de instâncias de tarefa. Você também pode realizar uma consulta filtrada com base em condições.

Descrição da operação

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

get

*TaskInstance

acs:dataworks:{#regionId}:{#accountId}:taskinstance/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Sim	O ID do projeto.	100
Bizdate	integer	Sim	A data de negócios. Geralmente, corresponde às 00:00:00 do dia anterior ao horário agendado da instância periódica, no formato de timestamp em milissegundos, como 1743350400000.	1710239005403
TaskId	integer	Não	O ID da tarefa.	1234
TaskIds	array	Não	Os IDs das tarefas. Você pode especificar vários IDs de tarefas para consultar instâncias de tarefa em lotes.
	integer	Não	O ID da tarefa.	1234
TaskName	string	Não	O nome da tarefa. Há suporte para correspondência aproximada.	SQL node
Owner	string	Não	O ID da conta do proprietário da tarefa.	1000
TaskType	string	Não	O tipo de tarefa. Para os valores válidos de TaskType para cada nó, consulte Tipos de nó do DataWorks.	ODPS_SQL
RuntimeResource	string	Não	As informações do grupo de recursos. Especifique o identificador do grupo de recursos de agendamento.	S_res_group_524258031846018_1684XXXXXXXXX
WorkflowId	integer	Não	O ID do fluxo de trabalho associado.	1234
UnifiedWorkflowInstanceId	integer	Não	O ID unificado da instância de fluxo de trabalho. Este valor é o mesmo para todas as instâncias de tarefa dentro de uma data de negócios específica sob um único gatilho.	1234
WorkflowInstanceType	string	Não	O tipo da instância de fluxo de trabalho. Valores válidos: SmokeTest: teste Manual: tarefa manual SupplementData: backfill de dados ManualWorkflow: fluxo de trabalho manual Normal: agendamento periódico TriggerWorkflow: fluxo de trabalho acionado Valores válidos: SmokeTest : Teste. TriggerWorkflow : Fluxo de trabalho acionado. Manual : Tarefa manual. SupplementData : Backfill de dados. ManualWorkflow : Fluxo de trabalho manual. Normal : Agendamento periódico.	Normal
WorkflowInstanceId	integer	Não	O ID da instância de fluxo de trabalho associada.	1234
ProjectEnv	string	Não	O ambiente do projeto. Valores válidos: Prod: produção Dev: desenvolvimento Valores válidos: Prod : Produção. Dev : Desenvolvimento.	Prod
Id	integer	Não	O ID da instância de tarefa. Uma instância de tarefa pode ser reexecutada. Se você especificar este parâmetro, a resposta incluirá registros históricos de reexecução, que são diferenciados por RunNumber.	1234
Ids	array	Não	Os IDs das instâncias de tarefa. Você pode especificar vários IDs de instâncias de tarefa para consultar instâncias de tarefa em lotes.
	integer	Não	O ID da instância de tarefa.	1234
TriggerType	string	Não	O tipo de gatilho. Valores válidos: Scheduler: agendamento periódico Manual: manual Valores válidos: Scheduler : Agendamento periódico. Manual : Manual.	Normal
TriggerRecurrence	string	Não	O modo de execução ao acionar. Este parâmetro entra em vigor apenas quando TriggerType é definido como Scheduler. Valores válidos: Pause: pausa Skip: dry run Normal: execução normal Valores válidos: Pause : Pausa. Skip : Dry run. Normal : Execução normal.	Normal
SortBy	string	Não	O campo de ordenação. Há suporte para campos como horário agendado e horário de início. O formato é 'Campo de ordenação + Ordem de ordenação (Desc/Asc)', onde Asc pode ser omitido. Valores válidos para o campo de ordenação: `TriggerTime (Desc/Asc)` `StartedTime (Desc/Asc)` `FinishedTime (Desc/Asc)` `CreateTime (Desc/Asc)` `Id (Desc/Asc)` Valor padrão: `Id Desc`	Id Desc
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 500.	10
PageNumber	integer	Não	O número da página. As páginas começam em 1. Valor padrão: 1.	1
Status	string	Não	O status da instância de tarefa. Valores válidos: `NotRun`: não executado `Running`: em execução `Failure`: com falha `Success`: bem-sucedido `WaitTime`: aguardando horário agendado `WaitResource`: aguardando recursos Valores válidos: NotRun : Não executado. Running : Em execução. WaitTime : Aguardando horário agendado. WaitResource : Aguardando recursos. Failure : Com falha. Success : Bem-sucedido.	Success
Filter	string	Não	As condições de filtro no formato JSON. Várias condições de filtro são combinadas com o operador lógico AND. Campos suportados: `startedTimeStart`, `startedTimeEnd`, `finishedTimeStart`, `finishedTimeEnd`, `createTimeStart` e `createTimeEnd`.	{ "startedTimeStart": "1763481600000", "startedTimeEnd": "1763481600000", "finishedTimeStart": "1763481600000", "finishedTimeEnd": "1763481600000", "createTimeStart": "1763481600000", "createTimeEnd": "1763481600000" }

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	As informações de paginação.
TaskInstances	array<object>	A lista de instâncias de tarefa.
	array<object>
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 fluxo de trabalho associado.	1234
WorkflowName	string	O nome do fluxo de trabalho ao qual a instância de tarefa pertence.	Test workflow
TriggerType	string	O tipo de gatilho. Valores válidos: Scheduler: Acionado por um ciclo de agendamento. Manual: Acionado manualmente.	Scheduler
TriggerRecurrence	string	O modo de execução quando o nó é acionado. Este parâmetro entra em vigor apenas quando TriggerType é definido como Scheduler. Valores válidos: Pause: O nó é pausado. Skip: O nó realiza um dry run. Normal: O nó é executado normalmente.	Normal
WorkflowInstanceId	integer	O ID da instância de fluxo de trabalho associada.	1234
UnifiedWorkflowInstanceId	integer	O ID unificado da instância de fluxo de trabalho. Este valor é o mesmo para todas as instâncias de tarefa dentro de uma data de negócios específica sob um único gatilho.	1234
WorkflowInstanceType	string	O tipo da instância de fluxo de trabalho à qual a instância de tarefa pertence. Valores válidos: SmokeTest: Teste de fumaça. SupplementData: Preenchimento de dados. Manual: Execução manual. ManualWorkflow: Fluxo de trabalho manual. Normal: Ciclo agendado. ManualFlow: Fluxo de negócios executado manualmente.	Normal
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 horas inteiras.	3600
RerunMode	string	A configuração de reexecução para a tarefa. Valores válidos: AllDenied: Reexecuções não são permitidas independentemente de sucesso ou falha. FailureAllowed: Reexecuções são permitidas apenas após falhas. AllAllowed: Reexecuções são permitidas após sucessos e falhas.	AllAllowed
RunNumber	integer	O número da execução atual. Valor padrão: 1.	1
PeriodNumber	integer	O número do ciclo. Isso indica a rodada do ciclo da instância de 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
RuntimeResource	object	As informações do grupo de recursos associadas à 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 número de unidades de computação (CUs) consumidas durante 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 da execução.	T3_123
Gateway	string	A máquina de gateway.	cn-shanghai.1.2
DataSource	object	As informações da fonte de dados associadas à instância.
Name	string	O nome da fonte de dados.	mysql_test
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: Falhou. Success: Bem-sucedido. Checking: Enviado para verificação de qualidade de dados. WaitTrigger: Aguardando um gatilho externo. Nós baseados em gatilho 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 de 13 dígitos, como `1710239005403`.	1710239005403
Bizdate	integer	A data de negócios. O valor é um carimbo de data/hora de 13 dígitos, como `1710239005403`.	1710239005403
StartedTime	integer	A hora de início. O valor é um carimbo de data/hora de 13 dígitos, como `1710239005403`.	1710239005403
FinishedTime	integer	A hora de conclusão. O valor é um carimbo de data/hora de 13 dígitos, como `1710239005403`.	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 de 13 dígitos, como `1710239005403`.	1710239005403
ModifyTime	integer	A hora de atualização. O valor é um carimbo de data/hora de 13 dígitos, como `1710239005403`.	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 modificou a instância pela última vez.	1000
ScriptParameters	string	A lista de parâmetros de script.	para1=val1 para2=val2
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 horário de acionamento agendado. O valor é um carimbo de data/hora de 13 dígitos, como `1710239005403`.	1710239005403
OperationType	string	O tipo da última operação realizada na instância.	TriggerDqc
TotalCount	integer	O número total de entradas.	100
PageSize	integer	O número de entradas por página.	10
PageNumber	integer	O número da página.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "PagingInfo": {
    "TaskInstances": [
      {
        "TaskId": 1234,
        "TaskType": "ODPS_SQL\n",
        "TaskName": "SQL node\n",
        "Description": "test\n",
        "WorkflowId": 1234,
        "WorkflowName": "Test workflow\n",
        "TriggerType": "Scheduler\n",
        "TriggerRecurrence": "Normal\n",
        "WorkflowInstanceId": 1234,
        "UnifiedWorkflowInstanceId": 1234,
        "WorkflowInstanceType": "Normal",
        "Timeout": 3600,
        "RerunMode": "AllAllowed\n",
        "RunNumber": 1,
        "PeriodNumber": 1,
        "BaselineId": 1234,
        "Priority": 1,
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx\n",
          "Cu": "0.25\n"
        },
        "Runtime": {
          "ProcessId": "T3_123\n",
          "Gateway": "cn-shanghai.1.2\n"
        },
        "DataSource": {
          "Name": "mysql_test\n"
        },
        "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",
        "ScriptParameters": "para1=val1 para2=val2",
        "WaitingResourceTime": 1710239005403,
        "WaitingTriggerTime": 1710239005403,
        "OperationType": "TriggerDqc"
      }
    ],
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1
  }
}

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.