すべてのプロダクト
Search

このプロダクト

    DataWorks:GetPipelineRun

    ドキュメントセンター

    DataWorks:GetPipelineRun

    最終更新日:Sep 03, 2026

    Deployment プロセスの詳細を取得します。

    操作説明

    重要 この操作は、古いバージョンの SDK では利用できない場合があります。その場合は、代わりに GetDeployment 操作を使用してください。パラメーターは、このドキュメントで説明されているものと同じです。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dataworks:*

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ProjectId

    integer

    必須

    DataWorks ワークスペースの ID。DataWorks コンソール にログインし、ワークスペース管理ページに移動して ID を取得できます。

    このパラメーターは、この API 呼び出しの対象となる DataWorks ワークスペースを指定します。

    10000
    Id

    string

    必須

    Deployment プロセスの一意の識別子。

    a7ef0634-20ec-4a7c-a214-54020f****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエスト ID。ログの特定および問題のトラブルシューティングに使用されます。

    08468352-032C-5262-AEDC-68C9FA05XXXX
    Pipeline

    object

    Deployment プロセスに関する情報。

    Id

    string

    Deployment プロセスの ID。

    a7ef0634-20ec-4a7c-a214-54020f91XXXX
    ProjectId

    integer

    DataWorks ワークスペースの ID。

    56160
    CreateTime

    integer

    デプロイメントパッケージが作成されたタイムスタンプ。

    1724984066000
    ModifyTime

    integer

    変更時間。

    値は 1724984066000 のような 13 桁の数値です。

    1724984066000
    Creator

    string

    Deployment プロセスの作成者。

    137946317766XXXX
    Status

    string

    Deployment プロセスのステータス。

    有効な値:

    • Init: 初期化。

    • Running: 実行中。

    • Success: 成功。

    • Fail: 失敗。

    • Termination: 終了。

    • Cancel: キャンセル。

    列挙値:

    • Init :

      初期化。

    • Cancel :

      キャンセル。

    • Running :

      実行中。

    • Termination :

      終了。

    • Success :

      成功。

    • Fail :

      失敗。

    Running
    Message

    string

    Deployment が失敗した場合に返されるエラーメッセージ。

    エラーメッセージ
    Stages

    array<object>

    ステージの詳細。

    array<object>

    ステージ要素。

    Code

    string

    ステージを識別するコードです。

    DEV_CHECK
    Step

    integer

    パイプライン内におけるステージのシーケンス番号です。

    1
    Type

    string

    ステージの種類です。

    有効な値：

    • Deploy：デプロイメント操作です。

    • Check：チェック操作です。

    • Offline：オフライン操作です。

    • Build：ビルド操作です。

    • Delete：削除操作です。

    列挙値:

    • Delete :
    • Build :
    • Check :
    • Offline :
    • Deploy :

    Check
    Name

    string

    ステージの名前です。

    Publish package build
    Description

    string

    ステージの説明です。

    Phase description
    Message

    string

    ステージが失敗した場合に返される例外メッセージです。

    Exception information XXX
    Status

    string

    ステージのステータスです。

    有効な値：

    • Init：ステージの初期化中です。

    • Running：ステージ実行中です。

    • Success：ステージが成功しました。

    • Fail：ステージが失敗しました。

    • Terminated：ステージが終了しました。

    • Canceled：ステージがキャンセルされました。

    列挙値:

    • Init :
    • Cancel :
    • Running :
    • Termination :
    • Success :
    • Fail :

    Running
    Detail

    object

    ステージに関する詳細情報です。

    any

    ステージに関する追加情報を提供するキーと値のペアです。

    "checkerList": [ { "code": "BuildPackageChecker", "name": "Build_Package_Checker" }, { "code": "NodeParentDependency", "name": "Downstream_Dependency_Checker" }, { "code": "NodeInProcess", "name": "Decommissioning_Process_Checker" } ]

    Description

    string

    Deployment プロセスの説明。

    Deployment プロセスの説明

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "08468352-032C-5262-AEDC-68C9FA05XXXX",
  "Pipeline": {
    "Id": "a7ef0634-20ec-4a7c-a214-54020f91XXXX\n",
    "ProjectId": 56160,
    "CreateTime": 1724984066000,
    "ModifyTime": 1724984066000,
    "Creator": "137946317766XXXX",
    "Status": "Running",
    "Message": "Error message",
    "Stages": [
      {
        "Code": "DEV_CHECK",
        "Step": 1,
        "Type": "Check",
        "Name": "Publish package build",
        "Description": "Phase description",
        "Message": "Exception information XXX",
        "Status": "Running",
        "Detail": {
          "key": "\"checkerList\": [\n    {\n        \"code\": \"BuildPackageChecker\",\n        \"name\": \"Build_Package_Checker\"\n    },\n    {\n        \"code\": \"NodeParentDependency\",\n        \"name\": \"Downstream_Dependency_Checker\"\n    },\n    {\n        \"code\": \"NodeInProcess\",\n        \"name\": \"Decommissioning_Process_Checker\"\n    }\n]\n"
        }
      }
    ],
    "Description": "发布流程描述信息"
  }
}

    エラーコード

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

    変更履歴

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