DescribeDBResourceGroup API查询集群资源组-云原生数据仓库AnalyticDB-阿里云

查询集群的资源组信息。

接口说明

当前服务的接入地址请参见服务接入点。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

adb:DescribeDBResourceGroup

list

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	企业版、基础版或湖仓版的集群 ID。	amv-bp11q28kvl688****
GroupName	string	否	资源组名称。说明此参数不填写时，默认返回指定集群的所有资源组信息。	test_group
GroupType	string	否	资源组类型，取值： Interactive Job 说明关于湖仓版资源组的详细信息，请参见资源组介绍。	Job
RegionId	string	否	地域 ID。说明您可以调用 DescribeRegions 接口查看集群的地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	A94B6C02-7BD4-5D67-9776-3AC8317E8DD3
GroupsInfo	array<object>	资源组信息列表。
	array<object>	资源组信息列表。
GroupType	string	资源组类型，取值： Interactive Job 说明关于湖仓版资源组的详细信息，请参见资源组介绍（湖仓版）。	Job
GroupName	string	资源组名称。	test1
MinComputeResource	string	最小计算预留资源，单位为 ACU。	0ACU
MaxComputeResource	string	最大计算预留资源，单位为 ACU。	512ACU
ClusterSizeResource	string	预留参数，不涉及	预留参数，不涉及
MinClusterCount	integer	预留参数，不涉及	预留参数，不涉及
MaxClusterCount	integer	预留参数，不涉及	预留参数，不涉及
RunningClusterCount	integer	预留参数，不涉及	预留参数，不涉及
ClusterMode	string	预留参数，不涉及	预留参数，不涉及
ElasticMinComputeResource	string	最小计算弹性资源，单位为 ACU。	16ACU
EnableSpot	string	资源组是否开启竞价实例功能。开启竞价实例后资源单价降低，但是有概率被释放。取值： True：开启竞价实例功能。 False：关闭竞价实例功能。仅 Job 型资源组可以为 True。	True
GroupUsers	string	资源组绑定的 RAM 用户。	testb,testc
CreateTime	string	资源组创建时间，UTC 时间，格式为yyyy-MM-ddTHH:mm:ssZ。	2022-08-29T03:34:30Z
UpdateTime	string	更新时间，UTC 时间，格式为yyyy-MM-ddTHH:mm:ssZ。	2022-08-31T03:34:30Z
Status	string	资源组状态，取值说明： creating：创建中 ok：创建成功 pendingdelete：等待删除	ok
Rules	array<object>	作业投递规则。
	object	规则信息列表。
GroupName	string	资源组名称。	user_default
QueryTime	string	查询执行时间阈值，单位为毫秒（ms）。	180000
TargetGroupName	string	目标资源组名称。	job
Engine	string
Message	string
AutoStopInterval	string
SpecName	string
TargetResourceGroupName	string
MinGpuQuantity	integer
MaxGpuQuantity	integer
RayConfig	object
EnableUserEni	boolean
HeadSpecType	string
HeadSpec	string
HeadAllocateUnit	string
HeadDiskCapacity	string
Category	string
WorkerGroups	array<object>	Ray Worker 组列表
	object
GroupName	string	Ray Worker 组名	g01
AllocateUnit	string	分配单元	1
MaxWorkerQuantity	integer	最大 Worker 个数	1
MinWorkerQuantity	integer	最小 Worker 个数	1
WorkerDiskCapacity	string	每个 Worker 磁盘大小	100G
WorkerSpecName	string	Worker 资源型号	large
WorkerSpecType	string	Ray Worker 资源类型	CPU
RayClusterAddress	string	Ray Cluster 地址	http://ray-cluster-address.example.com
RayDashboardAddress	string	Ray Dashboard 地址	http://ray-dashboard-address.example.com
RayGrafanaAddress	string	Ray Grafana 地址	http://ray-grafana-address.example.com
AppConfig	object	Ray 应用配置
AppName	string	Ray 应用名	app01
AppType	string	Ray 应用类型	IsaacLab
ImageSelector	object	镜像配置
Image	string	镜像	lab2.10.0-ray2.43.0
InferenceEngine	string	推理引擎	vLLM
LlmModel	string	LLM 模型	Deepseek-R1
StorageMounts	array<object>	挂载存储列表
	object	挂载存储
StorageId	integer	存储 ID	1
MountPath	string	挂载路径	/mnt/data01
GpuElasticPlan	object
Enabled	boolean
Rules	array<object>
	object
StartCronExpression	string
EndCronExpression	string
EngineParams	object	引擎参数
	any	引擎参数

示例

正常返回示例

JSON格式

{
  "RequestId": "A94B6C02-7BD4-5D67-9776-3AC8317E8DD3",
  "GroupsInfo": [
    {
      "GroupType": "Job",
      "GroupName": "test1",
      "MinComputeResource": "0ACU",
      "MaxComputeResource": "512ACU",
      "ClusterSizeResource": "预留参数，不涉及",
      "MinClusterCount": 0,
      "MaxClusterCount": 0,
      "RunningClusterCount": 0,
      "ClusterMode": "预留参数，不涉及",
      "ElasticMinComputeResource": "16ACU",
      "EnableSpot": "True",
      "GroupUsers": "testb,testc",
      "CreateTime": "2022-08-29T03:34:30Z",
      "UpdateTime": "2022-08-31T03:34:30Z",
      "Status": "ok",
      "Rules": [
        {
          "GroupName": "user_default",
          "QueryTime": "180000",
          "TargetGroupName": "job"
        }
      ],
      "Engine": "",
      "Message": "",
      "AutoStopInterval": "",
      "SpecName": "",
      "TargetResourceGroupName": "",
      "MinGpuQuantity": 0,
      "MaxGpuQuantity": 0,
      "RayConfig": {
        "EnableUserEni": true,
        "HeadSpecType": "",
        "HeadSpec": "",
        "HeadAllocateUnit": "",
        "HeadDiskCapacity": "",
        "Category": "",
        "WorkerGroups": [
          {
            "GroupName": "g01",
            "AllocateUnit": "1",
            "MaxWorkerQuantity": 1,
            "MinWorkerQuantity": 1,
            "WorkerDiskCapacity": "100G",
            "WorkerSpecName": "large",
            "WorkerSpecType": "CPU"
          }
        ],
        "RayClusterAddress": "http://ray-cluster-address.example.com",
        "RayDashboardAddress": "http://ray-dashboard-address.example.com",
        "RayGrafanaAddress": "http://ray-grafana-address.example.com",
        "AppConfig": {
          "AppName": "app01",
          "AppType": "IsaacLab",
          "ImageSelector": {
            "Image": "lab2.10.0-ray2.43.0",
            "InferenceEngine": "vLLM",
            "LlmModel": "Deepseek-R1"
          }
        },
        "StorageMounts": [
          {
            "StorageId": 1,
            "MountPath": "/mnt/data01"
          }
        ]
      },
      "GpuElasticPlan": {
        "Enabled": true,
        "Rules": [
          {
            "StartCronExpression": "",
            "EndCronExpression": ""
          }
        ]
      },
      "EngineParams": {
        "key": ""
      }
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidPoolName.Malformed	The specified parameter PoolName is not valid.	PoolName参数不正确，请确认参数是否符合规范。
400	InvalidPoolUser.Malformed	The specified parameter PoolUser is not valid.	PoolUser参数不正确，请确认参数是否符合规范。
400	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	DBClusterId参数不正确，请确认参数是否符合规范。
400	InvalidPoolType.Malformed	The specified parameter PoolType is not valid.	PoolType参数不正确，请确认参数是否符合规范。
400	InvalidMinComputeResource.Malformed	The specified parameter MinComputeResource is not valid.	MinComputeResource参数不正确，请确认参数是否符合规范。
400	InvalidMaxComputeResource.Malformed	The specified parameter MaxComputeResource is not valid.	MaxComputeResource参数不正确，请确认参数是否符合规范。
408	AcsServerTimeOut	The request has failed due to Adb Cloud Service time out.	后端服务超时,请稍后尝试。

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

变更历史

更多信息，参考变更详情。