ListResourceGroups - 查詢資源群組列表 - Resource Management

調用ListResourceGroups查詢資源群組列表。

介面說明

您可以調用本 API 查詢當前帳號下的所有資源群組列表，也可以根據資源群組狀態、資源群組 ID、資源群組標識或資源群組顯示名稱查詢對應的資源群組列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
Status	string	否	資源群組狀態，用於查詢的過濾條件。取值： Creating：建立中。 OK：建立成功。 PendingDelete：等待刪除。	OK
PageNumber	integer	否	頁碼。起始值：1。預設值：1。	1
PageSize	integer	否	分頁時每頁顯示的資料條數。取值範圍：1~100。預設值：10。	10
ResourceGroupId	string	否	資源群組 ID，用於查詢的過濾條件。長度不能超過 18 個字元，且以`rg-`開頭。說明該參數已被收編到參數`ResourceGroupIds`，如果您同時設定了`ResourceGroupId`和`ResourceGroupIds`，則會以`ResourceGroupIds`為準。	rg-9gLOoK****
DisplayName	string	否	資源群組顯示名稱，用於查詢的過濾條件。支援模糊查詢。長度不能超過 50 個字元。	my-project
Name	string	否	資源群組唯一標識，用於查詢的過濾條件。支援模糊查詢。長度不能超過 50 個字元，可包含英文字母、數字和短劃線（-）。	my-project
Tag	array<object>	否	標籤，用於查詢的過濾條件。最多可以設定 20 個標籤。
	object	否	標籤，用於查詢的過濾條件。最多可以設定 20 個標籤。
Key	string	否	標籤鍵。	k1
Value	string	否	標籤值。	v1
IncludeTags	boolean	否	是否返回標籤資訊。取值： false（預設值）：不返回。 true：返回。說明當您設定了標籤過濾條件後，不論`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	分頁時每頁顯示的資料條數。	10
RequestId	string	請求 ID。	4B450CA1-36E8-4AA2-8461-86B42BF4CC4E
ResourceGroups	object
ResourceGroup	array<object>	資源群組列表。
	array<object>	資源群組列表。
AccountId	string	資源群組所屬的阿里雲帳號 ID。	123456789****
CreateDate	string	資源群組建立時間（UTC 時間）。	2015-01-23T12:33:18Z
DisplayName	string	資源群組顯示名稱。	my-project
Id	string	資源群組 ID。	rg-9gLOoK****
Name	string	資源群組唯一標識。	my-project
Status	string	資源群組狀態。取值： Creating：建立中。 OK：建立成功。 PendingDelete：等待刪除。	OK
Tags	object
Tag	array<object>	標籤列表。
	object	標籤列表。
TagKey	string	標籤鍵。	k1
TagValue	string	標籤值。	v1
TotalCount	integer	符合請求參數條件的資料總條數。	2

樣本

正常返回樣本

JSON格式

{
  "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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。