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

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

接口说明

适用的产品系列：

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeDBResourceGroup	get	*DBCluster `acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	数仓版集群 ID。说明您可以调用 DescribeDBClusters 接口查询目标地域中所有数仓版集群的集群 ID。	am-bp1ub9grke1****
GroupName	string	是	资源组名称。	USER_DEFAULT

返回参数

名称	类型	描述	示例值
	object	资源组
RequestId	string	请求 ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
GroupsInfo	array<object>	资源组信息列表。
PoolInfo	object	资源组
GroupType	string	查询类型，取值说明： interactive（默认值）：交互查询模式。 batch：分批查询模式。 Job：离线查询模式。	interactive
UpdateTime	string	更新时间。	2022-11-09 16:57:35.241
GroupName	string	资源组名称。	USER_DEFAULT
MinComputeResource	string	最小计算预留资源，单位 ACU。当 GroupType 为 Interactive 时，计算预留资源最小为 16 ACU。当 GroupType 为 Job 时，计算预留资源最小为 0 ACU。	0ACU
MaxComputeResource	string	最大计算预留资源，单位 ACU。当 GroupType 为 Interactive 时，计算预留资源最大为集群当前未分配资源，步长为 16 ACU。当 GroupType 为 Job 时，计算预留资源最大为集群当前未分配资源，步长为 8 ACU。	32ACU
ClusterSizeResource	string	单个 Cluster 资源规格，单位为 ACU。	16ACU
MinClusterCount	integer	资源组内至少需要运行的 Cluster 个数，最小为 1。	1
MaxClusterCount	integer	资源组内最多可以运行的 Cluster 个数，最大为 10。	4
RunningClusterCount	integer	资源组内正在运行的 Cluster 个数。	2
ClusterMode	string	资源组模式，取值： Disable（默认）：常规模式。 AutoScale：自动弹性模式。	AutoScale
ElasticMinComputeResource	string	最小计算弹性资源，单位为 ACU。	16ACU
CreateTime	string	创建时间。	2022-10-09 16:57:35.241
GroupUsers	string	资源组绑定的数据库账号列表，多个账号以英文逗号（,）分隔。	testb,testc
NodeNum	integer	节点数量。1 个节点的资源量为 16 核 64 GB。	2
GroupUserList	array	资源组绑定的数据库账号列表。
GroupUserList	string	资源组绑定的数据库账号。	user1
Engine	string	资源组引擎，取值： AnalyticDB（默认）：AnalyticDB for MySQL 引擎。 SparkWarehouse：SparkWarehouse 引擎。	AnalyticDB
EngineParams	object	Spark 应用配置参数，应用于该资源组执行的所有 Spark 作业。如需为某个 Spark 作业单独配置参数，可以在提交作业时通过代码设置。	{\"spark.adb.version\":\"3.5\"}
Status	string	资源组状态，取值说明： Pending：创建中。 Running：运行中。 Scaling：变配中。 Deleting：删除中。 Deleted：已删除。	Running
ConnectionString	string	资源组连接地址。说明仅 Engine 为 SparkWarehouse 时返回该参数。	amv-bp1nw64y******.ads.aliyuncs.com
Port	string	资源组端口号。说明仅 Engine 为 SparkWarehouse 时返回该参数。	3306
DBClusterId	string	集群 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	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

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

变更历史

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