1. 接口描述
接口请求域名： bsca.tencentcloudapi.com 。
本接口(DescribeKBComponentVulnerability)用于在知识库中查询开源组件的漏洞信息。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeKBComponentVulnerability。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-11。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| PURL | 是 | PURL | 组件的PURL，其中Name和Version为必填字段 |
| Language | 否 | String | 语言，ZH或EN 示例值：ZH |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| VulnerabilityList | Array of ComponentVulnerabilityUnion | 漏洞信息列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询openssl 1.1.1的漏洞信息
输入示例
POST / HTTP/1.1
Host: bsca.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeKBComponentVulnerability
<公共请求参数>
{
"PURL": {
"Version": "1.1.1",
"Name": "openssl"
}
}输出示例
{
"Response": {
"VulnerabilityList": [
{
"Summary": {
"CNNVDID": "CNNVD-201909-447",
"CNVDID": "CNVD-2019-38485",
"CVEID": "CVE-2019-1547",
"IsSuggest": false,
"Name": "OpenSSL 安全漏洞",
"Severity": "Medium",
"VulID": "pcmgr-124087"
},
"SummaryInComponent": {
"AffectedComponent": "openssl",
"AffectedVersion": "1.1.1",
"CanBeFixed": true,
"FixedVersion": ">1.0.2s,>1.1.0k,>1.1.1c",
"PURL": {
"Name": "openssl",
"Namespace": "",
"Protocol": "",
"Qualifiers": [],
"Subpath": "",
"Version": "1.1.1"
},
"RiskLevel": "Medium"
}
}
],
"RequestId": "278a8e3b-f491-4396-b6b2-984a354ff5b0"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.AccountNotEnough | 账户流量余额不足。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |