云数据库独享集群
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云数据库独享集群 > API 文档 > 独享集群相关接口 > 查询主机列表

查询主机列表

最近更新时间：2024-03-12 01:24:54

我的收藏

本页目录：

1. 接口描述

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

本接口用于查询主机列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeHostList。
Version 是 String 公共参数，本接口取值：2020-10-29。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 独享集群实例Id
示例值：dbdc-test
Limit 否 Integer 分页返回数量
示例值：1000
Offset 否 Integer 分页偏移量
示例值：1
AssignStatus.N 否 Array of Integer 分配状态过滤，0-可分配，1-禁止分配
示例值：[0]

3. 输出参数

参数名称 类型 描述
TotalCount Integer 主机总数
示例值：1
Hosts Array of HostDetail 主机详情
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询主机列表

输入示例

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

{
    "InstanceId": "dbdc-test"
}

输出示例

{
    "Response": {
        "TotalCount": 2,
        "Hosts": [
            {
                "Status": 1,
                "DbNum": 0,
                "DiskSpec": 6000,
                "Zone": "ap-guangzhou-1",
                "CpuAssignable": 32,
                "DiskAssignable": 3000,
                "DiskAssigned": 0,
                "AssignStatus": 0,
                "HostType": 0,
                "DiskRatio": 0.5,
                "CpuSpec": 32,
                "MemoryAssigned": 0,
                "HostId": "svr-kbpiagjd",
                "MemoryAssignable": 128,
                "MemorySpec": 128,
                "HostName": "svr-kbpiagjd",
                "MemoryRatio": 1,
                "CpuRatio": 1,
                "CpuAssigned": 0,
                "MachineName": "HYI12A",
                "MachineType": "SH12",
                "PidTag": "excluster_xxx",
                "Pid": 10811
            },
            {
                "Status": 1,
                "DbNum": 0,
                "DiskSpec": 6000,
                "Zone": "ap-guangzhou-1",
                "CpuAssignable": 32,
                "DiskAssignable": 3000,
                "DiskAssigned": 0,
                "AssignStatus": 0,
                "HostType": 0,
                "DiskRatio": 0.5,
                "CpuSpec": 32,
                "MemoryAssigned": 0,
                "HostId": "svr-7oefkrrn",
                "MemoryAssignable": 128,
                "MemorySpec": 128,
                "HostName": "svr-7oefkrrn",
                "MemoryRatio": 1,
                "CpuRatio": 1,
                "CpuAssigned": 0,
                "MachineName": "HYI12A",
                "MachineType": "SH12",
                "PidTag": "excluster_xxx",
                "Pid": 10811
            }
        ],
        "RequestId": "58520b56-b1ff-11eb-90cd-525400542aa6"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
DryRunOperation DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation.QueryResourceError 查询资源信息失败。
FailedOperation.QuerySpecInfoError 获取独享集群规格信息失败。
InvalidParameterValue.InvalidParameterValueError 参数值传入错误。
ResourceUnavailable.ResourceStatusAbnormalError 资源状态异常。
中国站