帮你快速理解、总结文档立即下载

查询可更新补丁主机信息

最近更新时间:2026-08-11 01:39:08
我的收藏

1. 接口描述

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

查询指定KB补丁可以更新的主机列表。用于Windows系统补丁修复场景,在用户提交KB补丁更新任务前,查询哪些主机缺少该补丁且支持自动更新。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeKBUpdatableMachineList。
Version String 公共参数,本接口取值:2022-11-21。
Region String 公共参数,此参数为可选参数。
KBIds.N Array of Integer

KB补丁ID列表,最多支持100个


示例值:[20001, 20002]
Offset Integer

分页偏移量
取值范围:[0, +∞)
默认值:0


示例值:0
Limit Integer

每页返回数量
取值范围:[1, 100]
默认值:10


示例值:10
Filters.N Array of Filters

过滤条件
支持的Filter.Name:
InstanceId - 精确匹配,按主机实例ID筛选
MachineName - 模糊匹配,按主机名称搜索
MachineIp - 模糊匹配,按主机IP搜索
SupportAutoFix - 精确匹配,按是否支持自动修复筛选:0-不支持 1-支持

MemberId.N Array of String 集团账号的成员id
示例值:["mem-tencent-6f5795752f66e429"]

3. 输出参数

参数名称 类型 描述
Data Array of KBUpdateMachineItem

可更新补丁主机列表

TotalCount Integer

总数量


示例值:8
FixableCount Integer

可一键修复的主机数量


示例值:6
NotFixableCount Integer

不可一键修复的主机数量


示例值:2
KBSummary Array of KBFixSummaryItem

KB补丁维度汇总信息,展示被修复的补丁列表概要

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询可更新补丁主机列表

输入示例

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

{
    "KBIds": [
        20001,
        20002
    ],
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "Data": [
            {
                "KBId": 20001,
                "InstanceId": "ins-e5f6g7h8",
                "MachineName": "win-server-01",
                "MachineIp": "10.0.1.50",
                "PublicIp": "203.0.113.20",
                "OsName": "Windows Server 2019",
                "MachineStatus": "ONLINE",
                "SupportAutoFix": 1,
                "FixStatus": 0,
                "LatestFixTime": "",
                "NotFixableReason": "",
                "TagItems": [],
                "AppId": 1251234567,
                "PayVersion": "ULTIMATE"
            }
        ],
        "TotalCount": 1,
        "FixableCount": 1,
        "NotFixableCount": 0,
        "KBSummary": [
            {
                "KBId": 20001,
                "KBName": "Windows 10 Version 22H2 累计更新",
                "KBNo": "KB5377343",
                "RelatedVulCount": 3,
                "AffectedCount": 1,
                "NeedReboot": true,
                "KBPreCondition": ""
            }
        ],
        "RequestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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