GetPipelineRunNode - - Centre de documentation Alibaba Cloud

Consulte les informations d'un nœud. Un travail de pipeline contient différents types de nœuds.

Description de l'opération

PAIFlow prend en charge les pipelines composites, qui se manifestent sous forme de nœuds composites lors de l'exécution. Pour obtenir des informations sur ces nœuds, vous pouvez configurer le paramètre Depth (valeur par défaut : 2). Vous pouvez configurer le paramètre Depth pour obtenir de manière récursive les informations sur le nœud interrogé et ses nœuds enfants.

Un nœud racine virtuel existe à chaque exécution d'un pipeline. Vous pouvez appeler GetRun pour obtenir le nœud racine. Vous pouvez appeler GetNode pour interroger le nœud racine. Le résultat renvoyé inclut également des informations sur tous les nœuds exécutés et leurs hiérarchies.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

paiflow:GetPipelineRunNode

get

*All Resource

*

Aucune

Syntaxe de la requête

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

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
PipelineRunId	string	Oui	L'identifiant du travail de pipeline. Vous pouvez appeler ListPipelineRuns pour obtenir l'identifiant du travail de pipeline.	flow-ebppc********5lwea
NodeId	string	Oui	L'identifiant d'un nœud dans le travail de pipeline. Vous pouvez appeler ListPipelineRuns pour obtenir l'identifiant du nœud.	node-wcs9z********27ps3

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Depth	integer	Non	La profondeur à laquelle les informations sur le nœud sont interrogées. Si vous définissez Depth sur 2, les informations sur le nœud et tous ses nœuds enfants au niveau suivant sont renvoyées.	2
Type	string	Non	Le type de nœud. Valeurs valides : Logical (par défaut) : le nœud logique. Les nœuds soumis par les utilisateurs sont des nœuds logiques. Physical : le nœud physique sur lequel un conteneur est déployé pour exécuter une logique spécifique. Un nœud logique est converti en nœud physique lorsque le nœud logique s'exécute en arrière-plan.	Logical
TokenId	string	Non	L'identifiant du travail de pipeline partagé.	https://pai.console.alibabacloud.com/?regionId=cn-hangzhou&workspaceId=102****&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7**?Token=eyJ0e****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
RequestId	string	L'identifiant de la requête.	0a981ea816**********42244e7ba2
ApiVersion	string	La version définie dans le pipeline.	core/v1
Metadata	object	Les métadonnées du nœud.
NodeId	string	L'identifiant du nœud.	node-wcs9z********27ps3
Provider	string	Le fournisseur du pipeline pour le nœud. Dans la plupart des cas, ce paramètre indique le téléchargeur du pipeline. Si le pipeline est fourni officiellement, la valeur du paramètre est PAI.	15577********904
Name	string	Le nom du nœud.	flow-ebppc********5lwea
Version	string	La version du pipeline pour le nœud.	v1
Identifier	string	L'identificateur du pipeline pour le nœud.	composite-pipeline
NodeType	string	Le type de nœud. Valeurs valides : Pod : le nœud spécifique qui s'exécute. Dag : le nœud composite, qui est essentiellement un graphe acyclique orienté (DAG) composé de nœuds enfants.	Dag
RelatedNodeIds	array	L'identifiant du nœud physique correspondant au nœud logique Alink ou l'identifiant du nœud logique correspondant au nœud physique Alink.
	string	L'identifiant du nœud.	node-wcs9z********27ps3
DisplayName	string	Le nom d'affichage du nœud, qui peut être modifié.	flow-ebppc********5lwea
Spec	object	Les spécifications du nœud.
HasPipelines	boolean	Indique si le nœud contient des nœuds enfants. Valeurs valides : true : le nœud est un nœud composite. Pour interroger les informations sur ses nœuds enfants, vous devez spécifier le paramètre Depth. false : le nœud est celui qui s'exécute réellement.	true
Dependencies	array	Les dépendances entre le nœud et les autres nœuds.
	string	Le nom du pipeline pour les autres nœuds dont dépend le nœud.	"single-node-sub1"
Pipelines	array<object>	Les nœuds enfants.	For the detailed structure, see the description of Pipeline-related API operations.
	object	Le nœud enfant.	Pour plus de détails sur la structure, consultez la description des API associées aux pipelines
Inputs	object	Les informations d'entrée du nœud.
Artifacts	array<object>	The node inputs.
	object	The node input.	{"Name":"input","Value":"******"}
Parameters	array<object>	The input parameters of the node.
	object	The input parameter of the node.	{"Name":"inputTable","Value":"******"}
Outputs	object	Les informations de sortie du nœud.
Artifacts	array<object>	The node outputs.
	object	The node output.	{"Name":"output","Value":"******"}
Parameters	array<object>	The output parameters of the node.
	object	The output parameter of the node.	{"Name":"outputTable","Value":"******"}
When	string	La condition selon laquelle le nœud s'exécute. Si true est renvoyé, le nœud est exécuté. Si false est renvoyé, le nœud est ignoré et l'état du nœud devient Skipped.	”{{inputs.parameters.skip}} == false“
WithItems	array	Développe un nœud de pipeline en plusieurs nœuds de pipeline.
	string	Développe un élément du jeu de données en un nœud de pipeline.	abc
WithParam	string	Développe chaque élément d'un tableau, qui est le type de valeur d'un paramètre, en un nœud de pipeline.	"{{pipelines.generate.outputs.result}}"
WithSequence	object	Développe chaque élément d'une séquence numérique en un nœud de pipeline.
Start	integer	The start number of the numerical sequence.	1
End	integer	The end number of the numerical sequence.	10
Format	string	Formats the value of the numerical sequence.	"2020-05-%d"
Parallelism	integer	Le parallélisme maximal des nœuds.	2
StatusInfo	object	L'état d'exécution du nœud.
FinishedAt	string	L'heure à laquelle le nœud a terminé son exécution.	2021-10-15T10:40:54.000Z
StartedAt	string	L'heure à laquelle le nœud a commencé à s'exécuter.	2021-10-15T10:39:58.000Z
Status	string	L'état d'exécution du nœud. Valeurs valides : Succeeded Running Failed Skipped : l'état du nœud devient Skipped lorsque son nœud en amont ne parvient pas à s'exécuter. ReadyToSchedule : l'état du nœud devient ReadyToSchedule si son nœud en amont est en cours d'exécution. Unknown	Succeeded
Conditions	array<object>	Les conditions d'exécution du nœud.
	object	La condition d'exécution du nœud.	{"ArtifactArchived": "true"}
Progress	string	La progression de l'exécution du nœud.	9/9

Exemples

JSON format

{
  "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"
  }
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.