すべてのプロダクト
Search

このプロダクト

    Platform For AI:ListPipelineRuns

    ドキュメントセンター

    Platform For AI:ListPipelineRuns

    最終更新日:Dec 23, 2025

    パイプラインジョブのリストを照会します。この API 操作では、フィルター、ソート、ページネーションがサポートされています。

    今すぐお試しください

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

    list

    *All Resource

    *

    		 なし なし

    リクエスト構文

    GET /api/v1/pipelineruns HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    任意

    ページ番号。ページは 1 から始まります。デフォルト値：1。

    1
    PageSize

    integer

    任意

    ページあたりのエントリ数。デフォルト値：10。

    10
    SourceId

    string

    任意

    パイプラインジョブソースの ID。パイプラインジョブソースの ID は、パイプライン詳細ページで確認できます。詳細については、「パイプラインの管理」をご参照ください。

    ybpy**********fb2z

    Name

    string

    任意

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

    testName
    Order

    string

    任意

    ソート順。このパラメーターは SortBy パラメーターと一緒に指定する必要があります。有効な値：

    • ASC：昇順。

    • DESC：降順。これはデフォルト値です。

    DESC
    SourceType

    string

    任意

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

    • UNKNOWN：このパラメーターを指定しない場合、UNKNOWN がデフォルト値として使用されます。

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

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

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

    UNKNOWN
    Status

    string

    任意

    フィルターするパイプラインジョブのステータス。有効な値：

    • Initialized

    • Running

    • Succeeded

    • Failed

    • Terminated

    • Unknown

    • Skipped

    • Terminating

    Succeeded
    WorkspaceId

    string

    任意

    ワークスペース ID。ListWorkspaces を呼び出してワークスペース ID を取得できます。

    104623
    UserId

    string

    任意

    ユーザー ID。

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

    PipelineIds

    string

    任意

    パイプラインの ID。複数のパイプライン ID はコンマ (,) で区切ります。ListPipelines を呼び出してパイプラインの ID を取得できます。

    flow-rer7**********0otv, flow-hynm**********sfef
    SortBy

    string

    任意

    ソート用のフィールド。有効な値：

    • PipelineId

    • UserId

    • ParentUserId

    • StartedAt

    • FinishedAt

    • WorkflowServiceId

    • Duration

    • GmtCreateTime

    • GmtModifiedTime

    PipelineId
    PipelineRunId

    string

    任意

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

    flow-14vioac3k1s07k****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されたデータ。

    RequestId

    string

    リクエスト ID。

    473469C7-****-****-****-A3DC0DE3C83E
    TotalCount

    integer

    返されたパイプラインジョブの総数。

    15
    PipelineRuns

    array<object>

    照会されたパイプラインジョブ。

    object

    パイプラインジョブの詳細。

    PipelineRunId

    string

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

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

    Name

    string

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

    testName

    Status

    string

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

    • Initialized

    • Running

    • Succeeded

    • Failed

    • Suspended

    • Terminated

    • Unknown

    • Skipped

    • Terminating

    Succeeded
    UserId

    string

    ユーザー ID。

    155**********904
    ParentUserId

    string

    ユーザーのプライマリアカウントの 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

    • SDK

    • DESIGNER

    • M6

    UNKNOWN
    SourceId

    string

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

    abcd*********hxfu

    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": "473469C7-****-****-****-A3DC0DE3C83E",
  "TotalCount": 15,
  "PipelineRuns": [
    {
      "PipelineRunId": "flow-j94y**********lf7a\n",
      "Name": "testName\n",
      "Status": "Succeeded",
      "UserId": "155**********904",
      "ParentUserId": "155**********904",
      "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",
      "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****"
    }
  ]
}

    エラーコード

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

    変更履歴

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