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

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

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ResourceGroupType	integer	任意	照会するリソースグループのタイプ。有効な値は次のとおりです。 0：DataWorks 1：スケジューリング 2：MaxCompute 3：Platform for AI (PAI) 4：データ統合 7：専用スケジューリングリソースグループ (専用スケジューリングリソースグループを購入すると、購入したリソースの ID が生成されます。) 9：DataService Studio デフォルト値：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	リソースグループのステータス。有効な値は次のとおりです。 0：NORMAL。リソースグループが実行中またはサービス中であることを示します。 1：STOP。リソースグループが期限切れで凍結されていることを示します。 2：DELETED。リソースグループがリリース済みまたは削除済みであることを示します。 3：CREATING。リソースグループが作成中または起動中であることを示します。 4：CREATE_FAILED。リソースグループの作成または起動に失敗したことを示します。 5：UPDATING。リソースグループがスケールアウトまたはスペックアップ中であることを示します。 6：UPDATE_FAILED。リソースグループのスケールアウトまたはスペックアップに失敗したことを示します。 7：DELETING。リソースグループがリリース中または削除中であることを示します。 8：DELETE_FAILED。リソースグループのリリースまたは削除に失敗したことを示します。 9：TIMEOUT。リソースグループで実行された操作がタイムアウトしたことを示します。すべての操作がタイムアウトする可能性があります。この値は、現在 DataService Studio でのみ利用可能です。	0
UpdateTime	string	リソースグループが最後に更新された時間。	Jul 9, 2018 2:43:37 PM
IsDefault	boolean	リソースグループがデフォルトのリソースグループであるかどうかを示します。有効な値は次のとおりです。 true：リソースグループはデフォルトのリソースグループです。 false：リソースグループはデフォルトのリソースグループではありません。	true
Cluster	string	クラスターの名前。このパラメーターは、リソースグループのタイプが MaxCompute または PAI の場合にのみ返されます。	AY18G
EnableKp	boolean	アクセスに Alibaba Cloud アカウントの UID を使用するかどうかを示します。有効な値は次のとおりです。 true：MaxCompute コンピュートエンジンは、Alibaba Cloud アカウントの UID をアカウントの表示名としてアクセスに使用します。 false：MaxCompute コンピュートエンジンは、Alibaba Cloud アカウントの名前をアカウントの表示名としてアクセスに使用します。残りの値は無意味です。このパラメーターは、リソースグループのタイプが MaxCompute の場合にのみ返されます。	false
ResourceGroupType	string	リソースグループのタイプ。有効な値は次のとおりです。 0：DataWorks 2：MaxCompute 3：PAI 4：データ統合 7：スケジューリング 9：DataService Studio	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	ご利用の Alibaba Cloud リソースグループの 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.

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

変更履歴

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