1. 接口描述
接口请求域名: cwp.tencentcloudapi.com 。
漏洞修护-查找主机漏洞修护进度
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeVulFixStatus。 |
Version | 是 | String | 公共参数,本接口取值:2018-02-28。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
FixId | 否 | Integer | 任务id 传VulId可以不用传FixId 示例值:1 |
VulId | 否 | Integer | 漏洞id 传FixId可以不用传VulId 示例值:12 |
Quuid | 否 | String | 主机quuid 和VulId 组合可查 某主机最近一次修复任务详情 示例值:05f0bcab-726c-4ea4-8109-bcd03d5598f7 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FixStartTime | String | 开始修复时间 示例值:2021-07-09 15:04:01 |
FixEndTime | String | 修复结束时间,为空表示还没结束 示例值:2021-07-09 15:04:01 |
FixSuccessCnt | Integer | 修复成功的主机数 示例值:1 |
FixFailCnt | Integer | 修复失败的主机数 示例值:3 |
HostCnt | Integer | 主机总数 示例值:4 |
FixId | Integer | 修复的任务id 示例值:153 |
SnapshotList | Array of VulFixStatusSnapshotInfo | 修复快照状态列表 示例值:[{"Id": 685817, "SnapshotName": "\u6f0f\u6d1e\u4fee\u590d_libarchive \u4ee3\u7801\u95ee\u9898\u6f0f\u6d1e(CVE-2022-36", "SnapshotId": "snap-nb0l", "Quuid": "e5f53d3c-7072-4e2f-ae0c-451c7a14", "ModifyTime": "2024-10-25 11:3", "HostName": "AI\u6587\u6863\u7ec4\u624b-p", "HostIp": "10.22.", "Status": 1, "FailReason": ""}] |
VulFixList | Array of VulFixStatusInfo | 修复漏洞详情列表 示例值:[{"VulId": 38382, "VulName": "libarchive \u4ee3\u7801\u95ee\u9898\u6f0f\u6d1e(CVE-2022-36", "Progress": 100, "FailCnt": 0, "HostList": [{"Quuid": "e5f53d3c-7072-4e2f-ae0c-451c7a14", "HostName": "AI\u6587\u6863\u7ec4\u624b-p", "HostIp": "10.22.", "Status": 2, "FailReason": "\u4fee\u590d\u6210\u529f", "ModifyTime": "2024-10-25 11:3****"}], "FixSuccessCnt": 1, "FixMethod": 0}] |
SnapshotProgress | Integer | 快照创建进度0-100 示例值:40 |
FixProgress | Integer | 修复进度 0-100 示例值:20 |
RemainingTime | Integer | 预计剩余时间(单位秒) 示例值:34255 |
IsRetrySnapshot | Integer | 快照是否是重试状态 0=非重试 1=重试 示例值:1 |
SnapshotFailCnt | Integer | 快照创建失败数 示例值:1 |
IsAllowRetry | Integer | 是否允许重试 0:不允许 1:允许 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 漏洞修护-查找主机漏洞修护进度
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVulFixStatus
<公共请求参数>
{
"FixId": "1"
}
输出示例
{
"Response": {
"FixEndTime": "2019-12-25 11:57:15",
"SnapshotFailCnt": 1,
"SnapshotList": [
{
"Status": 1,
"SnapshotName": "快照名称",
"HostName": "机器名称",
"FailReason": "success",
"Quuid": "05f0bcab-726c-4ea4-8109-bcd03d5598f7",
"ModifyTime": "2019-12-25 11:57:15",
"SnapshotId": "快照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": "漏洞名称",
"FixSuccessCnt": 1,
"HostList": [
{
"Status": 1,
"ModifyTime": "2019-12-25 11:57:15",
"HostName": "机器名称",
"FailReason": "修复成功",
"Quuid": "05f0bcab-726c-4ea4-8109-bcd03d5598f7",
"HostIp": "1.1.1.1"
}
],
"FailCnt": 1,
"VulId": 1,
"Progress": 1
}
],
"RequestId": "c741a4fd-776f-499b-85a2-7bc70fd5b92s"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.MainDBFail | 操作数据失败。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidFormat | 参数格式错误。 |
InvalidParameter.MissingParameter | 参数缺失。 |
InvalidParameter.ParsingError | 参数解析错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
UnauthorizedOperation | 未授权操作。 |