デプロイメントパッケージのリストを照会します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProjectIdentifier |
string |
任意 |
DataWorks ワークスペースの一意の識別子です。これは DataStudio ページ上部のワークスペース切り替えメニューに表示される英語の識別子です。この API 呼び出しの対象となる DataWorks ワークスペースを特定するには、このパラメーターまたは ProjectId パラメーターのいずれかを指定する必要があります。 |
dw_project |
| ProjectId |
integer |
任意 |
DataWorks ワークスペースの ID です。DataWorks コンソールにログインし、ワークスペース構成ページに移動してワークスペース ID を取得できます。この API 呼び出しの対象となる DataWorks ワークスペースを特定するには、このパラメーターまたは ProjectIdentifier パラメーターのいずれかを指定する必要があります。 |
10003 |
| Creator |
string |
任意 |
デプロイメントパッケージ作成者の Alibaba Cloud アカウント UID。 |
110755000425**** |
| EndCreateTime |
integer |
任意 |
デプロイメントパッケージの作成時間の最大値のタイムスタンプ (ミリ秒単位)。 |
1593877765000 |
| Executor |
string |
任意 |
デプロイメントパッケージのエグゼキュータの Alibaba Cloud アカウント UID。 |
2003**** |
| EndExecuteTime |
integer |
任意 |
デプロイメントパッケージの実行開始時刻の最大値のタイムスタンプ (ミリ秒単位)。 |
1593877765000 |
| Status |
integer |
任意 |
デプロイメントパッケージの現在のステータス。有効な値:
|
1 |
| Keyword |
string |
任意 |
デプロイメントパッケージ名のキーワード。DataWorks はあいまい一致をサポートしています。キーワードを入力すると、名前にそのキーワードを含むデプロイメントパッケージをクエリできます。 |
abc |
| PageNumber |
integer |
任意 |
ページ番号。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。 |
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答。 |
||
| RequestId |
string |
リクエストの一意の ID。 |
952795279527ab**** |
| Data |
object |
クエリ条件を満たすデプロイメントパッケージのリスト。 |
|
| PageNumber |
integer |
ページ番号。 |
1 |
| PageSize |
integer |
1 ページあたりのエントリ数。 |
10 |
| TotalCount |
integer |
条件を満たすエントリの総数。 |
20 |
| Deployments |
array<object> |
デプロイメントパッケージのリスト。 |
|
|
object |
デプロイメントパッケージの詳細。 |
||
| Status |
integer |
デプロイメントパッケージのステータスです。有効な値は以下のとおりです。
|
1 |
| ErrorMessage |
string |
デプロイメントパッケージの実行に失敗した場合、このパラメーターにはエラーメッセージが記録されます。 |
OK |
| CreateTime |
integer |
デプロイメントパッケージが作成されたタイムスタンプです。 |
1593877765000 |
| Executor |
string |
デプロイメントパッケージの実行者の Alibaba Cloud アカウント ID です。 |
2003**** |
| Creator |
string |
デプロイメントパッケージの作成者の Alibaba Cloud アカウント ID です。 |
2003**** |
| ExecuteTime |
integer |
デプロイメントパッケージが実行されたタイムスタンプです。 |
1593877765000 |
| Name |
string |
デプロイメントパッケージの名称です。 |
auto_created |
| Id |
integer |
デプロイメントパッケージの ID です。この ID を使用して、 GetDeployment 操作を呼び出すことで、デプロイメントパッケージの詳細情報を取得できます。 |
11111 |
例
成功レスポンス
JSONJSON
{
"RequestId": "952795279527ab****",
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 20,
"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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。