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

Obtém uma lista paginada de instâncias downstream de uma instância especificada.

Descrição da operação

É necessária a edição Basic do DataWorks ou uma edição mais avançada.

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.	1234
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10.	10
PageNumber	integer	Não	O número da página. As páginas começam em 1. Valor padrão: 1.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação, usado para localizar logs e solucionar problemas.	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	As informações de paginação.
TaskInstances	array<object>	[Deprecated] A lista de instâncias de tarefa. Este campo está descontinuado. Use DownstreamTaskInstances em seu lugar.
	array<object>
StepType	string	O tipo de dependência. Valores válidos: Normal: dependência dentro do mesmo ciclo de agendamento. CrossCycle: dependência entre ciclos.	Normal
TaskId	integer	O ID do nó correspondente.	1234
TaskType	string	O tipo do nó correspondente.	ODPS_SQL
TaskName	string	O nome do nó correspondente.	SQL node
Description	string	A descrição.	test
WorkflowId	integer	O ID do fluxo de trabalho ao qual a instância pertence.	1234
WorkflowName	string	O nome do fluxo de trabalho ao qual a instância pertence.	Test workflow
TriggerType	string	O tipo de gatilho. Valores válidos: Scheduler : Acionado por ciclo de agendamento. Manual : Acionado manualmente.	Scheduler
TriggerRecurrence	string	O modo de execução no momento do acionamento. Este parâmetro entra em vigor quando TriggerType é definido como Scheduler. Valores válidos: Pause : Pausado. Skip : Dry run. Normal : Normal.	Normal
WorkflowInstanceId	integer	O ID da instância do fluxo de trabalho à qual a instância pertence.	1234
WorkflowInstanceType	string	O tipo da instância do fluxo de trabalho à qual a instância pertence. Valores válidos: SmokeTest : Teste. Manual : Manual. SupplementData : Preenchimento de dados. ManualWorkflow : Fluxo de trabalho manual. ManualFlow : Processo de negócios acionado manualmente. Normal : Agendamento periódico.	Normal
Timeout	integer	O período de tempo limite para a execução do nó. Unidade: segundos. Nota: O sistema de agendamento arredonda o valor configurado para horas inteiras.	3600
RerunMode	string	A configuração de nova execução do nó. Valores válidos: AllDenied : A nova execução não é permitida independentemente de a instância ser bem-sucedida ou falhar. FailureAllowed : A nova execução é permitida apenas quando a instância falha. AllAllowed : A nova execução é permitida independentemente de a instância ser bem-sucedida ou falhar.	AllAllowed
RunNumber	integer	O número da execução atual. O valor padrão começa em 1.	1
PeriodNumber	integer	O número do período. Indica em qual ciclo de agendamento do dia a instância está.	1
BaselineId	integer	O ID da linha de base.	1234
Priority	integer	A prioridade de execução do nó. Valor mínimo: 1. Valor máximo: 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 o nó.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	O ID da imagem configurada para o nó.	i-xxxxxx
Cu	string	O consumo de unidade de computação (CU) configurado para o nó.	0.25
Runtime	object	As informações de tempo de execução da instância.
ProcessId	string	O ID de execução exclusivo.	T3_123
Gateway	string	A máquina na qual a instância é executada.	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 a chegada de TriggerTime. CheckingCondition: verificando condições de ramificação. WaitResource: aguardando recursos. Failure: a execução falhou. Success: a execução foi bem-sucedida. Checking: enviado para verificação de qualidade de dados. WaitTrigger: aguardando um gatilho externo. Nós baseados em gatilho entram neste status após o tempo de espera decorrer.	Success
TriggerTime	integer	O horário de acionamento agendado. O valor é um número de 13 dígitos, como 1710239005403.	1710239005403
Bizdate	integer	A data de negócios. O valor é um número de 13 dígitos, como 1710239005403.	1710239005403
StartedTime	integer	A hora em que a instância começou a ser executada. O valor é um número de 13 dígitos, como 1710239005403.	1710239005403
FinishedTime	integer	A hora em que a instância terminou a execução. O valor é um número 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 `deprecated`	string	[Deprecated] O ambiente do projeto. Este campo está descontinuado. Use EnvType em seu lugar.	Prod
EnvType	string	O ambiente da fonte de dados de destino. Valores válidos: Dev: ambiente de desenvolvimento. Prod: ambiente de produção.	Prod
Owner	string	O ID da conta do proprietário do nó.	100
CreateTime	integer	A hora de criação. O valor é um número de 13 dígitos, como 1710239005403.	1710239005403
ModifyTime	integer	A hora da modificaçã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 instância.	1000
ModifyUser	string	O ID da conta do usuário que modificou a instância pela última vez.	1000
DownstreamTaskInstances	array<object>	A lista de instâncias de tarefa downstream.
	array<object>
