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

Consulta uma lista paginada de instâncias ancestrais de uma instância.

Descrição da 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 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 na página 1. Valor padrão: 1.	1

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>	As instâncias. Este parâmetro foi descontinuado e substituído pelo parâmetro UpstreamTaskInstances.
	array<object>
StepType	string	The scheduling dependency type. Valid values: Normal: same-cycle scheduling dependency CrossCycle: cross-cycle scheduling dependency	Normal
TaskId	integer	The ID of the task for which the instance is generated.	1234
TaskType	string	The type of the task for which the instance is generated.	ODPS_SQL
TaskName	string	The name of the task for which the instance is generated.	SQL node
Description	string	The description.	test
WorkflowId	integer	The ID of the workflow to which the instance belongs.	1234
WorkflowName	string	The name of the workflow to which the instance belongs.	Test workflow
TriggerType	string	The trigger type. Valid values: Scheduler: scheduling cycle-based trigger Manual: manual trigger	Scheduler
TriggerRecurrence	string	The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values: Pause Skip Normal	Normal
WorkflowInstanceId	integer	The workflow instance ID.	1234
WorkflowInstanceType	string	The type of the workflow instance. Valid values: SmokeTest SupplementData Manual ManualWorkflow Normal ManualFlow	Normal
Timeout	integer	The timeout period of task running. Unit: seconds.	3600
RerunMode	string	The rerun mode. Valid values: AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run. FailureAllowed: The task can be rerun only after it fails to run. AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to run.	AllAllowed
RunNumber	integer	The number of times the instance is run. By default, the value starts from 1.	1
PeriodNumber	integer	The sequence number of the period. Indicates which cycle of the day the task instance is in.	1
BaselineId	integer	The baseline ID.	1234
Priority	integer	The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.	1
RuntimeResource	object	The configurations of the runtime environment, such as the resource group information.
ResourceGroupId	string	The ID of the resource group for scheduling configured for task running.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	The ID of the image configured for task running.	i-xxxxxx
Cu	string	The default number of compute units (CUs) configured for task running.	0.25
Runtime	object	The runtime information about the instance.
ProcessId	string	The instance run ID.	T3_123
Gateway	string	The host for running.	cn-shanghai.1.2
DataSource	object	The information about the associated data source.
Name	string	The name of the data source.	mysql_test
Status	string	The status of the instance. Valid values: NotRun: The instance is not run. Running: The instance is running. WaitTime: The instance is waiting for the scheduling time to arrive. CheckingCondition: Branch conditions are being checked for the instance. WaitResource: The instance is waiting for resources. Failure: The instance fails to be run. Success: The instance is successfully run. Checking: Data quality is being checked for the instance.	Success
TriggerTime	integer	The scheduling time.	1710239005403
Bizdate	integer	The data timestamp.	1710239005403
StartedTime	integer	The time when the instance started to run.	1710239005403
FinishedTime	integer	The time when the instance finished running.	1710239005403
Id	integer	The instance ID.	1234
ProjectId	integer	The workspace ID.	100
ProjectEnv `deprecated`	string	The environment of the workspace. Valid values: Prod: production environment Dev: development environment	Prod
EnvType	string	The environment of the workspace. Valid values: Prod Dev	Prod
Owner	string	The account ID of the task owner.	1000
CreateTime	integer	The creation time.	1710239005403
ModifyTime	integer	The modification time.	1710239005403
CreateUser	string	The account ID of the creator.	1000
ModifyUser	string	The account ID of the modifier.	1000
UpstreamTaskInstances	array<object>	As instâncias ancestrais.
	array<object>
