tencent cloud

APIs

DocumentationAPIsCloud Security CenterVulnerability Governance APIsDescribeVulFixTaskDetail

DescribeVulFixTaskDetail

Download
Focus Mode
Font Size
Last updated: 2026-11-12 11:48:32

1. API Description

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

This API is used to query details of a specified vulnerability repair task, including remediation status and snapshot status of each host, and supports pagination and filtering.

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: DescribeVulFixTaskDetail.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
TaskId Yes Integer

Repair task ID
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.
VulId - Exact match. Filter by vulnerability ID to filter out hosts under a vulnerability.
KBId - Exact match. Filter by KB Patch ID to filter out hosts under a KB patch.
Status - Exact match. Filter by execution status: 0-Initial status 1-Issued 11-Confirmed by client 2-Repair completed 3-Client offline 4-Timeout 5-Failed 6-Unsupported 9-Waiting for snapshot creation 10-Snapshot creation failed
FixStatus - Exact match. Filter by fix result: 0-Initial status 1-Repair successful 2-Failed to fix
SnapshotStatus - Exact match. Filter by snapshot status: -1-No need to create snapshot 0-Not started 1-In progress 2-Completed 3-Creation failed
Order No String

Sorting field
Enumeration values:
StartTime: sort by repair start time
EndTime: sort by repair end time
By No String

Sorting method
Enumeration values:
asc: in ascending order
desc: in descending order
Default value: desc
MemberId.N No Array of String Group Account Member ID

3. Output Parameters

Parameter Name Type Description
Data Array of VulFixTaskDetailItem

Task details list
TotalCount Integer

Total quantity.
TaskInfo VulFixTaskInfo

Task summary information
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 repair task details

Input Example

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

{
    "TaskId": 10001,
    "Offset": 0,
    "Limit": 10
}

Output Example

{
    "Response": {
        "Data": [
            {
                "Id": 100001,
                "TaskId": 10001,
                "VulId": 20001,
                "KBId": 0,
                "InstanceId": "ins-a1b2c3d4",
                "MachineName": "web-server-01",
                "MachineIp": "10.0.0.100",
                "VulName": "CVE-2024-12345",
                "Status": 2,
                "FixStatus": 1,
                "SnapshotStatus": 2,
                "SnapshotCreateTime": "2025-06-26T02:00:00Z",
                "SnapshotExpireTime": "2025-07-26T02:00:00Z",
                "ExceptionMessage": "",
                "StartTime": "2025-06-26T10:00:00+08:00",
                "EndTime": "2025-06-26T10:05:00+08:00"
            }
        ],
        "TotalCount": 1,
        "TaskInfo": {
            "Id": 10001,
            "TaskId": 10001,
            "FixStatus": 2,
            "AssetCount": 1,
            "SuccessCount": 1,
            "FailCount": 0,
            "FixingCount": 0,
            "QueueCount": 0,
            "Progress": 100,
            "SuccessVulCount": 1,
            "FailVulCount": 0,
            "VulNames": [
                "CVE-2024-12345"
            ],
            "VulFixStatusList": [
                {
                    "VulId": 20001,
                    "KBId": 0,
                    "VulName": "CVE-2024-12345",
                    "FixStatus": 1,
                    "HostCount": 1,
                    "SuccessHostCount": 1,
                    "FailHostCount": 0
                }
            ],
            "StartTime": "2025-06-26T10:00:00+08:00",
            "EndTime": "2025-06-26T10:05:00+08:00"
        },
        "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.

Previous Topic: DescribeVulFixableMachineListNext Topic: DescribeHostVulScanStatus

Help and Support

Was this page helpful?

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

Feedback

Search
    Enter keywords to search documentation