ListResourceGroups - Resource Management - Alibaba Cloud ドキュメントセンター

ListResourceGroups API を呼び出して、リソースグループの一覧を照会します。

操作説明

この API を呼び出すことで、現在のアカウントに属するすべてのリソースグループの一覧を照会できます。また、リソースグループのステータス、リソースグループ ID、リソースグループ ID、表示名に基づいて、対応するリソースグループ一覧をフィルターして照会することも可能です。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Status	string	任意	リソースグループのステータスです。このパラメーターは照会時のフィルター条件として指定されます。有効な値は以下のとおりです。 Creating：リソースグループが作成中です。 OK：リソースグループが正常に作成されました。 PendingDelete：リソースグループが削除待ち状態です。	OK
PageNumber	integer	任意	返されるページ番号です。ページ番号は 1 から始まります。デフォルト値は 1 です。	1
PageSize	integer	任意	1 ページあたりに返すエントリ数です。有効な値は 1～100 です。デフォルト値は 10 です。	10
ResourceGroupId	string	任意	リソースグループの ID です。このパラメーターは照会時のフィルター条件として指定されます。 ID は最大 18 文字で、`rg-` で始める必要があります。説明このパラメーターは `ResourceGroupIds` パラメーターに統合されています。 `ResourceGroupId` および `ResourceGroupIds` の両方を設定した場合、`ResourceGroupIds` の値が優先されます。	rg-9gLOoK****
DisplayName	string	任意	リソースグループの表示名です。このパラメーターは照会時のフィルター条件として指定されます。部分一致検索がサポートされています。表示名は最大 50 文字まで指定できます。	my-project
Name	string	任意	リソースグループの ID です。このパラメーターは照会時のフィルター条件として指定されます。部分一致検索がサポートされています。 ID は最大 50 文字まで指定でき、英字、数字、ハイフン (-) を含めることができます。	my-project
Tag	array<object>	任意	タグです。このパラメーターは照会時のフィルター条件として指定されます。
	object	任意	照会のフィルター条件として使用するタグです。最大 20 個のタグを指定できます。
Key	string	任意	タグキーです。	k1
Value	string	任意	タグ値です。	v1
IncludeTags	boolean	任意	タグ情報を返すかどうかを指定します。有効な値は以下のとおりです。 false（デフォルト値） true 説明 Tag パラメーターを設定した場合、`IncludeTags` の設定に関係なく、タグ情報が返されます。	false
ResourceGroupIds	array	任意	リソースグループの ID のリストです。このパラメーターは照会時のフィルター条件として指定されます。最大 100 個のリソースグループ ID を指定できます。説明 `ResourceGroupId` および `ResourceGroupIds` の両方を設定した場合、`ResourceGroupIds` の値が優先されます。
	string	任意	照会のフィルター条件として使用するリソースグループ ID のリストです。最大 100 個のリソースグループ ID を指定できます。説明 `ResourceGroupId` および `ResourceGroupIds` の両方が指定された場合、`ResourceGroupIds` が優先されます。	{"rg-1hSBH2**","rg-9gLOoK**"}

レスポンスフィールド

フィールド	型	説明	例
	object	応答結果です。
PageNumber	integer	返されたページのページ番号です。	1
PageSize	integer	1 ページあたりに返されたエントリ数です。	10
RequestId	string	リクエストの ID です。	4B450CA1-36E8-4AA2-8461-86B42BF4CC4E
ResourceGroups	object
ResourceGroup	array<object>	リソースグループの情報です。
	array<object>	リソースグループのリストです。
AccountId	string	リソースグループが属する Alibaba Cloud アカウントの ID です。	123456789****
CreateDate	string	リソースグループが作成された時刻です。時刻は協定世界時 (UTC) で表示されます。	2015-01-23T12:33:18Z
DisplayName	string	リソースグループの表示名です。	my-project
Id	string	リソースグループの ID です。	rg-9gLOoK****
Name	string	リソースグループの ID です。	my-project
Status	string	リソースグループのステータスです。有効な値は以下のとおりです。 Creating：リソースグループが作成中です。 OK：リソースグループが正常に作成されました。 PendingDelete：リソースグループが削除待ち状態です。	OK
Tags	object
Tag	array<object>	リソースグループに追加されたタグです。
	object	タグのリストです。
TagKey	string	タグキーです。	k1
TagValue	string	タグ値です。	v1
TotalCount	integer	返されたエントリの総数です。	2

例

成功レスポンス

JSONJSON

{
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "4B450CA1-36E8-4AA2-8461-86B42BF4CC4E",
  "ResourceGroups": {
    "ResourceGroup": [
      {
        "AccountId": "123456789****",
        "CreateDate": "2015-01-23T12:33:18Z",
        "DisplayName": "my-project",
        "Id": "rg-9gLOoK****",
        "Name": "my-project",
        "Status": "OK",
        "Tags": {
          "Tag": [
            {
              "TagKey": "k1",
              "TagValue": "v1"
            }
          ]
        }
      }
    ]
  },
  "TotalCount": 2
}

エラーコード

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

変更履歴

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