ListResourceGroups - 获取资源组列表

获取资源组列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:ListResourceGroupslist
*全部资源
*

请求参数

名称类型必填描述示例值
Namestring

资源组名称,用于模糊查询

Resource
ProjectIdlong

所属工作空间 ID

1000
Statusesarray

查询的资源组状态列表

Statusestring

查询的资源组状态。

  • Normal:正常(运行中/服务中)
  • Stop:冻结(已到期)
  • Deleted:删除(已释放/已销毁)
  • Creating:创建中(启动中)
  • CreateFailed:创建失败(启动失败)
Normal
ResourceGroupTypesarray

查询的资源组类型列表,为空默认查询通用资源组

string

资源组类型:

  • CommonV2:新版通用资源组;
  • ExclusiveDataIntegration:独享数据集成资源组;
  • ExclusiveScheduler:独享调度资源组;
  • ExclusiveDataService:独享数据服务资源组
CommonV2
PaymentTypestring

资源组的付费类型。

  • PrePaid:包年包月。
  • PostPaid:按量付费 。
PrePaid

返回参数

名称类型描述示例值
object

Schema of Response

Successboolean

是否请求成功

true
ResourceGroupListarray<object>

获取到的资源组详情列表

Dataobject

资源组详细信息

Idstring

资源组唯一标识

Serverless_res_group_524257424564736_6831777003XXXXX
Namestring

资源组的名称

common_resource_group
Remarkstring

资源组的备注

创建用于普通任务的通用资源组
PaymentTypestring

资源组的付费类型,PrePaid 代表包年包月,PostPaid 代表按量付费

PrePaid
Statusstring

查询的资源组状态:

  • Normal: 正常 (运行中/服务中);
  • Stop: 冻结 (已到期);
  • Deleted: 删除 (已释放/已销毁);
  • Creating: 创建中 (启动中);
  • CreateFailed: 创建失败 (启动失败);
  • Updating: 更新中 (扩容中/缩容中/变配中);
  • UpdateFailed: 更新失败 (扩容失败/升级失败);
  • Deleting: 删除中 (释放中/销毁中);
  • DeleteFailed: 删除失败 (释放失败/销毁失败);
  • Timeout: 操作超时。
Normal
Specobject

资源组规格

Standardstring

规格详情

2CU
Amountinteger

资源数量

1
ResourceGroupTypestring

资源组类型:

  • CommonV2:新版通用资源组;
  • ExclusiveDataIntegration:独享数据集成资源组;
  • ExclusiveScheduler:独享调度资源组;
  • ExclusiveDataService:独享数据服务资源组
CommonV2
OrderInstanceIdstring

资源组的订单实例 ID

c442b330-3b10-4584-959e-736e4edXXXXX
CreateUserstring

创建该资源组的用户 ID

11075500042XXXXX
CreateTimelong

创建时间,为 64 位时间戳

1727055811000
DefaultVpcIdstring

通用资源组绑定的默认 VPC ID

vpc-m2et4f3oc8msfbccXXXXX
DefaultVswicthIdstring

通用资源组绑定的默认交换机 ID

vsw-uf8usrhs7hjd9amsXXXXX
RequestIdstring

请求的 ID,用于定位日志,排查问题

6A6CBE87-9F91-1323-B680-E7A7065XXXXX

示例

正常返回示例

JSON格式

{
  "Success": true,
  "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"
    }
  ],
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史