使用ListResourceGroups擷取資源群組列表-巨量資料開發治理平台 DataWorks-阿里雲 - DataWorks

擷取資源群組列表。

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。
請確保在使用該介面前，已建立服務關聯角色 AliyunServiceRoleForDataWorks。

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListResourceGroups

list

*DwResourceGroup

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

無

請求參數

名稱	類型	必填	描述	樣本值
Name	string	否	資源群組名稱，用於模糊查詢	Resource
ProjectId	integer	否	所屬工作空間 ID	1000
Statuses	array	否	查詢的資源群組狀態列表
	string	否	查詢的資源群組狀態： Normal: 正常 (運行中/服務中)； Stop: 凍結 (已到期)； Deleted: 刪除 (已釋放/已銷毀)； Creating: 建立中； CreateFailed: 建立失敗； Updating: 更新中 (擴容中/縮容中/變更配置中)； UpdateFailed: 更新失敗 (擴容失敗/升級失敗)； Deleting: 刪除中 (釋放中/銷毀中)； DeleteFailed: 刪除失敗 (釋放失敗/銷毀失敗)； Timeout: 操作逾時； Freezed：凍結； Starting：啟動中。	Normal
ResourceGroupTypes	array	否	查詢的資源群組類型列表，為空白預設查詢通用資源群組
	string	否	資源群組類型： CommonV2：新版通用資源群組； ExclusiveDataIntegration：獨享Data Integration資源群組； ExclusiveScheduler：獨享調度資源群組； ExclusiveDataService：獨享資料服務資源群組	CommonV2
PaymentType	string	否	資源群組的付費類型。 PrePaid：訂用帳戶。 PostPaid：隨用隨付。	PrePaid
AliyunResourceGroupId	string	否	阿里雲資源群組 ID	rg-aek2kqofrgXXXXX
AliyunResourceTags	array<object>	否	阿里雲標籤列表
	object	否	阿里雲標籤
Key	string	否	標籤 Key	key
Value	string	否	標籤 Value	value
PageSize	integer	否	分頁大小	100
PageNumber	integer	否	分頁頁碼	1
SortBy	string	否	排序欄位列表，支援定時時間、開始時間等欄位。格式為"排序欄位+排序方式(Desc/Asc)"（Asc 可以預設）。排序欄位的枚舉值如下： Id (Desc/Asc)：資源群組 ID Name (Desc/Asc)：資源群組名稱 Remark (Desc/Asc)：資源群組備忘 Type (Desc/Asc)：資源群組類型 Status (Desc/Asc)：資源群組資源狀態 Spec (Desc/Asc)：資源群組規格 CreateUser (Desc/Asc)：建立人 CreateTime (Desc/Asc)：建立時間預設值為 CreateTime Asc	CreateTime Asc

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
Success	boolean	是否請求成功	true
PagingInfo	object	分頁列表
ResourceGroupList	array<object>	擷取到的資源群組詳情列表
	array<object>	資源群組詳細資料
Id	string	資源群組唯一標識	Serverless_res_group_524257424564736_6831777003XXXXX
Name	string	資源群組的名稱	common_resource_group
Remark	string	資源群組的備忘	建立用於普通任務的通用資源群組
PaymentType	string	資源群組的付費類型，PrePaid 代表訂用帳戶，PostPaid 代表隨用隨付	PrePaid
Status	string	查詢的資源群組狀態： Normal: 正常 (運行中/服務中)； Stop: 凍結 (已到期)； Deleted: 刪除 (已釋放/已銷毀)； Creating: 建立中； CreateFailed: 建立失敗； Updating: 更新中 (擴容中/縮容中/變更配置中)； UpdateFailed: 更新失敗 (擴容失敗/升級失敗)； Deleting: 刪除中 (釋放中/銷毀中)； DeleteFailed: 刪除失敗 (釋放失敗/銷毀失敗)； Timeout: 操作逾時； Freezed：凍結； Starting：啟動中。	Normal
Spec	object	資源群組規格
Standard	string	規格詳情	2CU
Amount	integer	數量	1
ResourceGroupType	string	資源群組類型： CommonV2：新版通用資源群組； ExclusiveDataIntegration：獨享Data Integration資源群組； ExclusiveScheduler：獨享調度資源群組； ExclusiveDataService：獨享資料服務資源群組	CommonV2
OrderInstanceId	string	資源群組的訂單一實例 ID	c442b330-3b10-4584-959e-736e4edXXXXX
CreateUser	string	建立該資源群組的使用者識別碼	11075500042XXXXX
CreateTime	integer	建立時間，為 64 位元時間戳記	1727055811000
DefaultVpcId	string	通用資源群組綁定的預設 VPC ID	vpc-m2et4f3oc8msfbccXXXXX
DefaultVswicthId	string	通用資源群組綁定的預設交換器 ID	vsw-uf8usrhs7hjd9amsXXXXX
AliyunResourceGroupId	string	阿里雲資源群組 ID	rg-aek2kqofrgXXXXX
AliyunResourceTags	array<object>	阿里雲標籤列表
	object	阿里雲標籤
Key	string	標籤鍵	Key
Value	string	標籤值	Value
PageNumber	integer	分頁頁碼	1
PageSize	integer	分頁大小	100
TotalCount	integer	全部資料條目	100
RequestId	string	請求的 ID，用於定位日誌，排查問題	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "PagingInfo": {
    "ResourceGroupList": [
      {
        "Id": "Serverless_res_group_524257424564736_6831777003XXXXX",
        "Name": "common_resource_group",
        "Remark": "建立用於普通任務的通用資源群組",
        "PaymentType": "PrePaid",
        "Status": "Normal",
        "Spec": {
          "Standard": "2CU",
          "Amount": 1
        },
        "ResourceGroupType": "CommonV2",
        "OrderInstanceId": "c442b330-3b10-4584-959e-736e4edXXXXX",
        "CreateUser": "11075500042XXXXX",
        "CreateTime": 1727055811000,
        "DefaultVpcId": "vpc-m2et4f3oc8msfbccXXXXX",
        "DefaultVswicthId": "vsw-uf8usrhs7hjd9amsXXXXX",
        "AliyunResourceGroupId": "rg-aek2kqofrgXXXXX",
        "AliyunResourceTags": [
          {
            "Key": "Key",
            "Value": "Value"
          }
        ]
      }
    ],
    "PageNumber": 1,
    "PageSize": 100,
    "TotalCount": 100
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

錯誤碼

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

變更歷史

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