1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
获取漏洞或KB关联的主机
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeVulRiskRelateHost。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| KBID | 是 | Integer | KB 补丁内部 ID(kb_info.id) 示例值:0 |
| VulID | 是 | Integer | 漏洞 ID(vul_vuls.id) 示例值:45230 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-tencent-6f5795752f66e429"] |
| Filters.N | 否 | Array of Filters | 筛选条件数组,多条件之间为 AND 关系 |
| Limit | 否 | Integer | 每页返回数量 示例值:10 |
| Offset | 否 | Integer | 分页偏移量 示例值:0 |
| Order | 否 | String | 排序方向 示例值:desc |
| By | 否 | String | 排序字段 示例值:LatestScanTime |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| List | Array of VulHostBriefInfo | 该漏洞影响的主机列表 |
| TotalCount | Integer | 符合条件的总数 示例值:1 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取漏洞关联主机
获取漏洞关联主机
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVulRiskRelateHost
<公共请求参数>
{
"KBID": 0,
"VulID": 45230,
"MemberId": [
"mem-tencent-6f5795752f66e429"
],
"Limit": 10,
"Offset": 0,
"Order": "desc",
"By": "LatestScanTime"
}
输出示例
{
"Response": {
"List": [
{
"Account": {
"AppID": 260083796,
"Nick": "700002365149",
"Uin": "700002365149"
},
"AgentStatus": "ONLINE",
"CloudTag": [],
"DefendStatus": "NOT_ENABLED",
"DefendVersion": "BASIC",
"InstanceID": "ins-f9mhqqxa",
"InstanceStatus": "RUNNING",
"Name": "yancyw自建集群",
"PrivateIP": "172.16.0.2",
"PublicIP": "",
"RiskStatus": "PENDING",
"TagItem": [],
"VPRRating": {
"Remark": "",
"Result": "",
"Stage": []
}
}
],
"TotalCount": 1,
"RequestId": "c5752296-cc49-4e64-bba5-62c19174239c"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。