ListDeployments API を使用したデプロイメントパッケージのクエリ - DataWorks

デプロイメントパッケージのリストを照会します。この操作は、DataWorks コンソールの [デプロイメントパッケージ] ページでデプロイメントパッケージのリストを表示することと同等です。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectIdentifier	string	任意	DataWorks ワークスペースの名前。DataWorks コンソールにログインし、[ワークスペース] ページに移動してワークスペース名を取得できます。このパラメーターまたは ProjectId パラメーターのいずれかを設定して、操作が適用される DataWorks ワークスペースを特定する必要があります。	dw_project
ProjectId	integer	任意	DataWorks ワークスペース ID。DataWorks コンソールにログインし、[ワークスペース] ページに移動してワークスペース ID を取得できます。このパラメーターまたは ProjectIdentifier パラメーターのいずれかを設定して、操作が適用される DataWorks ワークスペースを特定する必要があります。	10000
Creator	string	任意	デプロイメントパッケージを作成するユーザーが使用する Alibaba Cloud アカウントの ID。	20030****
EndCreateTime	integer	任意	照会するデプロイメントパッケージが作成された時間。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を示す UNIX タイムスタンプである必要があります。	1593877765000
Executor	string	任意	デプロイメントパッケージを実行するユーザーが使用する Alibaba Cloud アカウントの ID。	2003****
EndExecuteTime	integer	任意	デプロイメントパッケージが実行された時間。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を示す UNIX タイムスタンプである必要があります。	1593877765000
Status	integer	任意	デプロイメントパッケージのステータス。有効な値: 0: デプロイメントパッケージは準備完了です。 1: デプロイメントパッケージはデプロイ済みです。 2: デプロイメントパッケージのデプロイに失敗しました。 6: デプロイメントパッケージは拒否されました。	1
Keyword	string	任意	デプロイメントパッケージの名前に含まれるキーワード。あいまい検索がサポートされています。キーワードを入力すると、そのキーワードを含むすべてのデプロイメントパッケージが表示されます。	hello
PageNumber	integer	任意	ページ番号。	1
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。	20

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	0000-ABCD-EFG
Data	object	返されたデータ。
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	10
TotalCount	integer	返された合計エントリ数。	13
Deployments	array<object>	デプロイメントパッケージ。
	object
Status	integer	デプロイメントパッケージのステータス。有効な値: 0: デプロイメントパッケージは準備完了です。 1: デプロイメントパッケージはデプロイ済みです。 2: デプロイメントパッケージのデプロイに失敗しました。 6: デプロイメントパッケージは拒否されました。	1
ErrorMessage	string	デプロイメントパッケージが失敗したときに返されるエラーメッセージ。	OK
CreateTime	integer	デプロイメントパッケージが作成された時間。	1593877765000
Executor	string	デプロイメントパッケージを実行したユーザーが使用した Alibaba Cloud アカウントの ID。	2003****
Creator	string	デプロイメントパッケージを作成したユーザーが使用した Alibaba Cloud アカウントの ID。	2003****
ExecuteTime	integer	デプロイメントパッケージが実行された時間。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を示す UNIX タイムスタンプです。	1593877765000
Name	string	デプロイメントパッケージの名前。	auto_created
Id	integer	デプロイメントパッケージ ID。GetDeployment 操作を呼び出して ID を取得できます。	11111

例

成功レスポンス

JSONJSON

{
  "RequestId": "0000-ABCD-EFG",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "Deployments": [
      {
        "Status": 1,
        "ErrorMessage": "OK",
        "CreateTime": 1593877765000,
        "Executor": "2003****",
        "Creator": "2003****",
        "ExecuteTime": 1593877765000,
        "Name": "auto_created",
        "Id": 11111
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
500	InternalError.System	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.

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

変更履歴

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