DependencyType	string	O tipo de dependência. Valores válidos: Normal: dependência dentro do mesmo ciclo de agendamento. CrossCycle: dependência entre ciclos.	Normal
TaskInstance	object	A instância de tarefa.
TaskId	integer	O ID do nó correspondente.	1234
TaskType	string	O tipo do nó correspondente.	ODPS_SQL
TaskName	string	O nome do nó correspondente.	SQL node
Description	string	A descrição.	test
WorkflowId	integer	O ID do fluxo de trabalho ao qual a instância pertence.	1234
WorkflowName	string	O nome do fluxo de trabalho ao qual a instância 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 acionado. Este parâmetro entra em vigor quando TriggerType é definido como Scheduler. Valores válidos: Pause: pausado. Skip: dry run. Normal: execução normal.	Normal
WorkflowInstanceId	integer	O ID da instância do fluxo de trabalho à qual a instância pertence.	1234
WorkflowInstanceType	string	O tipo da instância do fluxo de trabalho à qual a instância pertence. Valores válidos: Normal: execução agendada. Manual: tarefa manual. SmokeTest: teste. SupplementData: preenchimento de dados. ManualWorkflow: fluxo de trabalho manual.	Normal
Timeout	integer	O período de tempo limite para a execução do nó. Unidade: segundos. Nota: O sistema de agendamento arredonda o valor configurado para horas inteiras.	3600
RerunMode	string	A configuração de nova execução do nó.	AllAllowed
RunNumber	integer	O número da execução atual. O valor padrão começa em 1.	1
PeriodNumber	integer	O número do período. Indica em qual ciclo de agendamento do dia a instância está.	1
BaselineId	integer	O ID da linha de base.	1234
Priority	integer	A prioridade de execução do nó. Valor mínimo: 1. Valor máximo: 8. Um valor maior indica uma prioridade mais alta. Valor padrão: 1.	1
RuntimeResource	object	A configuração do ambiente de execução, como informações do grupo de recursos.
ResourceGroupId	string	O identificador do grupo de recursos de agendamento configurado para o nó.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	O ID da imagem configurada para o nó.	i-xxxxxx
Cu	string	O consumo de unidade de computação (CU) configurado para o nó.	0.25
Runtime	object	As informações de tempo de execução da instância.
ProcessId	string	O ID de execução exclusivo.	T3_123
Gateway	string	A máquina na qual a instância é executada.	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 a chegada de TriggerTime. CheckingCondition: verificando condições de ramificação. WaitResource: aguardando recursos. Failure: a execução falhou. Success: a execução foi bem-sucedida. Checking: enviado para verificação de qualidade de dados. WaitTrigger: aguardando um gatilho externo. Nós baseados em gatilho entram neste status após o tempo de espera decorrer.	Success
TriggerTime	integer	O horário de acionamento agendado. O valor é um número de 13 dígitos, como 1710239005403.	1710239005403
Bizdate	integer	A data de negócios. O valor é um número de 13 dígitos, como 1710239005403.	1710239005403
StartedTime	integer	A hora em que a instância começou a ser executada. O valor é um número de 13 dígitos, como 1710239005403.	1710239005403
FinishedTime	integer	A hora em que a instância terminou a execução. O valor é um número 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
EnvType	string	O ambiente da fonte de dados de destino. Valores válidos: Dev: ambiente de desenvolvimento. Prod: ambiente de produção.	Prod
Owner	string	O ID da conta do proprietário do nó.	1000
CreateTime	integer	A hora de criação. O valor é um número de 13 dígitos, como 1710239005403.	1710239005403
ModifyTime	integer	A hora da modificaçã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 instância.	1000
ModifyUser	string	O ID da conta do usuário que modificou a instância pela última vez.	1000
TotalCount	integer	O número total de registros.	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": [
      {
        "StepType": "Normal",
        "TaskId": 1234,
        "TaskType": "ODPS_SQL",
        "TaskName": "Nó SQL",
        "Description": "teste",
        "WorkflowId": 1234,
        "WorkflowName": "Fluxo de trabalho de teste",
        "TriggerType": "Scheduler",
        "TriggerRecurrence": "Normal",
        "WorkflowInstanceId": 1234,
        "WorkflowInstanceType": "Normal",
        "Timeout": 3600,
        "RerunMode": "AllAllowed",
        "RunNumber": 1,
        "PeriodNumber": 1,
        "BaselineId": 1234,
        "Priority": 1,
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx",
          "Cu": "0.25"
        },
        "Runtime": {
          "ProcessId": "T3_123\n",
          "Gateway": "cn-shanghai.1.2"
        },
        "DataSource": {
          "Name": "mysql_test"
        },
        "Status": "Success",
        "TriggerTime": 1710239005403,
        "Bizdate": 1710239005403,
        "StartedTime": 1710239005403,
        "FinishedTime": 1710239005403,
        "Id": 1234,
        "ProjectId": 100,
        "ProjectEnv": "Prod",
        "EnvType": "Prod",
        "Owner": "100",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000\n",
        "ModifyUser": "1000\n"
      }
    ],
    "DownstreamTaskInstances": [
      {
        "DependencyType": "Normal",
        "TaskInstance": {
          "TaskId": 1234,
          "TaskType": "ODPS_SQL",
          "TaskName": "Nó SQL",
          "Description": "teste",
          "WorkflowId": 1234,
          "WorkflowName": "Fluxo de trabalho de teste",
          "TriggerType": "Scheduler",
          "TriggerRecurrence": "Normal",
          "WorkflowInstanceId": 1234,
          "WorkflowInstanceType": "Normal",
          "Timeout": 3600,
          "RerunMode": "AllAllowed",
          "RunNumber": 1,
          "PeriodNumber": 1,
          "BaselineId": 1234,
          "Priority": 1,
          "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"
          },
          "Status": "Success",
          "TriggerTime": 1710239005403,
          "Bizdate": 1710239005403,
          "StartedTime": 1710239005403,
          "FinishedTime": 1710239005403,
          "Id": 1234,
          "ProjectId": 100,
          "EnvType": "Prod",
          "Owner": "1000",
          "CreateTime": 1710239005403,
          "ModifyTime": 1710239005403,
          "CreateUser": "1000",
          "ModifyUser": "1000"
        }
      }
    ],
    "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.