文档

DescribeDBResourceGroup - 查询资源组

更新时间:

查询AnalyticDB MySQL湖仓版(3.0)集群的资源组信息。

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

AnalyticDB MySQL 湖仓版(3.0)集群 ID。

amv-bp11q28kvl688****
GroupNamestring

资源组名称。

说明 此参数不填写时,默认返回指定集群的所有资源组信息。
test_group
GroupTypestring

资源组类型,取值:

  • Interactive
  • Job
说明 关于湖仓版资源组的详细信息,请参见资源组介绍(湖仓版)
Job
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看集群的地域 ID。
cn-hangzhou

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

A94B6C02-7BD4-5D67-9776-3AC8317E8DD3
GroupsInfoobject []

资源组信息列表。

GroupTypestring

资源组类型,取值:

  • Interactive
  • Job
说明 关于湖仓版资源组的详细信息,请参见资源组介绍(湖仓版)
Job
GroupNamestring

资源组名称。

test1
MinComputeResourcestring

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

0ACU
MaxComputeResourcestring

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

512ACU
ClusterSizeResourcestring

预留参数,不涉及

预留参数,不涉及
MinClusterCountinteger

预留参数,不涉及

预留参数,不涉及
MaxClusterCountinteger

预留参数,不涉及

预留参数,不涉及
RunningClusterCountinteger

预留参数,不涉及

预留参数,不涉及
ClusterModestring

预留参数,不涉及

预留参数,不涉及
ElasticMinComputeResourcestring

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

16ACU
EnableSpotstring

资源组是否开启竞价实例功能。开启竞价实例后资源单价降低,但是有概率被释放。取值:

  • True:开启竞价实例功能。
  • False:关闭竞价实例功能。

仅 Job 型资源组可以为 True。

True
GroupUsersstring

资源组绑定的 RAM 用户。

testb,testc
CreateTimestring

资源组创建时间,UTC 时间,格式为yyyy-MM-ddTHH:mm:ssZ

2022-08-29T03:34:30Z
UpdateTimestring

更新时间,UTC 时间,格式为yyyy-MM-ddTHH:mm:ssZ

2022-08-31T03:34:30Z
Statusstring

资源组状态,取值说明:

  • creating:创建中
  • ok:创建成功
  • pendingdelete:等待删除
ok
Rulesobject []

作业投递规则。

GroupNamestring

资源组名称。

user_default
QueryTimestring

查询执行时间阈值,单位为毫秒(ms)。

180000
TargetGroupNamestring

目标资源组名称。

job

示例

正常返回示例

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"
        }
      ]
    }
  ]
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-03-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:408
出参OpenAPI 返回结构发生变更
2024-03-01OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:408
入参OpenAPI 入参发生变更
    新增入参:RegionId
2024-01-26OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:408
出参OpenAPI 返回结构发生变更
2023-09-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:408
出参OpenAPI 返回结构发生变更
2023-03-31OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:408
    新增错误码:400
  • 本页导读 (1)
文档反馈