tencent cloud

APIs

DescribeVulFixTaskDetail

Download
聚焦模式
字号
最后更新时间: 2026-08-11 19:10:11

1. API Description

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

This API is used to query the details of a specified vulnerability repair task, including detailed data such as remediation status and snapshot status for 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 ranges from 0 to +∞
Default value: 0

Limit No Integer

Number of results per page
Value ranges from 1 to 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, filter out hosts under a certain vulnerability
KBId - Exact match, filter by KB Patch ID, filter out hosts under a certain KB patch
Status - Exact match, filter by execution status: 0-Initial status 1-Issued 11-Client confirmed 2-Repair completed 3-Client offline 4-Timeout 5-Failure 6-No support 9-Waiting for snapshot creation to complete 10-Snapshot creation failed
FixStatus - Exact match, filter by repair result: 0-Initial status 1-Repair successful 2-Fix failure
SnapshotStatus - Exact match, filter by snapshot status: -1-No need to create snapshot 0-Not started 1-In progress 2-Completed 3-Creation failure

Order No String

Sorting field
Enumeration value:
StartTime: Sort by repair start time
EndTime: Sort by repair end time

By No String

Sorting method
Enumeration value:
asc: Ascending
desc: Descending
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

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 Querying repair task detail

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.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