1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
查询指定漏洞修复任务的详情信息,包含每台主机的修复状态、快照状态等明细数据,支持分页和筛选。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeVulFixTaskDetail。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| TaskId | 是 | Integer | 修复任务ID 示例值:10001 |
| Offset | 否 | Integer | 分页偏移量 示例值:0 |
| Limit | 否 | Integer | 每页返回数量 示例值:10 |
| Filters.N | 否 | Array of Filters | 过滤条件 |
| Order | 否 | String | 排序字段 示例值:StartTime |
| By | 否 | String | 排序方式 示例值:desc |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-tencent-6f5795752f66e429"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of VulFixTaskDetailItem | 任务明细列表 |
| TotalCount | Integer | 总数量 示例值:5 |
| TaskInfo | VulFixTaskInfo | 任务概要信息 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询修复任务详情
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVulFixTaskDetail
<公共请求参数>
{
"TaskId": 10001,
"Offset": 0,
"Limit": 10
}
输出示例
{
"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. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。