一、1. 接口描述
获取通知设置(云API风险治理)
默认接口请求频率限制:20次/秒。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数,本接口取值:DescribeNotifySettingAk。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| Alert | Array of LevelOption | 告警类型/等级 (类型: AbnBehavior-异常行为, LeakDetect-泄露监测; 等级: 1-提示, 2-低危, 3-中危, 4-高危, 5-严重) |
| AlertGranularity | Integer | 告警通知粒度枚举值:0: 按告警聚合推送1: 按调用记录推送示例值:1 |
| Asset | Array of String | 资产事件枚举值:NewAk: AK新增示例值:["NewAk"] |
| BeginTime | String | 通知开始时间参数格式:hh:mm:ss示例值:09:00:00 |
| EndTime | String | 通知结束时间参数格式:hh:mm:ss示例值:18:00:00 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
四、输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNotifySettingAk
<公共请求参数>
{}
五、输出示例
{
"Response": {
"Alert": [
{
"Level": [
3
],
"Type": "LeakDetect"
}
],
"AlertGranularity": 1,
"Asset": [],
"BeginTime": "09:00:00",
"EndTime": "18:00:00",
"RequestId": "9940e3f8-0324-4ede-aaad-9dc6c3e26ab0"
}
}
六、腾讯云 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
九、命令行工具
·Tencent Cloud CLI 3.0
十、6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
| InternalError | 内部错误。 |