获取资源组列表。
接口说明
需要购买 DataWorks 基础版及以上版本才能使用。
请确保在使用该接口前，已创建服务关联角色 AliyunServiceRoleForDataWorks。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dataworks:ListResourceGroups |
list |
*DwResourceGroup
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Name |
string |
否 |
资源组名称，用于模糊查询 |
Resource |
| ProjectId |
integer |
否 |
所属工作空间 ID |
1000 |
| Statuses |
array |
否 |
查询的资源组状态列表 |
|
|
string |
否 |
查询的资源组状态：
|
Normal |
|
| ResourceGroupTypes |
array |
否 |
查询的资源组类型列表，为空默认查询通用资源组 |
|
|
string |
否 |
资源组类型：
|
CommonV2 |
|
| PaymentType |
string |
否 |
资源组的付费类型。
|
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 可以缺省）。排序字段的枚举值如下：
默认值为 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 |
| Spec |
object |
资源组规格 |
|
| Standard |
string |
规格详情 |
2CU |
| Amount |
integer |
数量 |
1 |
| ResourceGroupType |
string |
资源组类型：
|
CommonV2 |
| OrderInstanceId |
string |
资源组的订单实例 ID |
c442b330-3b10-4584-959e-736e4edXXXXX |
| CreateUser |
string |
创建该资源组的用户 ID |
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"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。