DescribeClusterResourceUsage - 查询集群资源使用情况

更新时间: 2024-11-08 17:14:39

调用DescribeClusterResourceUsage接口查询集群资源使用情况。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看集群 ID。
amv-bp11q28kvl688****
StartTimestring

查询开始时间,UTC 时间,格式:yyyy-MM-ddTHH:mmZ

2022-11-29T10:20Z
EndTimestring

查询结束时间,UTC 时间,格式:yyyy-MM-ddTHH:mmZ。

2022-08-22T01:06:00Z

返回参数

名称类型描述示例值
object

PlainResponse

RequestIdstring

请求 ID。

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

接口状态或 POP 错误码。

200
Dataobject

集群资源使用详情。

DBClusterIdstring

集群 ID。

amv-uf6dj23rt5zo9s9d
StartTimestring

查询开始时间,UTC 时间,格式:yyyy-MM-ddTHH:mmZ

2023-03-14T03:42:15Z
EndTimestring

查询结束时间,UTC 时间,格式:yyyy-MM-ddTHH:mmZ

2023-03-23T02:31Z
AcuInfoarray<object>

集群 ACU 资源使用情况。

acuInfoobject
Namestring

对应指标项取值的状态,取值说明:

  • TotalAcuNumber:总 ACU 资源数。
  • ReservedAcuNumber:预留资源 ACU 数。
  • ReservedAcuUsageNumber:已使用的预留资源 ACU 数。
TotalAcuNumber
Valuesarray

对应指标项在各时间点的具体取值。

valuestring

不同时间点下的性能值详情。

16.0

示例

正常返回示例

JSON格式

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEAW",
  "Code": 200,
  "Data": {
    "DBClusterId": "amv-uf6dj23rt5zo9s9d",
    "StartTime": "2023-03-14T03:42:15Z",
    "EndTime": "2023-03-23T02:31Z",
    "AcuInfo": [
      {
        "Name": "TotalAcuNumber",
        "Values": [
          "16.0"
        ]
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-12-06API 内部配置变更,不影响调用查看变更详情
上一篇: DescribeDBClusterPerformance - 查看集群性能数据 下一篇: DescribeClusterResourceDetail - 查询集群资源具体使用详情
阿里云首页 云原生数据仓库AnalyticDB MySQL版 相关技术圈