GetPipelineRunNode - Platform For AI: Central de Documentação do Alibaba Cloud

Obtém os detalhes de um nó específico em uma tarefa de workflow.

Descrição da operação

O PAIFlow suporta workflows compostos, que são representados como nós compostos em tempo de execução. Para obter os detalhes desses nós, você pode passar o parâmetro Depth (valor padrão: 2) para obter os detalhes do nó consultado e de seus nós filhos até a profundidade especificada por meio de recursão.

Cada execução de workflow possui um nó raiz virtual, que pode ser obtido a partir da resposta da operação GetRun. Você pode invocar a operação GetNode para consultar esse nó raiz e obter os detalhes e a estrutura de todos os nós na execução correspondente.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Sintaxe da solicitação

GET /api/v1/pipelineruns/{PipelineRunId}/nodes/{NodeId} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PipelineRunId	string	Sim	O ID da tarefa de workflow. Para mais informações sobre como obter o ID da tarefa de workflow, consulte ListPipelineRuns.	flow-ebppc********5lwea
NodeId	string	Sim	O ID de um nó na tarefa de workflow. Para mais informações sobre como visualizar o ID do nó, consulte ListPipelineRuns.	node-wcs9z********27ps3

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Depth	integer	Não	A profundidade (número de níveis) para consultar os detalhes do nó. Se Depth estiver definido como 2, os detalhes do nó e de todos os seus nós filhos no próximo nível serão retornados.	2
Type	string	Não	O tipo de nó. Valores válidos: Logical: nó lógico. Este é o valor padrão. Todos os nós enviados pelos usuários são nós lógicos. Physical: nó físico. Isso corresponde à execução de um contêiner que realiza uma lógica específica. Os nós lógicos são convertidos em nós físicos quando executados em segundo plano.	Logical
TokenId	string	Não	O ID da tarefa de workflow compartilhada.	https://pai.console.alibabacloud.com/?regionId=cn-hangzhou&workspaceId=102****&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7**?Token=eyJ0e****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura do corpo da resposta.
RequestId	string	O ID da solicitação.	0a981ea816**********42244e7ba2
ApiVersion	string	A versão da definição do workflow.	core/v1
Metadata	object	Os metadados do nó.
NodeId	string	O ID do nó.	node-wcs9z********27ps3
Provider	string	O provedor do workflow ao qual o nó pertence. Na maioria dos casos, isso se refere ao carregador do workflow. O provedor dos workflows oficiais é o PAI.	15577********904
Name	string	O nome do nó.	flow-ebppc********5lwea
Version	string	A versão do workflow ao qual o nó pertence.	v1
Identifier	string	O identificador do workflow ao qual o nó pertence.	composite-pipeline
NodeType	string	O tipo do nó. Valores válidos: Pod: um nó específico em execução. Dag: um nó composto, que é essencialmente um grafo acíclico direcionado (DAG) composto por nós filhos.	Dag
RelatedNodeIds	array	O ID do nó físico correspondente a um nó lógico Alink, ou o ID do nó lógico correspondente a um nó físico Alink.
	string	O ID do nó.	node-wcs9z********27ps3
DisplayName	string	O nome de exibição do nó. Este nome pode ser modificado.	flow-ebppc********5lwea
Spec	object	A definição do nó.
HasPipelines	boolean	Indica se o nó contém nós filhos. Valores válidos: true: O nó é um nó composto. Para consultar as informações de seus nós filhos, você deve passar um valor maior para o parâmetro Depth. false: O nó é um nó real em execução.	true
Dependencies	array	As dependências entre o nó e outros nós.
	string	O nome do workflow ao qual um nó dependente pertence.	"single-node-sub1"
Pipelines	array<object>	A lista de nós filhos.	For the detailed structure, see the description of Pipeline-related API operations.
	object	Os detalhes de um nó filho.	For the detailed structure, see the description of pipeline-related operations
Inputs	object	As informações de entrada do nó.
Artifacts	array<object>	A lista de artefatos de entrada para o nó.
	object	Um artefato de entrada para o nó.	{"Name":"input","Value":"******"}
