すべてのプロダクト
Search

このプロダクト

    Platform For AI:GetPipelineRun

    ドキュメントセンター

    Platform For AI:GetPipelineRun

    最終更新日:Dec 23, 2025

    パイプラインジョブの情報を照会します。

    今すぐお試しください

    この 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:GetPipelineRun

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PipelineRunId

    string

    必須

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

    run-rbvg**********ks92

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Verbose

    boolean

    任意

    詳細情報を返すかどうかを指定します。 有効な値：

    • false：詳細情報は返されません。

    • true：Manifest を含む詳細情報が返されます。

    false

    ManifestType

    string

    任意

    返されるマニフェストのタイプ。 有効な値：

    • Raw (デフォルト)：ユーザーが送信した元のマニフェスト。

    • Frozen：各パイプラインの UUID を生成し、パイプラインバージョンをフリーズします。 ノードで定義された 3 つのタプルが変更されないままパイプラインをアップグレードしても、元の UUID が引き続き使用されます。 この場合、このマニフェストに基づいてパイプラインを再実行できます。

    • Rendered：関連情報をパイプラインに注入してレンダリングします。これには、ランタイム環境情報の補完やパイプライン構成の最適化が含まれます。

    • Expanded：各パイプラインの完全な定義を提供します。

    • Runtime：実行されるパイプライン。

    列挙値:

    • Runtime :

      Runtime

    • Raw :

      Raw

    • Frozen :

      Frozen

    • Rendered :

      Rendered

    • Expanded :

      Expanded

    Raw
    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。

    DA869D1B-035A-43B2-ACC1-C56681BD9FAA

    PipelineRunId

    string

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

    flow-j94y**********lf7a

    Name

    string

    パイプラインジョブの名前。

    testName
    Status

    string

    パイプラインジョブのステータス。 有効な値：

    • Initialized

    • Running

    • Succeeded

    • Failed

    • Suspended

    • Terminated

    • Unknown

    • Skipped

    • Terminating

    Succeeded
    Manifest

    string

    パイプラインジョブの定義。

    {"ApiVersion":"core/v1","Metadata":{"NodeId":"node-n06d**********fc53","Provider":"155**********904","Name":"flow-j94y**********lf7a","Version":"v1","Identifier":"9fe11111-****-****-****-****ec811861","Namespace":null,"DisplayName":"name","NodeType":"Dag"},"Spec":{}}
    Arguments

    string

    パイプラインジョブのパラメーター。

    {"arguments":{"parameters":[{"name":"execution","value":{"endpoint":"http://service.******","odpsProject":"******","spec":{"endpoint":"http://service.******","odpsProject":"*****"},"resourceType":"MaxCompute"}}]}}
    UserId

    string

    パイプラインの作成に使用される RAM ユーザーの ID。

    155**********904

    ParentUserId

    string

    パイプラインの作成に使用される Alibaba Cloud アカウントの ID。

    155**********904

    StartedAt

    string

    パイプラインジョブの開始時間 (UTC)。 時刻は ISO 8601 標準に準拠します。

    2021-01-30T12:51:33.028Z

    FinishedAt

    string

    パイプラインジョブの終了時間 (UTC)。 時刻は ISO 8601 標準に準拠します。

    2021-01-30T12:52:33.028Z

    NodeId

    string

    パイプライン ID。

    node-n06d**********fc53

    Duration

    integer

    パイプラインジョブの実行時間。 単位：秒。

    60
    WorkspaceId

    string

    パイプラインジョブが属するワークスペースの ID。

    15945
    Message

    string

    パイプラインジョブの失敗メッセージ。

    error message

    SourceType

    string

    パイプラインジョブソースのタイプ。 有効な値：

    • UNKNOWN：このパラメーターを空のままにすると、UNKNOWN がデフォルト値として使用されます。

    • SDK：パイプラインジョブは SDK を使用して作成されます。

    • DESIGNER：パイプラインジョブは Machine Learning Designer で作成されます。

    • M6：パイプラインジョブは他の Web サイトで作成されます。

    UNKNOWN
    SourceId

    string

    パイプラインジョブソースの ID。

    abcd*********hxfu

    Options

    string

    パイプラインジョブのオプション。JSON 形式です。

    {"mlflow":{"experimentId":"exp-**********"}}

    GmtCreateTime

    string

    パイプラインジョブの作成時間 (UTC)。 時刻は ISO 8601 標準に準拠します。

    2021-01-30T12:51:33.028Z

    GmtModifiedTime

    string

    パイプラインジョブの変更時間 (UTC)。 時刻は ISO 8601 標準に準拠します。

    2021-01-30T12:51:33.028Z

    PipelineId

    string

    パイプライン ID。

    pipeline-j94y**********lf7a

    Accessibility

    string

    パイプラインジョブのアクセシビリティ。 有効な値：

    • PUBLIC

    • PRIVATE

    PUBLIC
    PipelineRunUri

    string

    パイプラインジョブの URL。

    https://pai.console.alibabacloud.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "DA869D1B-035A-43B2-ACC1-C56681BD9FAA\n",
  "PipelineRunId": "flow-j94y**********lf7a\n",
  "Name": "testName",
  "Status": "Succeeded",
  "Manifest": "{\"ApiVersion\":\"core/v1\",\"Metadata\":{\"NodeId\":\"node-n06d**********fc53\",\"Provider\":\"155**********904\",\"Name\":\"flow-j94y**********lf7a\",\"Version\":\"v1\",\"Identifier\":\"9fe11111-****-****-****-****ec811861\",\"Namespace\":null,\"DisplayName\":\"name\",\"NodeType\":\"Dag\"},\"Spec\":{}}",
  "Arguments": "{\"arguments\":{\"parameters\":[{\"name\":\"execution\",\"value\":{\"endpoint\":\"http://service.******\",\"odpsProject\":\"******\",\"spec\":{\"endpoint\":\"http://service.******\",\"odpsProject\":\"*****\"},\"resourceType\":\"MaxCompute\"}}]}}",
  "UserId": "155**********904\n",
  "ParentUserId": "155**********904\n",
  "StartedAt": "2021-01-30T12:51:33.028Z\n",
  "FinishedAt": "2021-01-30T12:52:33.028Z\n",
  "NodeId": "node-n06d**********fc53\n",
  "Duration": 60,
  "WorkspaceId": "15945",
  "Message": "error message\n",
  "SourceType": "UNKNOWN",
  "SourceId": "abcd*********hxfu\n",
  "Options": "{\"mlflow\":{\"experimentId\":\"exp-**********\"}}\n",
  "GmtCreateTime": "2021-01-30T12:51:33.028Z\n",
  "GmtModifiedTime": "2021-01-30T12:51:33.028Z\n",
  "PipelineId": "pipeline-j94y**********lf7a\n",
  "Accessibility": "PUBLIC",
  "PipelineRunUri": "https://pai.console.alibabacloud.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****"
}

    エラーコード

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

    変更履歴

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