1. 接口描述
接口请求域名: cwp.tencentcloudapi.com 。
查询定期检测的配置
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeScanVulSetting。 |
Version | 是 | String | 公共参数,本接口取值:2018-02-28。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
VulCategories | String | 漏洞类型:1: web-cms漏洞 2:应用漏洞 4: Linux软件漏洞 5: Windows系统漏洞 示例值:1 |
VulLevels | String | 危害等级:1-低危;2-中危;3-高危;4-严重 (多选英文逗号分隔) 示例值:1 |
TimerInterval | Integer | 定期检测间隔时间(天) 示例值:1 |
TimerTime | String | 定期检测时间,如:00:00 示例值:00:00 |
VulEmergency | Integer | 是否紧急漏洞:0-否 1-是 示例值:1 |
StartTime | String | 开始时间 示例值:00:00 |
EnableScan | Integer | 是否开启 示例值:1 |
EndTime | String | 结束时间 示例值:05:00 |
ClickTimeout | Integer | 一键扫描超时时长,如:1800秒(s) 示例值:600 |
Uuids | Array of String | 为空默认扫描全部专业版、旗舰版、普惠版主机,不为空只扫描选中主机 示例值:["d99a1b46-cc2d-4633-a11f-4a7663d25***"] |
ScanMethod | Integer | 0版本比对,2版本比对+poc 示例值:0 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询定时检测配置信息
使用appid查询定时检测配置的信息
输入示例
https://cwp.tencentcloudapi.com/?Action=DescribeScanVulSetting
&<公共请求参数>
输出示例
{
"Response": {
"ClickTimeout": 0,
"EnableScan": 0,
"EndTime": "23:50",
"RequestId": "54111d3a-373d-4175-80dd-8d855b595647",
"ScanMethod": 0,
"StartTime": "00:40",
"TimerInterval": 1,
"TimerTime": "00:40",
"Uuids": [],
"VulCategories": "4;5;1;2",
"VulEmergency": 1,
"VulLevels": "1;2;3;4"
}
}
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.MainDBFail | 操作数据失败。 |
InvalidParameter | 参数错误。 |
InvalidParameter.MissingParameter | 参数缺失。 |
InvalidParameter.ParsingError | 参数解析错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |