1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
查询漏洞防御设置信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeVulDefenceSetting。 |
| Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| IsEnabled | Integer | 是否开启:0: 关闭 1:开启 示例值:0 |
| Scope | Integer | 漏洞防御主机范围: 0:自选主机节点,1:全部 示例值:1 |
| HostCount | Integer | 漏洞防御主机数量 示例值:10 |
| ExceptionHostCount | Integer | 开启漏洞防御异常主机数量 示例值:1 |
| HostIDs | Array of String | 自选漏洞防御主机 示例值:1 |
| HostTotalCount | Integer | 开通容器安全的主机总数 示例值:1 |
| SupportDefenseVulCount | Integer | 支持防御的漏洞数 示例值:1 |
| HostNodeCount | Integer | 普通节点个数 示例值:0 |
| SuperScope | Integer | 超级节点范围 示例值:0 |
| SuperNodeCount | Integer | 超级节点个数 示例值:0 |
| SuperNodeIds | Array of String | 超级节点Id列表 示例值:["eklet-subnet-1ewk3avk"] |
| NodeTotalCount | Integer | 开通容器安全的超级结点总数 示例值:13 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询漏洞防御设置信息
查询漏洞防御设置信息
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVulDefenceSetting
<公共请求参数>
{}
输出示例
{
"Response": {
"IsEnabled": 0,
"Scope": 0,
"HostCount": 0,
"ExceptionHostCount": 0,
"HostIDs": [],
"HostTotalCount": 0,
"SupportDefenseVulCount": 0,
"HostNodeCount": 0,
"SuperScope": 0,
"SuperNodeCount": 0,
"SuperNodeIds": [],
"NodeTotalCount": 0,
"RequestId": "dc56fda9-58c8-4c4f-9e8c-b7296836c1fe"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidFormat | 参数格式错误。 |
| InvalidParameter.MissingParameter | 缺少必须参数。 |
| InvalidParameter.ParsingError | 参数解析错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| UnknownParameter | 未知参数错误。 |