すべてのプロダクト
Search

このプロダクト

    DataWorks:GetDeployment

    ドキュメントセンター

    DataWorks:GetDeployment

    最終更新日:Mar 21, 2026

    デプロイメントパッケージの情報を照会します。

    今すぐお試しください

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

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ProjectId

    integer

    任意

    DataWorks ワークスペースの ID です。DataStudio ページの右上隅にある [ワークスペース管理] アイコンをクリックして、ワークスペース管理ページに移動し、ワークスペース ID を確認できます。

    10000
    ProjectIdentifier

    string

    任意

    DataWorks ワークスペースの GUID です。GUID は DataStudio ページの上部に表示されます。また、別の GUID を選択することで、他のワークスペースに切り替えることができます。

    このパラメーターまたは ProjectId パラメーターのいずれかを指定して、操作対象の DataWorks ワークスペースを特定する必要があります。

    dw_project
    DeploymentId

    integer

    必須

    デプロイメントタスクの ID です。デプロイメントタスク ID は、SubmitFile 操作または DeployFile 操作を呼び出した際に生成されます。

    3000001

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答データです。

    HttpStatusCode

    integer

    HTTP ステータスコードです。

    200
    ErrorMessage

    string

    エラーメッセージです。

    The connection does not exist.
    RequestId

    string

    リクエスト ID です。この ID を使用してエラーのトラブルシューティングを行えます。

    0000-ABCD-EFG****
    ErrorCode

    string

    エラーコードです。

    Invalid.Tenant.ConnectionNotExists
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    Data

    object

    デプロイメントパッケージの詳細です。

    Deployment

    object

    デプロイメントパッケージの詳細です。

    Status

    integer

    デプロイメントタスクのステータスです。有効な値は 0、1、2 です。0 の場合、タスクが準備完了状態であることを示します。1 の場合、タスクが正常に完了したことを示します。2 の場合、タスクが失敗したことを示します。

    1
    ErrorMessage

    string

    デプロイメントパッケージの実行に失敗した場合のエラーメッセージです。この場合、Status パラメーターの値は 2 になります。

    Success
    FromEnvironment

    integer

    デプロイメントタスクが実行された環境です。有効な値は 0 および 1 です。0 の場合、オンプレミス環境を示します。1 の場合、開発環境を示します。

    0
    ToEnvironment

    integer

    ファイルがデプロイされた先の環境です。有効な値は 1 および 2 です。1 の場合、開発環境を示します。2 の場合、本番環境を示します。

    1
    CheckingStatus

    integer

    デプロイメントタスク内の 1 つ以上のファイルのチェックステータスです。ToEnvironment パラメーターの値が 1 の場合、Status パラメーターの値が 1 かつ CheckingStatus パラメーターが空の場合にのみ、ファイルを本番環境へデプロイできます。有効な値は以下のとおりです。

    • 7：ファイルのチェックに失敗しました。

    • 8：ファイルのチェック中です。

    7
    CreateTime

    integer

    デプロイメントタスクが作成された時刻です。この値は UNIX タイムスタンプであり、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数を表します。

    1593877765000
    HandlerId

    string

    デプロイメントタスクを実行したユーザーの Alibaba Cloud アカウント ID です。

    2003****
    CreatorId

    string

    デプロイメントタスクを作成したユーザーの Alibaba Cloud アカウント ID です。

    20030****
    ExecuteTime

    integer

    デプロイメントタスクが実行された時刻です。この値は UNIX タイムスタンプであり、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数を表します。

    1593877765000
    Name

    string

    デプロイメントタスクの名前です。この値は、デプロイモジュールの「リリースパッケージ」ページに表示される特定のデプロイメントタスクの名前と同じです。

    ods_user_info_d-2020-07-04_20030****
    DeployedItems

    array<object>

    デプロイ済みの項目です。

    object

    デプロイ済み項目の詳細です。

    FileId

    integer

    ファイル ID です。

    5076****
    FileVersion

    integer

    ファイルのバージョンです。

    7
    Status

    integer

    • UNPUBLISHED(0)：未公開

    • SUCCESS(1)：公開済み

    • ERROR(2)：公開失敗

    • CLONED(3)：正常にクローン済み

    • DEPLOY_ERROR(4)：公開失敗

    • CLONING(5)：クローン中

    • REJECT(6)：リリース拒否

    1

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "Deployment": {
      "Status": 1,
      "ErrorMessage": "Success",
      "FromEnvironment": 0,
      "ToEnvironment": 1,
      "CheckingStatus": 7,
      "CreateTime": 1593877765000,
      "HandlerId": "2003****",
      "CreatorId": "20030****",
      "ExecuteTime": 1593877765000,
      "Name": "ods_user_info_d-2020-07-04_20030****"
    },
    "DeployedItems": [
      {
        "FileId": 0,
        "FileVersion": 7,
        "Status": 1
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError.System An internal system error occurred. Try again later.
    500 InternalError.UserId.Missing An internal system error occurred. Try again later.
    403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
    429 Throttling.Api The request for this resource has exceeded your available limit.
    429 Throttling.System The DataWorks system is busy. Try again later.
    429 Throttling.User Your request is too frequent. Try again later.

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

    変更履歴

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