tencent cloud

APIs

DescribeVulFixStatus

Download
Focus Mode
Font Size
Last updated: 2026-06-08 10:19:14

1. API Description

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

This API is used to check the host vulnerability fixing progress.

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: DescribeVulFixStatus.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
FixId No Integer Task ID. This parameter can be left blank if VulId is specified.
VulId No Integer Vulnerability ID. This parameter can be left blank if FixId is specified.
Quuid No String Host QUUID. This parameter can be used together with VulId to query the details of the last fixing task on a specific host.
KbId No Integer Patch id

3. Output Parameters

Parameter Name Type Description
FixStartTime String Fixing start time
FixEndTime String Fixing end time. If this parameter is left blank, fixing is not ended.
FixSuccessCnt Integer Number of successfully fixed hosts
FixFailCnt Integer Number of hosts failed to be fixed
HostCnt Integer Total number of hosts
FixId Integer Fixing task ID
SnapshotList Array of VulFixStatusSnapshotInfo Status list of snapshots to be fixed
VulFixList Array of VulFixStatusInfo Details list of vulnerabilities to be fixed
SnapshotProgress Integer Snapshot creation progress (0-100)
FixProgress Integer Fixing progress (0-100).
RemainingTime Integer Estimated remaining time (seconds)
IsRetrySnapshot Integer Whether the snapshot is retried. 0: no; 1: yes.
SnapshotFailCnt Integer Snapshot creation failures
IsAllowRetry Integer Whether to allow retry 0: not allowed 1: allowed
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 Vulnerability Repair - Querying the Progress of Fixing Host Vulnerabilities

Input Example

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

{
    "FixId": "1"
}

Output Example

{
    "Response": {
        "FixEndTime": "2019-12-25 11:57:15",
        "SnapshotFailCnt": 1,
        "SnapshotList": [
            {
                "Status": 1,
"SnapshotName": "Snapshot name"
"HostName": "machine name",
                "FailReason": "success",
                "Quuid": "05f0bcab-726c-4ea4-8109-bcd03d5598f7",
                "ModifyTime": "2019-12-25 11:57:15",
"SnapshotId": "snapshot ID",
                "HostIp": "1.1.1.1",
                "Id": 1
            }
        ],
        "FixSuccessCnt": 1,
        "FixProgress": 1,
        "FixStartTime": "2019-12-25 11:57:15",
        "IsRetrySnapshot": 1,
        "RemainingTime": 1,
        "IsAllowRetry": 1,
        "HostCnt": 1,
        "SnapshotProgress": 1,
        "FixId": 1,
        "FixFailCnt": 1,
        "VulFixList": [
            {
"VulName": "Vulnerability name",
                "FixSuccessCnt": 1,
                "HostList": [
                    {
                        "Status": 1,
                        "ModifyTime": "2019-12-25 11:57:15",
"HostName": "machine name",
"FailReason": "Repair successful"
                        "Quuid": "05f0bcab-726c-4ea4-8109-bcd03d5598f7",
                        "HostIp": "1.1.1.1"
                    }
                ],
                "FailCnt": 1,
                "VulId": 1,
                "Progress": 1
            }
        ],
        "RequestId": "c741a4fd-776f-499b-85a2-7bc70fd5b92s"
    }
}

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

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error
InternalError.MainDBFail Failed to manipulate the data.
InvalidParameter Incorrect parameter.
InvalidParameter.InvalidFormat Incorrect parameter format.
InvalidParameter.MissingParameter Missing parameter.
InvalidParameter.ParsingError Incorrect parameter parsing.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter error.
UnauthorizedOperation Unauthorized operation.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback