有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口 (DescribeChcHosts) 用于查询一个或多个CHC物理服务器详细信息。

  • 可以根据实例ID、实例名称或者设备类型等信息来查询实例的详细信息。过滤信息详细请见过滤器Filter
  • 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的实例。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeChcHosts。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
ChcIds.N Array of String CHC物理服务器实例ID。每次请求的实例的上限为100。参数不支持同时指定ChcIdsFilters
示例值:['chc-1a2b3c4d']
Filters.N Array of Filter
  • zone

  • 按照【可用区】进行过滤。可用区形如:ap-guangzhou-1。

    类型:String

    必选:否

    可选项:可用区列表


  • instance-name

  • 按照【实例名称】进行过滤。

    类型:String

    必选:否


  • instance-state

  • 按照【实例状态】进行过滤。状态类型详见实例状态表

    类型:String

    必选:否


  • device-type

  • 按照【设备类型】进行过滤。

    类型:String

    必选:否


  • vpc-id

  • 按照【私有网络唯一ID】进行过滤。

    类型:String

    必选:否


  • subnet-id

  • 按照【私有子网唯一ID】进行过滤。

    类型:String

    必选:否


    示例值:NA
    Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    示例值:1
    Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
    示例值:10

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的实例数量。
    示例值:5
    ChcHostSet Array of ChcHost 返回的实例列表
    示例值:NA
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查看CHC物理服务器实例

    根据CHC物理服务器ID查看实例

    输入示例

    POST / HTTP/1.1
    Host: cvm.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeChcHosts
    <公共请求参数>
    
    {
        "ChcIds": [
            "chc-1a2b3c4d"
        ]
    }

    输出示例

    {
        "Response": {
            "ChcHostSet": [
                {
                    "ChcId": "chc-1a2b3c4d",
                    "InstanceName": "托管服务器",
                    "SerialNumber": "sn34asdfabd",
                    "InstanceState": "RUNNING",
                    "DeviceType": "CHC_HS1",
                    "Placement": {
                        "Zone": "ap-guangzhou-2"
                    },
                    "BmcVirtualPrivateCloud": {
                        "SubnetId": "subnet-a2676p0e",
                        "VpcId": "vpc-g7wzcv7n"
                    },
                    "BmcIp": "10.12.10.34",
                    "BmcSecurityGroupIds": [
                        "sg-1a2b3c4d"
                    ],
                    "DeployVirtualPrivateCloud": {
                        "SubnetId": "subnet-a26734fs",
                        "VpcId": "vpc-g7wz234f"
                    },
                    "DeployIp": "10.12.20.34",
                    "DeploySecurityGroupIds": [
                        "sg-1a2b34af"
                    ],
                    "CvmInstanceId": "ins-1a2bafst",
                    "CreatedTime": "2020-03-10T02:43:51Z",
                    "HardwareDescription": "50C 128G 12*4T",
                    "Memory": 128,
                    "DeployMAC": "52:54:00:68:CC:00",
                    "BmcMAC": "52:54:00:68:CC:01",
                    "Disk": "12*4T",
                    "CPU": 50
                }
            ],
            "TotalCount": 2,
            "RequestId": "62DDFFC6-FDB5-44F7-20A6-59152E3D129A"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    AccountQualificationRestrictions 该请求账户未通过资格审计。
    InvalidFilter 无效的过滤器。
    InvalidFilterValue.LimitExceeded Filter
    InvalidParameter.AtMostOne 最多指定一个参数。
    InvalidParameterValue.ChcHostsNotFound 找不到对应的CHC物理服务器。
    InvalidParameterValue.IncorrectFormat 传参格式不对。
    InvalidParameterValue.NotEmpty 输入参数值不能为空。
    InvalidParameterValue.Range 无效参数值。参数值取值范围不合法。
    InvalidParameterValue.SubnetIdMalformed 子网ID不合要求,请提供规范的子网ID,类似subnet-xxxxxxxx,字母x代表小写字符或者数字
    InvalidParameterValue.VpcIdMalformed VPC IDxxx不合要求,请提供规范的Vpc ID, 类似vpc-xxxxxxxx,字母x代表小写字符或者数字。
    InvalidParameterValueLimit 参数值数量超过限制。
    InvalidParameterValueOffset 无效参数值。指定的 Offset 无效。
    InvalidZone.MismatchRegion 指定的zone不存在。
    MissingParameter 缺少参数错误。