全部产品
Search
文档中心

云原生数据仓库AnalyticDB:DescribeDBResourceGroup - 查询数据库资源组信息

更新时间:Jun 18, 2025

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

接口说明

适用的产品系列:

  • 企业版
  • 基础版
  • 湖仓版
  • 数仓版弹性模式:规格需为 32 核 128GB 及以上。

调试

您可以在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:分批查询模式。
  • Job:离线查询模式。
interactive
UpdateTimestring

更新时间。

2022-11-09 16:57:35.241
GroupNamestring

资源组名称。

USER_DEFAULT
MinComputeResourcestring

最小计算预留资源,单位 ACU。

  • 当 GroupType 为 Interactive 时,计算预留资源最小为 16 ACU。
  • 当 GroupType 为 Job 时,计算预留资源最小为 0 ACU。
0ACU
MaxComputeResourcestring

最大计算预留资源,单位 ACU。

  • 当 GroupType 为 Interactive 时,计算预留资源最大为集群当前未分配资源,步长为 16 ACU。
  • 当 GroupType 为 Job 时,计算预留资源最大为集群当前未分配资源,步长为 8 ACU。
32ACU
ClusterSizeResourcestring

单个 Cluster 资源规格,单位为 ACU。

16ACU
MinClusterCountinteger

资源组内至少需要运行的 Cluster 个数,最小为 1。

1
MaxClusterCountinteger

资源组内最多可以运行的 Cluster 个数,最大为 10。

4
RunningClusterCountinteger

资源组内正在运行的 Cluster 个数。

2
ClusterModestring

资源组模式,取值:

  • Disable(默认):常规模式。
  • AutoScale:自动弹性模式。
AutoScale
ElasticMinComputeResourcestring

最小计算弹性资源,单位为 ACU。

16ACU
CreateTimestring

创建时间。

2022-10-09 16:57:35.241
GroupUsersstring

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

testb,testc
NodeNuminteger

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

2
GroupUserListarray

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

GroupUserListstring

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

user1
Enginestring

资源组引擎,取值:

  • AnalyticDB(默认):AnalyticDB for MySQL 引擎。
  • SparkWarehouse:SparkWarehouse 引擎。
AnalyticDB
EngineParamsobject

Spark 应用配置参数,应用于该资源组执行的所有 Spark 作业。如需为某个 Spark 作业单独配置参数,可以在提交作业时通过代码设置。

{\"spark.adb.version\":\"3.5\"}
Statusstring

资源组状态,取值说明:

  • Pending:创建中。
  • Running:运行中。
  • Scaling:变配中。
  • Deleting:删除中。
  • Deleted:已删除。
Running
ConnectionStringstring

资源组连接地址。

说明 仅 Engine 为 SparkWarehouse 时返回该参数。
amv-bp1nw64y******.ads.aliyuncs.com
Portstring

资源组端口号。

说明 仅 Engine 为 SparkWarehouse 时返回该参数。
3306
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",
      "MinComputeResource": "0ACU",
      "MaxComputeResource": "32ACU",
      "ClusterSizeResource": "16ACU",
      "MinClusterCount": 1,
      "MaxClusterCount": 4,
      "RunningClusterCount": 2,
      "ClusterMode": "AutoScale",
      "ElasticMinComputeResource": "16ACU",
      "CreateTime": "2022-10-09 16:57:35.241",
      "GroupUsers": "testb,testc",
      "NodeNum": 2,
      "GroupUserList": [
        "user1"
      ],
      "Engine": "AnalyticDB",
      "EngineParams": {
        "test": "test",
        "test2": 1
      },
      "Status": "Running",
      "ConnectionString": "amv-bp1nw64y******.ads.aliyuncs.com",
      "Port": 3306
    }
  ],
  "DBClusterId": "am-bp1ub9grke1****"
}

错误码

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

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

变更历史

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