DataWorks ワークスペースに関連付けられたコンピュートエンジンの一覧を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dataworks:* |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProjectId |
integer |
必須 |
コンピュートエンジンが関連付けられている DataWorks ワークスペースの ID。 |
27 |
| Name |
string |
任意 |
コンピュートエンジンの表示名。完全一致で照会されます。 |
abc |
| CalcEngineType |
string |
必須 |
コンピュートエンジンの種類。大文字と小文字は区別されません。有効な値は以下のとおりです。
|
ODPS |
| EnvType |
string |
任意 |
コンピュートエンジンが使用される環境。有効な値は以下のとおりです。
|
PRD |
| PageSize |
integer |
任意 |
1 ページあたりの表示件数。デフォルト値は 10、最大値は 100 です。 |
10 |
| PageNumber |
integer |
任意 |
ページ番号。先頭ページは 1 から始まります。デフォルト値は 1 です。 |
1 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| HttpStatusCode |
integer |
HTTP ステータスコード。 |
200 |
| RequestId |
string |
リクエスト ID。 |
0bc1ec92159376**** |
| Success |
boolean |
リクエストが成功したかどうかを示します。有効な値は以下のとおりです。
|
true |
| Data |
object |
複数ページにわたって返されるコンピュートエンジンの照会結果。 |
|
| PageNumber |
integer |
返されたページのページ番号。 |
1 |
| PageSize |
integer |
1 ページあたりの表示件数。 |
20 |
| TotalCount |
integer |
コンピュートエンジンインスタンスの合計数。 |
1 |
| CalcEngines |
array<object> |
コンピュートエンジン。 |
|
|
array<object> |
返されたデータ。 |
||
| BindingProjectName |
string |
コンピュートエンジンが関連付けられているワークスペースの名前。 |
abc |
| IsDefault |
boolean |
このコンピュートエンジンが現在の種類におけるデフォルトエンジンであるかどうかを示します。 |
true |
| EngineId |
integer |
コンピュートエンジン ID。 |
35 |
| DwRegion |
string |
コンピュートエンジンが関連付けられている DataWorks ワークスペースが存在するリージョン。 |
cn-zhangjiakou |
| TaskAuthType |
string |
コンピュートエンジンへのアクセスに使用される ID。有効な値は以下のとおりです。
|
PROJECT |
| CalcEngineType |
string |
コンピュートエンジンの種類。 |
ODPS |
| EngineInfo |
object |
コンピュートエンジンの詳細情報。
|
{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","resourceGroupType":"ODPS","resourceGroupId":"361826516****","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","projectName":"onefall_test_zjk","taskSameAsOwner":"true"} |
| EnvType |
string |
コンピュートエンジンが使用される環境。有効な値は以下のとおりです。
|
PRD |
| Region |
string |
コンピュートエンジンが存在するリージョン。 |
cn-zhangjiakou |
| GmtCreate |
string |
コンピュートエンジンが作成された時刻。 |
Oct 10, 2019 3:42:44 PM |
| BindingProjectId |
integer |
コンピュートエンジンが関連付けられているワークスペースの ID。 |
27 |
| Name |
string |
コンピュートエンジンの表示名。 |
abc |
| TenantId |
integer |
テナント ID。 |
1234567 |
例
成功レスポンス
JSONJSON
{
"HttpStatusCode": 200,
"RequestId": "1AFAE64E-D1BE-432B-A9****",
"Success": true,
"Data": {
"PageNumber": 1,
"PageSize": 20,
"TotalCount": 1,
"CalcEngines": [
{
"BindingProjectName": "test_project",
"IsDefault": true,
"EngineId": 35,
"DwRegion": "cn-zhangjiakou",
"TaskAuthType": "PROJECT",
"CalcEngineType": "ODPS",
"EngineInfo": {
"pubEndpoint": "service.cn.maxcompute.aliyun.com/api",
"endpoint": "service.cn.maxcompute.aliyun-inc.com/api",
"initProperties": " {\"odpsTypeMode\":\"STANDARD\",\"openPai\":false,\"openPaiGpu\":false}",
"resourceGroupType": "ODPS",
"resourceGroupId": "361826516****",
"vpcEndpoint": "service.cn.maxcompute.aliyun-inc.com/api",
"projectName": "onefall_test_zjk",
"taskSameAsOwner": "true"
},
"EnvType": "PRD",
"Region": "cn-zhangjiakou",
"GmtCreate": "Oct 10, 2019 3:42:44 PM",
"BindingProjectId": 466230,
"Name": "test_mc",
"TenantId": 1234567
}
]
}
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Invalid.Tenant.ConnectionNotExists | The connection does not exist. | |
| 400 | Invalid.Tenant.ProjectNotExists | The project does not exist. | |
| 400 | Invalid.Tenant.UserNotInProject | The user is not in the project. | |
| 400 | Invalid.CalcEngineEnvType | The specified envType %s is invalid. | |
| 400 | Invalid.CalcEngineType | The specified calcEngineType %s is invalid. | |
| 403 | Invalid.Tenant.UserIsNotProjectOwnerOrAdmin | The user is not a project administrator or owner. | |
| 403 | Invalid.Tenant.UserNotInTenant | The user is not in tenant. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。