DescribeClusterResourceDetail - 查询集群资源具体使用详情

更新时间:

查询集群资源具体使用详情。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 集群的详情,包括集群 ID。
am-bp1jj9xqft1po****

返回参数

名称类型描述示例值
object

PlainResponse

RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
Codeinteger

接口状态或 POP 错误码。

200
Dataobject

集群资源具体使用详情。

DBClusterIdstring

集群 ID。

amv-adbxxxxx
ComputeResourcestring

计算预留资源。取值范围:0ACU~4096ACU,步长:16。1 ACU 约等于 1 核 4 GB。

16ACU
FreeComputeResourcestring

空闲计算预留资源。取值范围:0ACU~4096ACU,步长:16。1 ACU 约等于 1 核 4 GB。

0ACU
StorageResourcestring

存储预留资源。取值范围:0ACU~2064ACU,步长:24。1 ACU 约等于 1 核 4 GB。

24ACU
ResourceGroupListarray<object>

资源组列表。

resourceGroupListobject
PoolIdlong

资源组 ID。

17
PoolNamestring

资源组名称。

testadb
PoolTypestring

资源组类型。

interactive
MinComputeResourcestring

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

16ACU
MaxComputeResourcestring

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

128ACU
PoolUsersstring

资源组用户。

user1
Statusstring

资源组状态,取值说明:

  • running:运行中
  • deleting:删除中
  • scaling:变配中
running
ClusterSizeResourcestring

预留参数(不涉及)

0
MinClusterCountinteger

预留参数(不涉及)

0
MaxClusterCountinteger

预留参数(不涉及)

0
RunningClusterCountinteger

预留参数(不涉及)

0
ClusterModestring

预留参数(不涉及)

0
EnableSpotboolean

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

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

仅 Job 型资源组可以为 True。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Code": 200,
  "Data": {
    "DBClusterId": "amv-adbxxxxx",
    "ComputeResource": "16ACU",
    "FreeComputeResource": "0ACU",
    "StorageResource": "24ACU",
    "ResourceGroupList": [
      {
        "PoolId": 17,
        "PoolName": "testadb",
        "PoolType": "interactive",
        "MinComputeResource": "16ACU",
        "MaxComputeResource": "128ACU",
        "PoolUsers": "user1",
        "Status": "running",
        "ClusterSizeResource": "0",
        "MinClusterCount": 0,
        "MaxClusterCount": 0,
        "RunningClusterCount": 0,
        "ClusterMode": "0",
        "EnableSpot": true
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-26OpenAPI 返回结构发生变更查看变更详情
2023-12-06API 内部配置变更,不影响调用查看变更详情