获取区域主机列表

最近更新时间: 2026-09-17 00:02:49

1. 接口描述

接口请求域名： cwp.api3.fincloud.tencent.cn。

本接口 (DescribeMachines) 用于获取区域主机列表。

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

接口更新时间：2022-10-18 17:27:47。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeMachines
Version 是 否 String 公共参数，本接口取值：2018-02-28
Region 是 否 String 公共参数，地域信息本接口不需要传递此参数。
Filters 否 否 Array of Filter 过滤条件。
  • Ips - String - 是否必填：否 - 通过ip查询 
  • Names - String - 是否必填：否 - 通过实例名查询 
  • InstanceIds - String - 是否必填：否 - 通过实例id查询 
  • Status - String - 是否必填：否 - 客户端在线状态（OFFLINE: 离线/关机 
    		•
    Limit 否 否 Uint64 返回数量，默认为10，最大值为100。
    示例值： 10
    MachineRegion 是 否 String 机器所属地域
    示例值： ap-region1
    MachineType 是 否 String 机器所属专区类型 
    CVM 云服务器
    BM 黑石
    ECM 边缘计算
    LH 轻量应用服务器
    Other 混合云专区
    示例值： CVM
    Offset 否 否 Uint64 偏移量，默认为0。
    示例值： 0
    ProjectIds 否 否 Array of Uint64 机器所属业务ID列表
    示例值： [1]

    3. 输出参数

    参数名称 类型 描述
    Machines Array of Machine 主机列表
    示例值：查看
    TotalCount Uint64 主机数量
    示例值： 10
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameter.ParsingError 参数解析错误。
    InvalidParameter.MissingParameter 参数缺失。
    InvalidParameter.InvalidFormat 参数格式错误。
    MissingParameter 缺少参数错误。
    InvalidParameter 参数错误。
    InvalidParameterValue 参数取值错误。

    5. 示例

    示例1 获取区域主机列表

    本接口 (DescribeMachines) 用于获取区域主机列表。

    输入示例

    POST / HTTP/1.1
Host: cwp.api3.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: DescribeMachines
<Public request parameters>

{
    "Limit": 10,
    "MachineRegion": "ap-city1",
    "MachineType": "CVM",
    "Filters": [
        {
            "Values": [
                "10.0.1.1"
            ],
            "Name": "Keywords"
        }
    ],
    "Offset": 0
}

    输出示例

    {"Response ":{" Machines":[{"BaselineNum ": 0," CloudFrom ": 0," CloudTags ":[{" TagKey":"Department","TagValue":"dev "}]," CyberAttackNum ": 0," HasAssetScan ": 0," InstanceId ":"ins-111","InstanceState":"NORMAL","InvasionNum": 3,"IpList":"www.example.com","IsAddedOnTheFifteen": 1,"IsProVersion": false,"KernelVersion":" 3.10.0 - 1160.88.1.el7.x86_64 "," LicenseStatus ": 0," MachineExtraInfo ":{"HostName":"demo-instance","InstanceID":" ins-111"," NetworkName":" vpc-111"," NetworkType": 1," PrivateIP":" www.example.com"," WanIP":" 111 "}," MachineIp":" 1.1.1.1"," MachineName":" name01"," MachineOs":" CentOS 7.6 64-bit"," MachineStatus":" ONLINE"," MachineType":" CVM"," MachineWanIp":" 1.1.1.1"," MalwareNum": 0," PayMode":" POSTPAY"," ProjectId": 0," ProtectType":1.1.1.1