有奖捉虫:办公协同&微信生态&物联网文档专题 HOT
文档中心 > 主机安全 > API 文档 > 高级防御相关接口 > 网页防篡改获取区域主机列表

1. 接口描述

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

用于网页防篡改获取区域主机列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMachineList。
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 AssetFilters 过滤条件。
  • Keywords - String - 是否必填:否 - 查询关键字
  • Status - String - 是否必填:否 - 客户端在线状态(OFFLINE: 离线 | ONLINE: 在线 | UNINSTALLED:未安装)
  • Version - String 是否必填:否 - 当前防护版本( PRO_VERSION:专业版 | BASIC_VERSION:基础版)

  • 每个过滤条件只支持一个值,暂不支持多个值“或”关系查询
    示例值:[]

    3. 输出参数

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

    4. 示例

    示例1 获取区域主机列表

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

    输入示例

    POST / HTTP/1.1
    Host: cwp.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeMachineList
    <公共请求参数>
    
    {
        "MachineType": "CVM",
        "MachineRegion": "ap-guangzhou"
    }

    输出示例

    {
        "Response": {
            "Machines": [
                {
                    "MachineName": "ccs_cls-i4vyo8qa_node",
                    "MachineIp": "0.0.0.0",
                    "MachineWanIp": "0.0.0.0",
                    "MachineOs": "ubuntu16.04.1 LTSx86_64",
                    "MachineStatus": "OFFLINE",
                    "Quuid": "fbd6ea2c-1894-47b0-bf3e-095c78138f76",
                    "Uuid": "",
                    "IsProVersion": false,
                    "PayMode": "",
                    "VulNum": 0,
                    "Tag": [],
                    "MalwareNum": 0,
                    "CyberAttackNum": 0,
                    "SecurityStatus": "SAFE",
                    "InstanceState": "TERMINATED_PRO_VERSION",
                    "ProjectId": 1,
                    "HasAssetScan": 1,
                    "LicenseStatus": 0,
                    "InvasionNum": 0,
                    "BaselineNum": 0,
                    "RegionInfo": {
                        "RegionCode": "gz",
                        "Region": "ap-guangzhuo",
                        "RegionId": 1,
                        "RegionName": "广州",
                        "RegionNameEn": "chine guangzhou"
                    },
                    "MachineType": "CVM"
                }
            ],
            "TotalCount": 1,
            "RequestId": "c30f35cb-2f3e-94f5-59ae-316e0f32e660"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.APIServerFail 调用API服务失败。
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameter.InvalidFormat 参数格式错误。
    InvalidParameter.MissingParameter 参数缺失。
    InvalidParameter.ParsingError 参数解析错误。
    InvalidParameterValue 参数取值错误。
    MissingParameter 缺少参数错误。