云数据库独享集群查询集群资源信息

1. 接口描述

接口请求域名： dbdc.tencentcloudapi.com 。

该接口（DescribeDBCustomClusterResources）用于查询 DB Custom 集群的资源信息。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDBCustomClusterResources。
Version	是	String	公共参数，本接口取值：2020-10-29。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-bangkok, ap-nanjing, ap-shanghai 。
ClusterId	是	String	集群ID 示例值：dbcc-sizxd0hi

3. 输出参数

参数名称	类型	描述
NodeCount	Integer	参与汇总的工作节点总数（不含控制面节点）单位：台示例值：2
Capacity	MetaResource	集群所有节点的资源物理总容量之和
Allocatable	MetaResource	集群所有节点的可分配容量之和（= Capacity - 系统预留）
Requests	MetaResource	集群所有非终态 Pod 的 requests 申请量之和（含系统 Pod）
Limits	MetaResource	集群所有非终态 Pod 的 limits 上限之和（含系统 Pod，Pods 字段无语义，固定为 0）
Available	MetaResource	集群可再调度余量（所有节点 max(0, Allocatable - Requests) 累加求和）
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询集群的资源分配信息

本接口（DescribeDBCustomClusterResources）用户查询DB Custom 集群的资源分配详情

输入示例

POST / HTTP/1.1
Host: dbdc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBCustomClusterResources
<公共请求参数>

{
    "ClusterId": "dbcc-sizxd0hi"
}

输出示例

{
    "Response": {
        "Allocatable": {
            "Cpu": 3.86,
            "Memory": 2.572,
            "Pods": 506
        },
        "Available": {
            "Cpu": 3.6,
            "Memory": 2.387,
            "Pods": 494
        },
        "Capacity": {
            "Cpu": 4,
            "Memory": 3.768,
            "Pods": 506
        },
        "Limits": {
            "Cpu": 15.2,
            "Memory": 14.763,
            "Pods": 0
        },
        "NodeCount": 2,
        "Requests": {
            "Cpu": 0.26,
            "Memory": 0.186,
            "Pods": 12
        },
        "RequestId": "98a6ae66-bfb9-4515-83ce-36f163cb59f9"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation	请求未授权。请参考 CAM 文档对鉴权的说明。
FailedOperation	操作失败。
InvalidParameterValue	参数取值错误。

查询集群资源信息

本页目录：