DescribeDBResourceGroup - 查询数据库资源组信息

调用DescribeDBResourceGroup接口查询数仓版集群的资源组信息。

接口说明

注意事项

该接口仅适用于 32 核及以上规格的弹性模式集群版(新版)集群。

调试

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

授权信息

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

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

请求参数

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

数仓版集群 ID。

说明 您可以调用 DescribeDBClusters 接口查询目标地域中所有数仓版集群的集群 ID。
am-bp1ub9grke1****
GroupNamestring

资源组名称。

USER_DEFAULT

返回参数

名称类型描述示例值
object

资源组

RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
GroupsInfoarray<object>

资源组信息列表。

PoolInfoobject

资源组

GroupTypestring

查询类型。取值说明:

  • interactive:交互查询模式。
  • batch:默认查询模式。
说明 详情请参见查询执行模式
interactive
UpdateTimestring

更新时间。

2022-11-09 16:57:35.241
GroupNamestring

资源组名称。

USER_DEFAULT
CreateTimestring

创建时间。

2022-10-09 16:57:35.241
GroupUsersstring

资源组绑定的数据库账号列表,多个账号以英文逗号(,)分隔。

testb,testc
NodeNuminteger

节点数量。1 个节点的资源量为 16 核 64 GB。

2
GroupUserListarray

资源组绑定的数据库账号列表。

GroupUserListstring

资源组绑定的数据库账号。

user1
DBClusterIdstring

集群 ID。

am-bp1ub9grke1****

示例

正常返回示例

JSON格式

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "GroupsInfo": [
    {
      "GroupType": "interactive",
      "UpdateTime": "2022-11-09 16:57:35.241",
      "GroupName": "USER_DEFAULT",
      "CreateTime": "2022-10-09 16:57:35.241",
      "GroupUsers": "testb,testc",
      "NodeNum": 2,
      "GroupUserList": [
        "user1"
      ]
    }
  ],
  "DBClusterId": "am-bp1ub9grke1****"
}

错误码

HTTP status code错误码错误信息描述
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

变更历史

变更时间变更内容概要操作
2024-07-01OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情