GetDeploymentPackage API リファレンス - DataWorks

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

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	任意	DataWorks ワークスペース ID。DataWorks コンソール（https://workbench.data.aliyun.com/console）にログインし、[ワークスペース] ページで確認できます。このパラメーターにより、本 API 呼び出しの対象となる DataWorks ワークスペースが特定されます。	10000
ProjectIdentifier	string	任意	DataWorks ワークスペースの一意な識別子。Data Studio ページ上部のワークスペース切替ツールに表示される識別子です。本 API 呼び出しの対象となる DataWorks ワークスペースを特定するには、本パラメーターまたは ProjectId のいずれかを指定する必要があります。	dw_project
DeploymentId	integer	必須	デプロイメントパッケージ ID。この ID は、SubmitFile または DeployFile を呼び出した際に生成されます。	1000000001

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
HttpStatusCode	integer	HTTP ステータスコード。	200
ErrorMessage	string	エラーメッセージ。	You have no permission.
RequestId	string	リクエスト ID。ログの検索および障害のトラブルシューティングに使用します。	0bc1ec92159376****
ErrorCode	string	エラーコード。	Invalid.Tenant.ConnectionNotExists
Success	boolean	呼び出しが成功したかどうかを示します。有効な値は以下のとおりです。 true false	true
Data	object	デプロイメントパッケージの詳細情報。
Deployment	object	デプロイメントパッケージの詳細情報。
Status	integer	デプロイメントパッケージの現在のステータス。有効な値は以下のとおりです：0（準備完了）、1（成功）、2（失敗）。	1
ErrorMessage	string	デプロイメントパッケージの実行が失敗した場合（ステータスが 2 の場合）の詳細なエラーメッセージ。	Success
FromEnvironment	integer	デプロイメントが実行される環境。有効な値は以下のとおりです：0（ローカル）、1（開発）。	0
ToEnvironment	integer	デプロイメントの対象環境。有効な値は以下のとおりです：1（開発）、2（本番）。	1
CheckingStatus	integer	デプロイメントパッケージ内のノードの検証ステータス。開発環境（toEnviroment=1）へのデプロイメントパッケージの場合、パッケージの Status が 1（成功）かつ CheckingStatus が空（検証完了）である場合にのみ、本番環境へのデプロイメントを続行できます。 7：検証失敗 8：検証中	7
CreateTime	integer	デプロイメントパッケージが作成されたタイムスタンプ（ミリ秒単位）。	1593877765000
HandlerId	string	デプロイメントを実行したユーザーの Alibaba Cloud アカウント ID。	2003****
CreatorId	string	デプロイメントパッケージを作成したユーザーの Alibaba Cloud アカウント ID。	20030****
ExecuteTime	integer	デプロイメントが開始されたタイムスタンプ（ミリ秒単位）。	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": "You have no permission.",
  "RequestId": "0bc1ec92159376****",
  "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.

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

変更履歴

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