主机安全查询Windows补丁影响的主机

1. 接口描述

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

查询补丁影响的主机信息列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribePatchEffectHostList。
Version	是	String	公共参数，本接口取值：2018-02-28。
Region	否	String	公共参数，此参数为可选参数。
KbId	是	Integer	补丁id 示例值：782334
Limit	是	Integer	分页limit 最大100 示例值：10
Offset	是	Integer	分页偏移量示例值：0
Filters.N	否	Array of Filter	过滤条件： HostVersion : uint64类型非必填版本信息 : 0-基础版 1-专业版 2-旗舰版 3-轻量版 InstanceState : string类型非必填主机状态 : "PENDING"-创建中 "LAUNCH_FAILED"-创建失败 "RUNNING"-运行中 "STOPPED"-关机 "STARTING"-开机中 "STOPPING"-关机中 "REBOOTING"-重启中 "SHUTDOWN"-待销毁 "TERMINATING"-销毁中 "UNKNOWN"-未知（针对非腾讯云机器，且客户端离线的场景） Status : uint64类型非必填处理状态 0表示待处理，1表示忽略，3表示已修复 HostName : string类型非必填主机名称 InstanceID : string类型非必填主机id IpAddress : string类型非必填主机的ip地址 Uuid : string类型非必填主机uuid

3. 输出参数

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

4. 示例

示例1 查询Windows补丁影响的主机

查询Windows补丁影响的主机

输入示例

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

{
    "KbId": 7070,
    "Limit": 10,
    "Offset": 0,
    "Filters": [
        {
            "Name": "Status",
            "Values": [
                "0"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "PatchEffectHostList": [
            {
                "FirstScanTime": "2025-07-29 16:30:17",
                "FixStatus": 0,
                "HasSnapshot": 0,
                "HostVersion": 2,
                "Id": 73,
                "InstanceState": "运行中",
                "KbId": 7070,
                "LatestFixTime": "2025-07-29 16:30:17",
                "LatestScanTime": "2025-07-31 14:28:50",
                "MachineExtraInfo": {
                    "HostName": "v_llwin",
                    "InstanceID": "ins-r3qao",
                    "NetworkName": "vpc-guv4i1h5",
                    "NetworkType": 1,
                    "PrivateIP": "10.6.64.8",
                    "WanIP": "119.45.128.17"
                },
                "MachineType": "CVM",
                "Quuid": "ea71992a-b484-4d9c-882a-419fb6d0a5b0",
                "RegionId": 33,
                "RestartRequired": 0,
                "Status": 0,
                "Uuid": "ea71992a-b484-4d9c-882a-419fb6d0a5b0"
            }
        ],
        "RequestId": "475a2160-cc47-43e9-a576-ec0947badb37",
        "TotalCount": 1
    }
}

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. 错误码

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

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