すべてのプロダクト
Search

このプロダクト

    Platform For AI:GetPipelineRunNode

    ドキュメントセンター

    Platform For AI:GetPipelineRunNode

    最終更新日:Dec 23, 2025

    ノードに関する情報を照会します。パイプラインジョブには、さまざまなノードが含まれています。

    操作説明

    PAIFlow は複合パイプラインをサポートしており、実行時には複合ノードとして反映されます。このようなノードの情報を取得するには、`Depth` パラメーター (デフォルト値：2) を設定します。`Depth` パラメーターを設定すると、照会対象のノードとその子ノードの情報を再帰的に取得できます。

    パイプラインが実行されるたびに、仮想ルートノードが存在します。`GetRun` を呼び出してルートノードを取得できます。`GetNode` を呼び出してルートノードを照会することもできます。返される結果には、実行されるすべてのノードとその階層に関する情報も含まれます。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    paiflow:GetPipelineRunNode

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PipelineRunId

    string

    必須

    パイプラインジョブの ID。ListPipelineRuns を呼び出してパイプラインジョブの ID を取得できます。

    flow-ebppc********5lwea
    NodeId

    string

    必須

    パイプラインジョブ内のノードの ID。ListPipelineRuns を呼び出してノード ID を取得できます。

    node-wcs9z********27ps3

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Depth

    integer

    任意

    ノードの情報を照会する深さ。`Depth` を 2 に設定すると、ノードとその次のレイヤーのすべての子ノードに関する情報が返されます。

    2
    Type

    string

    任意

    ノードタイプ。有効な値：

    • `Logical` (デフォルト)：論理ノード。ユーザーが送信したノードは論理ノードです。

    • `Physical`：特定のロジックを実行するためにコンテナーがデプロイされる物理ノード。論理ノードは、バックグラウンドで実行されるときに物理ノードに変換されます。

    Logical
    TokenId

    string

    任意

    共有パイプラインジョブの ID。

    https://pai.console.alibabacloud.com/?regionId=cn-hangzhou&workspaceId=102******&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7******?Token=eyJ0e******

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    RequestId

    string

    リクエスト ID。

    0a981ea816**********42244e7ba2
    ApiVersion

    string

    パイプラインで定義されたバージョン。

    core/v1
    Metadata

    object

    ノードのメタデータ。

    NodeId

    string

    ノード ID。

    node-wcs9z********27ps3
    Provider

    string

    ノードのパイプラインのプロバイダー。ほとんどの場合、このパラメーターはパイプラインのアップローダーを示します。パイプラインが公式に提供されている場合、パラメーター値は PAI です。

    15577********904
    Name

    string

    ノード名。

    flow-ebppc********5lwea
    Version

    string

    ノードのパイプラインのバージョン。

    v1
    Identifier

    string

    ノードのパイプラインの識別子。

    composite-pipeline
    NodeType

    string

    ノードタイプ。有効な値：

    • `Pod`：実行される特定のノード。

    • `Dag`：複合ノード。本質的には子ノードで構成される有向非巡回グラフ (DAG) です。

    Dag
    RelatedNodeIds

    array

    Alink 論理ノードに対応する物理ノードの ID、または Alink 物理ノードに対応する論理ノードの ID。

    string

    ノード ID。

    node-wcs9z********27ps3
    DisplayName

    string

    ノードの表示名。変更可能です。

    flow-ebppc********5lwea
    Spec

    object

    ノードの仕様。

    HasPipelines

    boolean

    ノードに子ノードが含まれているかどうかを示します。有効な値：

    • `true`：ノードは複合ノードです。その子ノードの情報を照会するには、`Depth` パラメーターを指定する必要があります。

    • `false`：ノードは実際に実行されるノードです。

    true
    Dependencies

    array

    ノードと他のノード間の依存関係。

    string

    ノードが依存する他のノードのパイプラインの名前。

    "single-node-sub1"
    Pipelines

    array<object>

    子ノード。

    object

    子ノード。

    详细结构参见Pipeline相关接口描述。

    Inputs

    object

    ノードの入力情報。

    Artifacts

    array<object>

    ノードの入力。

    object

    ノードの入力。

    {"Name":"input","Value":"******"}
    Parameters

    array<object>

    ノードの入力パラメーター。

    object

    ノードの入力パラメーター。

    {"Name":"inputTable","Value":"******"}
    Outputs

    object

    ノードの出力情報。

    Artifacts

    array<object>

    ノードの出力。

    object

    ノードの出力。

    {"Name":"output","Value":"******"}
    Parameters

    array<object>

    ノードの出力パラメーター。

    object

    ノードの出力パラメーター。

    {"Name":"outputTable","Value":"******"}
    When

    string

    ノードが実行される条件。

    • `true` が返された場合、ノードは実行されます。

    • `false` が返された場合、ノードはスキップされ、ノードのステータスは `Skipped` になります。

    ”{{inputs.parameters.skip}} == false“
    WithItems

    array

    1 つのパイプラインノードを複数のパイプラインノードに展開します。

    string

    データセット内の項目をパイプラインノードに展開します。

    abc
    WithParam

    string

    パラメーターの値の型が配列である場合、その各項目をパイプラインノードに展開します。

    "{{pipelines.generate.outputs.result}}"
    WithSequence

    object

    数値シーケンスの各項目をパイプラインノードに展開します。

    Start

    integer

    数値シーケンスの開始番号。

    1
    End

    integer

    数値シーケンスの終了番号。

    10
    Format

    string

    数値シーケンスの値をフォーマットします。

    "2020-05-%d"
    Parallelism

    integer

    ノードの最大並列処理数。

    2
    StatusInfo

    object

    ノードの実行ステータス。

    FinishedAt

    string

    ノードの実行が終了した時間。

    2021-10-15T10:40:54.000Z
    StartedAt

    string

    ノードの実行が開始された時間。

    2021-10-15T10:39:58.000Z
    Status

    string

    ノードの実行ステータス。有効な値：

    • Succeeded

    • Running

    • Failed

    • `Skipped`：上流ノードの実行に失敗した場合、ノードのステータスは `Skipped` になります。

    • `ReadyToSchedule`：上流ノードが実行中の場合、ノードのステータスは `ReadyToSchedule` になります。

    • Unknown

    Succeeded
    Conditions

    array<object>

    ノードの実行条件。

    object

    ノードの実行条件。

    {"ArtifactArchived": "true"}
    Progress

    string

    ノードの実行進捗。

    9/9

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。