DependencyType	string	The scheduling dependency type. Valid values: Normal CrossCycle	Normal
TaskInstance	object	The information about a task instance.
TaskId	integer	The ID of the task for which the instance is generated.	1234
TaskType	string	The type of the task for which the instance is generated.	ODPS_SQL
TaskName	string	The name of the task for which the instance is generated.	SQL node
Description	string	The description.	test
WorkflowId	integer	The ID of the workflow to which the instance belongs.	1234
WorkflowName	string	The name of the workflow to which the instance belongs.	Test workflow
TriggerType	string	The trigger type. Valid values: Scheduler: scheduling cycle-based trigger Manual: manual trigger	Scheduler
TriggerRecurrence	string	The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values: Pause Skip Normal	Normal
WorkflowInstanceId	integer	The workflow instance ID.	1234
WorkflowInstanceType	string	The type of the workflow instance. Valid values: Normal Manual SmokeTest SupplementData ManualWorkflow	Normal
Timeout	integer	The timeout period of task running. Unit: seconds. Note: The value of this parameter is rounded up by hour.	3600
RerunMode	string	The rerun mode.	AllAllowed
RunNumber	integer	The number of times the instance is run. By default, the value starts from 1.	1
PeriodNumber	integer	The sequence number of the cycle. This parameter indicates the cycle of the task instance on the current day.	1
BaselineId	integer	The baseline ID.	1234
Priority	integer	The priority of the task. Minimum value: 1. Maximum value: 8. A larger value indicates a higher priority. Default value: 1.	1
RuntimeResource	object	The configurations of the runtime environment, such as the resource group information.
ResourceGroupId	string	The ID of the resource group for scheduling configured for task running.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	The ID of the image configured for task running.	i-xxxxxx
Cu	string	The default number of compute units (CUs) configured for task running.	0.25
Runtime	object	The runtime information about the instance.
ProcessId	string	The instance run ID.	T3_123
Gateway	string	The host for running.	cn-shanghai.1.2
DataSource	object	The information about the associated data source.
Name	string	The name of the data source.	mysql_test
Status	string	The status of the instance. Valid values: NotRun: The instance is not run. Running: The instance is running. WaitTime: The instance is waiting for the scheduling time to arrive. CheckingCondition: Branch conditions are being checked for the instance. WaitResource: The instance is waiting for resources. Failure: The instance fails to be run. Success: The instance is successfully run. Checking: Data quality is being checked for the instance. WaitTrigger: The instance is waiting to be triggered by external scheduling systems.	Success
TriggerTime	integer	The scheduling time.	1710239005403
Bizdate	integer	The data timestamp.	1710239005403
StartedTime	integer	The time when the instance started to run.	1710239005403
FinishedTime	integer	The time when the instance finished running.	1710239005403
Id	integer	The instance ID.	1234
ProjectId	integer	The workspace ID.	100
EnvType	string	The environment in which the data source is used. Valid values: Dev Prod	Prod
Owner	string	The account ID of the task owner.	1000
CreateTime	integer	The creation time.	1710239005403
ModifyTime	integer	The modification time.	1710239005403
CreateUser	string	The account ID of the creator.	1000
ModifyUser	string	The account ID of the modifier.	1000
TotalCount	integer	O número total de entradas retornadas.	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\n",
  "PagingInfo": {
    "TaskInstances": [
      {
        "StepType": "Normal",
        "TaskId": 1234,
        "TaskType": "ODPS_SQL\n",
        "TaskName": "SQL node\n",
        "Description": "test",
        "WorkflowId": 1234,
        "WorkflowName": "Test workflow",
        "TriggerType": "Scheduler",
        "TriggerRecurrence": "Normal\n",
        "WorkflowInstanceId": 1234,
        "WorkflowInstanceType": "Normal\n",
        "Timeout": 3600,
        "RerunMode": "AllAllowed\n",
        "RunNumber": 1,
        "PeriodNumber": 1,
        "BaselineId": 1234,
        "Priority": 1,
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX\n",
          "Image": "i-xxxxxx\n",
          "Cu": "0.25"
        },
        "Runtime": {
          "ProcessId": "T3_123",
          "Gateway": "cn-shanghai.1.2"
        },
        "DataSource": {
          "Name": "mysql_test"
        },
        "Status": "Success\n",
        "TriggerTime": 1710239005403,
        "Bizdate": 1710239005403,
        "StartedTime": 1710239005403,
        "FinishedTime": 1710239005403,
        "Id": 1234,
        "ProjectId": 100,
        "ProjectEnv": "Prod\n",
        "EnvType": "Prod",
        "Owner": "1000",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000"
      }
    ],
    "UpstreamTaskInstances": [
      {
        "DependencyType": "Normal",
        "TaskInstance": {
          "TaskId": 1234,
          "TaskType": "ODPS_SQL",
          "TaskName": "SQL node",
          "Description": "test",
          "WorkflowId": 1234,
          "WorkflowName": "Test workflow",
          "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.