1. 接口描述
接口请求域名： antiddos.tencentcloudapi.com 。
获取单IP告警阈值配置列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeListIPAlarmConfig。 |
| Version | 是 | String | 公共参数，本接口取值：2020-03-09。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Offset | 是 | Integer | 页起始偏移，取值为(页码-1)*一页条数 示例值：0 |
| Limit | 是 | Integer | 一页条数，当Limit=0时，默认一页条数为100;最大取值为100 示例值：25 |
| FilterInstanceId | 是 | String | 资源实例ID搜索, 支持资源实例前缀通配搜索，例如bgp-*表示获取高防包类型的资源实例 示例值：bgpip-0000011x |
| FilterAlarmType | 是 | Integer | 告警阈值类型搜索，取值[ 1(入流量告警阈值) 2(攻击清洗流量告警阈值) ] 示例值：1 |
| FilterIp | 否 | String | IP搜索 示例值：1.1.1.1 |
| FilterCname | 否 | String | 高防IP实例资源的cname 示例值：abcdefg |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总数 示例值：2 |
| ConfigList | Array of IPAlarmThresholdRelation | IP告警阈值配置列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取单IP告警阈值配置列表
输入示例
https://antiddos.tencentcloudapi.com/?Action=DescribeListIPAlarmConfig
&Offset=0
&Limit=25
&FilterIp=1.1.1.1
&FilterInstanceId=bgpip-0000011x
&FilterAlarmType=1
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "a3056c16-1cb6-4bdb-9d3b-a2361fe5b63c",
"ConfigList": [
{
"AlarmType": 2,
"AlarmThreshold": 2000,
"InstanceDetailList": [
{
"EipList": [
"1.1.1.1"
],
"InstanceId": "bgpip-0000011x"
}
]
},
{
"AlarmType": 1,
"AlarmThreshold": 5000,
"InstanceDetailList": [
{
"EipList": [
"1.1.1.1"
],
"InstanceId": "bgpip-0000011x"
}
]
}
],
"Total": 2
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。