tencent cloud

APIs

DocumentaçãoAPIsCloud Security CenterVulnerability Governance APIsDescribeKBUpdatableMachineList

DescribeKBUpdatableMachineList

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-01 10:18:45

1. API Description

Domain name for API request: csip.intl.tencentcloudapi.com.

Query the list of hosts that can update a specified KB patch. This API is used for Windows patch repair scenarios to query which hosts lack the patch and support auto-update before user-submitted KB patch update tasks.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeKBUpdatableMachineList.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
KBIds.N Yes Array of Integer

KB patch ID list, supports up to 100
Offset No Integer

Paging offset
Value range: [0, +∞)
Default value: 0
Limit No Integer

Number of results per page
Value range: [1, 100]
Default value: 10
Filters.N No Array of Filters

Filter criteria
Supported Filter.Name:
InstanceId - exact match, filter by host instance ID
MachineName - fuzzy match, search by host name
MachineIp - fuzzy match, search by host IP
SupportAutoFix - exact match, filter by whether automatic fixing is supported: 0-unsupported 1-supported
MemberId.N No Array of String Group Account Member ID

3. Output Parameters

Parameter Name Type Description
Data Array of KBUpdateMachineItem

Host list for patch updates
TotalCount Integer

Total quantity.
FixableCount Integer

Number of hosts that can be repaired in one click
NotFixableCount Integer

Number of hosts that cannot be repaired with one click
KBSummary Array of KBFixSummaryItem

KB patch dimensional summary, showing an overview of the repaired patch list
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Query the host list for available update patches

Input Example

POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeKBUpdatableMachineList
<Common request parameters>

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

Output Example

{
    "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 cumulative update"
                "KBNo": "KB5377343",
                "RelatedVulCount": 3,
                "AffectedCount": 1,
                "NeedReboot": true,
                "KBPreCondition": ""
            }
        ],
        "RequestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Anterior: StopVulScanTaskPróximo: DescribeKBDetail

Ajuda e Suporte

Esta página foi útil?

comentários