Parameters	array<object>	A lista de parâmetros de entrada para o nó.
	object	Um parâmetro de entrada para o nó.	{"Name":"inputTable","Value":"******"}
Outputs	object	As informações de saída do nó.
Artifacts	array<object>	A lista de artefatos de saída para o nó.
	object	Um artefato de saída para o nó.	{"Name":"output","Value":"******"}
Parameters	array<object>	A lista de parâmetros de saída para o nó.
	object	Um parâmetro de saída para o nó.	{"Name":"outputTable","Value":"******"}
When	string	A condição para executar o nó. Se a condição for avaliada como verdadeira, o nó será executado. Se a condição for avaliada como falsa, o nó será ignorado e seu status será definido como Skipped.	”{{inputs.parameters.skip}} == false“
WithItems	array	Expande o nó do workflow em vários nós do workflow.
	string	Um item no conjunto de dados, que é expandido em um nó do workflow.	abc
WithParam	string	Aponta para um parâmetro cujo valor é uma matriz. Cada item na matriz é expandido em um nó do workflow.	"{{pipelines.generate.outputs.result}}"
WithSequence	object	Aponta para uma sequência numérica. Cada item na sequência é expandido em um nó do workflow.
Start	integer	O número inicial da sequência numérica.	1
End	integer	O número final da sequência numérica.	10
Format	string	O formato para os valores na sequência numérica.	"2020-05-%d"
Parallelism	integer	O paralelismo máximo do nó.	2
StatusInfo	object	As informações de status de execução do nó.
FinishedAt	string	A hora de término da execução do nó.	2021-10-15T10:40:54.000Z
StartedAt	string	A hora de início da execução do nó.	2021-10-15T10:39:58.000Z
Status	string	O status de execução do nó. Valores válidos: Succeeded: O nó foi executado com êxito. Running: O nó está em execução. Failed: O nó falhou ao executar. Skipped: O nó foi ignorado porque um nó anterior falhou. ReadyToSchedule: O nó está pronto para executar, mas está aguardando porque um nó anterior não terminou. Unknown: O status é desconhecido.	Succeeded
Conditions	array<object>	A lista de condições para o nó.
	object	Uma condição detalhada do nó.	{"ArtifactArchived": "true"}
Progress	string	O progresso de execução do nó.	9/9

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0a981ea816**********42244e7ba2",
  "ApiVersion": "core/v1",
  "Metadata": {
    "NodeId": "node-wcs9z********27ps3",
    "Provider": "15577********904",
    "Name": "flow-ebppc********5lwea",
    "Version": "v1",
    "Identifier": "composite-pipeline",
    "NodeType": "Dag",
    "RelatedNodeIds": [
      "node-wcs9z********27ps3"
    ],
    "DisplayName": "flow-ebppc********5lwea"
  },
  "Spec": {
    "HasPipelines": true,
    "Dependencies": [
      "\"single-node-sub1\""
    ],
    "Pipelines": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "Inputs": {
      "Artifacts": [
        {
          "Name": "input",
          "Value": "******"
        }
      ],
      "Parameters": [
        {
          "Name": "inputTable",
          "Value": "******"
        }
      ]
    },
    "Outputs": {
      "Artifacts": [
        {
          "Name": "output",
          "Value": "******"
        }
      ],
      "Parameters": [
        {
          "Name": "outputTable",
          "Value": "******"
        }
      ]
    },
    "When": "”{{inputs.parameters.skip}} == false“",
    "WithItems": [
      "abc"
    ],
    "WithParam": "\"{{pipelines.generate.outputs.result}}\"",
    "WithSequence": {
      "Start": 1,
      "End": 10,
      "Format": "\"2020-05-%d\""
    },
    "Parallelism": 2
  },
  "StatusInfo": {
    "FinishedAt": "2021-10-15T10:40:54.000Z",
    "StartedAt": "2021-10-15T10:39:58.000Z",
    "Status": "Succeeded",
    "Conditions": [
      {
        "ArtifactArchived": "true"
      }
    ],
    "Progress": "9/9"
  }
}

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.