DataWorks ワークスペースの情報を照会します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProjectId |
integer |
任意 |
DataWorks ワークスペースの ID。ListProjects 操作を呼び出して ID を照会できます。 |
466230 |
| ProjectIdentifier |
string |
任意 |
DataWorks ワークスペースの名前。ListProjects 操作を呼び出して名前を照会できます。 |
test_project |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返された結果。 |
||
| HttpStatusCode |
integer |
HTTP ステータスコード。 |
200 |
| RequestId |
string |
リクエスト ID。 |
1AFAE64E-D1BE-432B-A9**** |
| Success |
boolean |
リクエストが成功したかどうかを示します。 有効な値:
|
true |
| Data |
object |
ワークスペースに関する情報。 |
|
| Status |
integer |
ワークスペースのステータス。 有効な値:
|
0 |
| MaxFlowNode |
integer |
このパラメーターは非推奨です。 |
1 |
| ProjectId |
integer |
ワークスペースの ID。 |
466230 |
| IsAllowDownload |
integer |
DataStudio からクエリ結果をダウンロードできるかどうかを示します。 有効な値:
|
1 |
| ProjectMode |
integer |
ワークスペースのモード。 有効な値:
|
2 |
| GmtModified |
string |
ワークスペースが最後に変更された時刻。 例: |
Dec 3, 2019 9:12:20 PM |
| ProdStorageQuota |
string |
このパラメーターは非推奨です。 |
1 |
| ProjectDescription |
string |
ワークスペースの説明。 |
test_describe |
| DevelopmentType |
integer |
このパラメーターは非推奨です。 |
4 |
| TablePrivacyMode |
integer |
ワークスペース内の MaxCompute テーブルがテナント内のユーザーに表示されるかどうかを示します。 有効な値:
|
1 |
| DefaultDiResourceGroupIdentifier |
string |
MaxCompute の専用リソースグループを購入したときにデフォルトで割り当てられたリソースグループの ID。 |
group_280749521**** |
| SchedulerMaxRetryTimes |
integer |
エラー発生後に許可される自動再実行のデフォルトの最大回数。 |
3 |
| ProtectedMode |
integer |
ワークスペース保護機能が有効になっているかどうかを示します。 有効な値:
|
1 |
| SchedulerRetryInterval |
integer |
エラー発生後の自動再実行間のデフォルトの間隔。 単位:ミリ秒。 最大間隔は 30 分です。 単位の変換にご注意ください。 |
120000 |
| Appkey |
string |
このパラメーターは非推奨です。 |
0 |
| DevStorageQuota |
string |
このパラメーターは非推奨です。 |
0 |
| ResidentArea |
string |
ワークスペースのタイプ。 有効な値:
|
private |
| IsDefault |
integer |
ワークスペースがデフォルトのワークスペースであるかどうかを示します。 有効な値:
|
1 |
| Destination |
integer |
このパラメーターは非推奨です。 |
0 |
| ProjectName |
string |
ワークスペースの表示名。 |
test_project |
| ProjectIdentifier |
string |
ワークスペースの名前。 |
test_project |
| DisableDevelopment |
boolean |
Develop ロールが無効になっているかどうかを示します。 有効な値:
|
true |
| ProjectOwnerBaseId |
string |
ワークスペースのオーナーが使用する Alibaba Cloud アカウントの ID。 |
18229311**** |
| BaseProject |
boolean |
このパラメーターは非推奨です。 |
false |
| UseProxyOdpsAccount |
boolean |
プロキシアカウントを使用して、ワークスペースに関連付けられている MaxCompute コンピュートエンジンにアクセスするかどうかを示します。 |
true |
| GmtCreate |
string |
ワークスペースが作成された時刻。 例: |
Oct 10, 2019 3:42:53 PM |
| TenantId |
integer |
テナント ID。 |
280749521 |
| EnvTypes |
array |
ワークスペースの環境情報。 |
|
|
string |
ワークスペースの環境。 有効な値: PROD および DEV。
|
["PROD"] |
|
| ResourceManagerResourceGroupId |
string |
リソースグループ ID。 |
rg-acfmzbn7**** |
| Tags |
array<object> |
ワークスペースに追加されたタグ。 |
|
|
object |
|||
| Key |
string |
タグキー。 |
key |
| Value |
string |
タグ値。 |
value |
例
成功レスポンス
JSONJSON
{
"HttpStatusCode": 200,
"RequestId": "1AFAE64E-D1BE-432B-A9****",
"Success": true,
"Data": {
"Status": 0,
"MaxFlowNode": 1,
"ProjectId": 466230,
"IsAllowDownload": 1,
"ProjectMode": 2,
"GmtModified": "Dec 3, 2019 9:12:20 PM",
"ProdStorageQuota": " 1",
"ProjectDescription": "test_describe",
"DevelopmentType": 4,
"TablePrivacyMode": 1,
"DefaultDiResourceGroupIdentifier": "group_280749521****",
"SchedulerMaxRetryTimes": 3,
"ProtectedMode": 1,
"SchedulerRetryInterval": 120000,
"Appkey": "0",
"DevStorageQuota": "0",
"ResidentArea": "private",
"IsDefault": 1,
"Destination": 0,
"ProjectName": "test_project",
"ProjectIdentifier": "test_project",
"DisableDevelopment": true,
"ProjectOwnerBaseId": "18229311****",
"BaseProject": false,
"UseProxyOdpsAccount": true,
"GmtCreate": "Oct 10, 2019 3:42:53 PM",
"TenantId": 280749521,
"EnvTypes": [
"[\"PROD\"]"
],
"ResourceManagerResourceGroupId": "rg-acfmzbn7****",
"Tags": [
{
"Key": "key",
"Value": "value"
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Invalid.Tenant.ProjectNotExists | The project does not exist. | |
| 400 | Invalid.Tenant.UserNotInProject | The user is not in the project. | |
| 403 | Invalid.Tenant.UserIsNotProjectOwnerOrAdmin | The user is not a project administrator or owner. | |
| 403 | Invalid.Tenant.UserNotInTenant | The user is not in tenant. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。