云安全中心查询主机列表

1. 接口描述

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

主机列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCWPMachines。
Version	是	String	公共参数，本接口取值：2022-11-21。
Region	否	String	公共参数，此参数为可选参数。
MemberId.N	否	Array of String	集团账号的成员id 示例值：["mem-a1f"]
Filter	否	Filter	一、主表字段筛选（需要指定 OperatorType） MachineName：主机名称，支持 OperatorType 9(模糊)、7(IN)，Values示例：["test-server"] MachineIp：内网IP，支持 OperatorType 9(模糊)、7(IN)，Values示例：["10.0.0.1"] MachineWanIp：外网IP，支持 OperatorType 9(模糊)、7(IN)，Values示例：["1.2.3.4"] InstanceID：实例ID，支持 OperatorType 9(模糊)、7(IN)，Values示例：["ins-xxxxx"] MachineStatus / InstanceStatus：实例状态，支持 OperatorType 7(IN)、1(等于)，Values示例：["RUNNING"]，可选值：RUNNING/STOPPED/EXPIRED MachineOs：操作系统类型，支持 OperatorType 7(IN)，Values示例：["1"]，值为数字编码，见下方OsType说明 VpcId：VPC ID，支持 OperatorType 7(IN)、1(等于)，Values示例：["vpc-xxxxx"] CloudFromEnum：云服务商，支持 OperatorType 7(IN)、1(等于)，Values示例：["0"]，值为数字编码，见下方CloudFrom说明 Region ：地域，支持 OperatorType 7(IN)、1(等于)，Values示例：["ap-guangzhou"] AppId：账号AppId，支持 OperatorType 7(IN)、1(等于)，Values示例：["1234567890"] ProjectId：项目ID，支持 OperatorType 7(IN)、1(等于)，Values示例：["0"] 二、预筛选字段（不需要指定 OperatorType） AgentStatus：Agent状态，单选，Values示例：["ONLINE"]，可选值：ONLINE/OFFLINE/UNINSTALL ProtectType：防护类型（综合），Values示例：["ULTIMATE"]，可选值：BASIC/PRO/ULTIMATE/NONE CsipProtectType：CSIP防护类型，Values示例：["ULTIMATE"]，可选值：BASIC/PRO/ULTIMATE/NONE CloudTags：云标签，Values示例：["tagKey$tagValue"]，格式：tagKey$tagValue 或 tagKey（只匹配key），最多5个值 Tags：资产标签，Values示例：["123"]，值为标签ID ExposedStatus：暴露状态，单选，Values示例：["EXPOSED"]，可选值：NOT_APPLICABLE/EXPOSED/UNEXPOSED 三、特殊筛选字段（不需要指定 OperatorType） NetworkType：网络类型，单选，Values示例：["1"]，1=VPC网络, 2=基础网络, 3=非腾讯云网络 MachineType：机器类型，可多选，Values示例：["CVM"]，可选值：CVM/BM/ECM/LH/EKS-NATIVE/ECS/EC2/VMS Common：通用搜索，单选，Values示例：["关键词"]，同时对内网IP、外网IP、主机名称、实例ID做模糊匹配
NeedTatStatus	否	Boolean	是否需要tat状态信息示例值：true
MoreInformation	否	Boolean	是否需要额外信息，如安全中心标签、腾讯云标签示例值：true
NeedContainerInfo	否	Boolean	是否需要容器信息，如容器数、核数、容器防护状态示例值：true

3. 输出参数

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

4. 示例

示例1 1

输入示例

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

{
    "MemberId": [
        "mem-a1f"
    ],
    "Filter": {
        "Limit": 100
    },
    "NeedTatStatus": true,
    "MoreInformation": true,
    "NeedContainerInfo": true
}

输出示例

{
    "Response": {
        "Machines": [
            {
                "AgentStatus": "ONLINE",
                "AgentVersion": "5.4.4.133",
                "AppId": 260083796,
                "CloudFromEnum": "Tencent",
                "ContainerCount": 0,
                "ContainerDefendStatus": "Unknown",
                "CpuCoreCount": 2,
                "CsipProtectType": "BASIC",
                "ExposedStatus": "NONE",
                "InstanceID": "ins-*****nsn",
                "InstanceStatus": "RUNNING",
                "IpList": [
                    "fe80:************acc:c330"
                ],
                "IsNew": true,
                "KernelVersion": "6.6.117-45.7.3.tl4.x86_64",
                "LatestOfflineTime": 1781545140,
                "MachineIp": "10.216.0.85",
                "MachineName": "VM-0-85-tencentos",
                "MachineOs": "TencentOS Server 4",
                "MachineWanIp": "10*.******.*11",
                "NodeType": "NONE",
                "PayMode": "PREPAID",
                "ProjectId": 0,
                "ProtectType": "ULTIMATE",
                "Quuid": "969faa98-**************-55cf8ed1eccf",
                "RegionInfo": {
                    "Region": "ap-others",
                    "RegionCode": "others",
                    "RegionId": 47,
                    "RegionName": "其他地域（其他）",
                    "RegionNameEn": "Others (Other)"
                },
                "Remark": "",
                "TagModifyInfo": {
                    "AppID": 260083796,
                    "AssetType": "server_host",
                    "InstanceID": "ins-*****nsn",
                    "Provider": "tencent"
                },
                "TatStatus": "",
                "Uuid": "969faa98-***************55cf8ed1eccf",
                "VpcId": "vpc-j*****ox"
            }
        ],
        "Total": 18,
        "RequestId": "44f9ea21-c601-4974-b550-5bb988de4168"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

查询主机列表

本页目录：