tencent cloud

APIs

DescribeVulFixTaskList

下载
聚焦模式
字号
最后更新时间: 2026-11-12 11:48:32

1. API Description

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

Paginate the vulnerability fix task record list, support filtering by remediation status, time range, and other conditions, and show summary information of each fix task.

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: DescribeVulFixTaskList.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
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:
TaskId - Exact match, Filter by task ID
JobId - Exact match, Filter by task JobId, which corresponds to the task ID in the background job system
FixStatus - Exact match, Filter by remediation status: 0-initialization 1-in remediation 2-repair successful 3-partially failed to fix 4-all failed to fix 5-stop fix
StartTime - Range match, remediation start time range. Input two values to indicate the start and end time
AppId - Exact match, Filter by creator AppId
VulCategory - Exact match, Filter by vulnerability type: LINUX-LINUX software vulnerability WINDOWS-WINDOWS system patch vulnerability WEB_CMS-WEB-CMS vulnerability APPLICATION-APPLICATION vulnerability EMERGENCY-urgent vulnerability
TaskName - Fuzzy matching, Filter by vulnerability Name/CVE ID/KB patch Name, matching the vulnerability or KB patch associated with the task

Order No String

Sorting field
Enumeration values:
StartTime: sort by repair start time
EndTime: sort by repair end time
CreateTime: sort by creation 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 VulFixTaskItem

Repair task list

TotalCount Integer

Total quantity.

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 the fix task list

Input Example

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

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

Output Example

{
    "Response": {
        "Data": [
            {
                "Id": 1,
                "TaskId": 10001,
                "VulIds": [
                    10001
                ],
                "KBIds": [],
                "AssetCount": 5,
                "SuccessCount": 3,
                "FailCount": 1,
                "Progress": 80,
                "TargetAppIdsCount": 2,
                "FixStatus": 1,
                "Timeout": 600,
                "StartTime": "2025-06-26T10:00:00+08:00",
                "EndTime": "2025-06-26T10:10:00+08:00",
                "CreateTime": "2025-06-26T09:58:00+08:00",
                "VulNames": [
                    "CVE-2024-12345"
                ],
                "VulCategory": [
                    "LINUX"
                ],
                "AppId": 1251001234
            }
        ],
        "TotalCount": 1,
        "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.

帮助和支持

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

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

文档反馈