1. 接口描述
接口请求域名: cat.tencentcloudapi.com 。
查询用户的告警接收组列表
默认接口请求频率限制:300次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAlarmGroups。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-09。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Offset | 否 | Integer | 满足条件的第几条开始 |
Limit | 否 | Integer | 每批多少条 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 用户名下总的告警接收组数目 |
AlarmGroupInfos | Array of AlarmGroupInfo | 满足条件的告警接收组列表 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询用户的告警接收组列表
输入示例
https://cat.tencentcloudapi.com/?Action=DescribeAlarmGroups
&Offset=0
&Limit=2
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 24,
"AlarmGroupInfos": [
{
"GroupId": 98912,
"GroupName": "tcr",
"Channel": 3,
"Remarks": "tcr altert",
"CreateTime": "2019-12-10 10:21:35"
},
{
"GroupId": 97204,
"GroupName": "halewang",
"Channel": 3,
"Remarks": "",
"CreateTime": "2019-11-27 18:51:47"
}
],
"RequestId": "b5d64705-3d32-4725-80a5-7c0a4bbb588e"
}
}
5. 开发者资源
API Explorer
该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
ResourceNotFound | 资源不存在。 |