1. 接口描述
接口请求域名: cwp.tencentcloudapi.com 。
获取安全防护状态汇总
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSecurityProtectionStat。 |
Version | 是 | String | 公共参数,本接口取值:2018-02-28。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AssetManageStat | Integer | 0 :0付费资产情况, 1:存在未安装agent情况 ,2:部分资产已是专业版/旗舰版, 3:全部资产已是专业版/旗舰版 示例值:1 |
VulManageStat | Integer | 0:从未检测过,或0资产付费情况, 1:存在漏洞风险, 2:无风险 示例值:1 |
SecureBasicLineStat | Integer | 0:从未检测过,或0资产付费情况, 1:存在基线风险,2:无风险 示例值:1 |
MalwareScanStat | Integer | 0:从未检测过,或0资产付费情况, 1:已检测,存在恶意文件, 2:已检测,未开启隔离防护, 3:已检测且已开启防护且无风险 示例值:1 |
DefenseBruteAttackStat | Integer | 密码破解是否开启防护 0:未开启防护或0付费资产情况 1:已开启防护 2:存在带处理事件 示例值:1 |
FileTamperStat | Integer | 核心文件监控 0:未开启防护(0付费资产情况),1: 已开通 示例值:1 |
WebPageStat | Integer | 网页防篡改 0:未开通, 1:已开通 示例值:1 |
LoginLogStat | Integer | 异常登录 0:存在未处理风险,1:无风险,未配置白名单,2:无风险,已配置 示例值:1 |
DiscoverBruteAttackStat | Integer | 检测--密码破解有无存在风险 0:存在未处理风险, 1:无风险,正常检测 示例值:1 |
MaliciousRequestStat | Integer | 恶意请求 0 : 0台开通专业版/旗舰版, 1: 恶意请求 存在未处理风险, 2:已有付费资产,无风险 示例值:1 |
PrivilegeStat | Integer | 本地提权 0:0台开通专业版/旗舰版, 1:存在未处理风险 2:已有付费资产,无风险 示例值:1 |
ReverseShellStat | Integer | 反弹shell 0:0台开通专业版/旗舰版, 1:存在未处理风险 2:已有付费资产,无风险 示例值:1 |
ExpertServiceStat | Integer | 专家服务 0:未开通服务, 1:已开通 示例值:1 |
LogAnalysisStat | Integer | 日志分析 0:未开通服务, 1:已开通 示例值:1 |
WarningSetStat | Integer | 安全告警 0:未开通设置(全部关闭) 1:已开通(只要开启1个就算) 示例值:1 |
EventBashStat | Integer | 高危命令,0:0台开通专业版/旗舰版, 1:存在未处理风险, 2:已有付费资产,无风险 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取安全防护状态
输入示例
https://cwp.tencentcloudapi.com/?Action=DescribeSecurityProtectionStat
&<公共请求参数>
输出示例
{
"Response": {
"AssetManageStat": 1,
"SecureBasicLineStat": 1,
"ExpertServiceStat": 1,
"LoginLogStat": 1,
"VulManageStat": 1,
"FileTamperStat": 1,
"WarningSetStat": 1,
"DiscoverBruteAttackStat": 1,
"DefenseBruteAttackStat": 1,
"RequestId": "e79efea3-3f70-46c0-a7e1-ed38a2476098",
"ReverseShellStat": 1,
"LogAnalysisStat": 1,
"PrivilegeStat": 1,
"MalwareScanStat": 1,
"WebPageStat": 1,
"EventBashStat": 1,
"MaliciousRequestStat": 1
}
}
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 | 操作数据失败。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |