ListResourceGroups API によるリソースグループの取得 - DataWorks - Alibaba Cloud - DataWorks

指定されたタイプのリソースグループのリストを照会します。

操作説明

開始する前に: DataWorks が有効化されており、ターゲットリージョンに DataWorks ワークスペースが作成されている必要があります。そうでない場合、403 Forbidden.Access エラーが返される可能性があります。

今すぐお試しください

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

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:ListResourceGroups

get

TenantResourceGroup

acs:dataworks:{#regionId}:{#accountId}:exclusive_resource_group/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ResourceGroupType	integer	任意	クエリするリソースグループタイプの ID。有効な値: 0: DataWorks。 1: スケジューリング。 2: MaxCompute。 3: PAI。 4: Data Integration。 7: 排他的スケジューリングリソースグループを購入する際に生成される購入リソース ID。 9: dataService。デフォルト値: 1。値がエンジンを表す場合、返されるリストにはエンジンの購入時に作成されたリソースグループが含まれます。	3
Keyword	string	任意	リソースグループ名および識別子のあいまい一致に使用されるキーワード。	abc
BizExtKey	string	任意	リソースグループのカテゴリ。有効な値: default: パブリックリソースグループ。これはデフォルト値です。 single: 排他的リソースグループ。	default
ResourceManagerResourceGroupId	string	任意	リソースグループの ID。	rg-acfmzbn7pti3zfa
Tags	array<object>	任意	タグのリスト。
	object	任意	タグ情報。
Key	string	任意	タグキー。	Env
Value	string	任意	タグ値。	Test

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
HttpStatusCode	integer	HTTP 状態コード。	200
RequestId	string	リクエスト ID。	0bc1411515937635973****
Success	boolean	リクエストが成功したかどうかを示します。	true
Data	array<object>	リソースグループのリスト。
	array<object>	リソースグループの詳細。
Status	integer	リソースグループのステータス。有効な値: NORMAL(0): リソースグループは正常で、実行中またはサービス稼働中です。 STOP(1): リソースグループは期限切れで、凍結されています。 DELETED(2): リソースグループはリリースまたは破棄されています。 CREATING(3): リソースグループは作成中または起動中です。 CREATE_FAILED(4): リソースグループの作成または起動に失敗しました。 UPDATING(5): リソースグループはスケールアウトまたはアップグレード中です。 UPDATE_FAILED(6): リソースグループのスケールアウトまたはアップグレードに失敗しました。 DELETING(7): リソースグループはリリースまたは破棄中です。 DELETE_FAILED(8): リソースグループのリリースまたは破棄に失敗しました。 TIMEOUT(9): リソースグループに対する操作がタイムアウトになります。すべての変更操作がタイムアウトになる可能性があります。この値は、Data Service に対してのみ一時的に提供されます。	0
UpdateTime	string	リソースグループが最後に更新された時間。フォーマットは `MMM d, yyyy h:mm:ss a` で、`Jul 9, 2018 2:43:37 PM` のようになります。	Jul 9, 2018 2:43:37 PM
IsDefault	boolean	リソースグループがデフォルトのリソースグループであるかどうかを示します。有効な値: true: リソースグループはデフォルトのリソースグループです。 false: リソースグループはデフォルトのリソースグループではありません。	true
Cluster	string	クラスターの名前。このパラメーターは、MaxCompute および PAI リソースグループに対してのみ効果を発揮します。	AY18G
EnableKp	boolean	Key Person (KP) アクセスが使用されているかどうかを示します。有効な値: true: MaxCompute エンジンは、アクセスアカウントの表示名として Alibaba Cloud アカウント UID を使用します。 false: MaxCompute エンジンは、アクセスアカウントの表示名として Alibaba Cloud アカウント名を使用します。このパラメーターは他のタイプでは意味がなく、MaxCompute エンジンに対してのみ効果を発揮します。	false
ResourceGroupType	string	リソースグループのタイプ。有効な値: 0: DataWorks。 2: MaxCompute。 3: PAI。 4: Data Integration。 7: スケジューリング。 9: dataService。	3
CreateTime	string	クラスターが作成された時間。フォーマットの例: `Jul 9, 2018 2:43:37 PM`。	Jul 9, 2018 2:43:37 PM
Identifier	string	リソースグループの識別子。	e1815577-2f4e-4c5e-b29****
Mode	string	リソースグループのモード。有効な値: ISOLATE: サブスクリプション排他的リソースグループ。 SHARE: 従量課金パブリックリソースグループ。 DEVELOP: 開発者エディション。	SHARE
BizExtKey	string	リソースグループのカテゴリ。有効な値: default: パブリックリソースグループ。 single: 排他的リソースグループ。	default
Sequence	integer	シーケンスフィールド。このフィールドは、作成されたリソースグループを作成シーケンス番号に基づいて昇順でソートするために使用されます。	300
Specs	object	リソースグループの詳細情報。{} 内のコンテンツは、リソースグループの詳細情報を示します。	{}
Name	string	リソースグループの名前。	abc
Id	integer	リソースグループの ID。	1234567
TenantId	integer	テナント ID。	1234567
ResourceManagerResourceGroupId	string	リソースグループの ID。	rg-acfmzbn7pti3zfa
Tags	array<object>	タグのリスト。
	object	タグ情報。
Key	string	タグキー。	Env
Value	string	タグ値。	Test

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "RequestId": "0bc1411515937635973****",
  "Success": true,
  "Data": [
    {
      "Status": 0,
      "UpdateTime": "Jul 9, 2018 2:43:37 PM",
      "IsDefault": true,
      "Cluster": "AY18G",
      "EnableKp": false,
      "ResourceGroupType": "3",
      "CreateTime": "Jul 9, 2018 2:43:37 PM",
      "Identifier": "e1815577-2f4e-4c5e-b29****",
      "Mode": "SHARE",
      "BizExtKey": "default",
      "Sequence": 300,
      "Specs": {},
      "Name": "abc",
      "Id": 1234567,
      "TenantId": 1234567,
      "ResourceManagerResourceGroupId": "rg-acfmzbn7pti3zfa",
      "Tags": [
        {
          "Key": "Env",
          "Value": "Test"
        }
      ]
    }
  ]
}

エラーコード

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.	ユーザーがプロジェクトに存在しません。
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	ユーザーはプロジェクトオーナーまたはプロジェクト管理者ではありません。
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	追加対象のメンバーがテナントに存在しません。

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

変更履歴

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