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

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMachines。
Version String 公共参数,本接口取值:2018-02-28。
Region String 公共参数,此参数为可选参数。
MachineType String 机器所属专区类型
CVM 云服务器
BM 黑石
ECM 边缘计算
LH 轻量应用服务器
Other 混合云专区
示例值:CVM
MachineRegion String 机器所属地域。如:ap-guangzhou,ap-shanghai
示例值:ap-guangzhou
Limit Integer 返回数量,默认为10,最大值为100。
示例值:10
Offset Integer 偏移量,默认为0。
示例值:0
Filters.N Array of Filter 过滤条件。
  • Ips - String - 是否必填:否 - 通过ip查询
  • Names - String - 是否必填:否 - 通过实例名查询
  • InstanceIds - String - 是否必填:否 - 通过实例id查询
  • Status - String - 是否必填:否 - 客户端在线状态(OFFLINE: 离线/关机 | ONLINE: 在线 | UNINSTALLED:未安装 | AGENT_OFFLINE 离线| AGENT_SHUTDOWN 已关机)
  • Version - String 是否必填:否 - 当前防护版本( PRO_VERSION:专业版 | BASIC_VERSION:基础版 | Flagship : 旗舰版 | ProtectedMachines: 专业版+旗舰版)
  • Risk - String 是否必填: 否 - 风险主机( yes )
  • Os -String 是否必填: 否 - 操作系统( DescribeMachineOsList 接口 值 )
    每个过滤条件只支持一个值,暂不支持多个值“或”关系查询
  • Quuid - String - 是否必填: 否 - 云服务器uuid 最大100条.
  • AddedOnTheFifteen- String 是否必填: 否 - 是否只查询15天内新增的主机( 1:是)
  • TagId- String 是否必填: 否 - 查询指定标签关联的主机列表

  • 示例值:[]
    ProjectIds.N Array of Integer 机器所属业务ID列表
    示例值:1

    3. 输出参数

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

    4. 示例

    示例1 获取区域主机列表

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

    输入示例

    POST / HTTP/1.1
    Host: cwp.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeMachines
    <公共请求参数>
    
    {
        "Limit": 10,
        "MachineRegion": "ap-shanghai",
        "MachineType": "CVM",
        "Filters": [
            {
                "Values": [
                    "10.0.1.1"
                ],
                "Name": "Keywords"
            }
        ],
        "Offset": 0
    }

    输出示例

    {
        "Response": {
            "Machines": [
                {
                    "MachineName": "test",
                    "MachineOs": "CentOS 7.6 64位",
                    "Uuid": "3377add2-ee61-4c9a-99a3-81d259dfc11a",
                    "Quuid": "3377add2-ee61-4c9a-99a3-81d259dfc11a",
                    "MachineIp": "1.1.1.1",
                    "MachineWanIp": "1.1.1.1",
                    "InstanceState": "NORMAL",
                    "InstanceId": "ins-111",
                    "ProjectId": 0,
                    "VpcId": "",
                    "IsProVersion": false,
                    "MachineStatus": "ONLINE",
                    "PayMode": "",
                    "Tag": [],
                    "CloudTags": null,
                    "MalwareNum": 0,
                    "VulNum": 0,
                    "BaselineNum": 0,
                    "CyberAttackNum": 0,
                    "InvasionNum": 3,
                    "SecurityStatus": "RISK",
                    "RegionInfo": {
                        "Region": "ap-nanjing",
                        "RegionName": "华东地区(南京)",
                        "RegionId": 33,
                        "RegionCode": "nj",
                        "RegionNameEn": "East China (Nanjing)"
                    },
                    "MachineType": "CVM",
                    "LicenseStatus": 0,
                    "HasAssetScan": 0,
                    "KernelVersion": "3.10.0-1160.88.1.el7.x86_64",
                    "ProtectType": "BASIC_VERSION",
                    "IsAddedOnTheFifteen": 1,
                    "IpList": "1.1.1.1",
                    "Remark": "",
                    "MachineExtraInfo": {
                        "WanIP": "1.1.1.1",
                        "PrivateIP": "1.1.1.1",
                        "NetworkType": 1,
                        "NetworkName": "vpc-111",
                        "InstanceID": "ins-111",
                        "HostName": ""
                    }
                }
            ],
            "RequestId": "621b6063-12b2-43fa-809e-5481c8374c0a",
            "TotalCount": 1
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

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