1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
查询给定prometheus下的告警分组
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribePrometheusAlertGroups。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 否 | String | Prometheus 实例 ID 示例值:prom-zs761zs2 |
Limit | 否 | Integer | 返回数量,默认为 20,最大值为 100 示例值:10 |
Offset | 否 | Integer | 偏移量,默认为 0 示例值:0 |
GroupId | 否 | String | 告警分组ID,形如alert-xxxx。 查询给定ID的告警分组 示例值:alert-f2vx278 |
GroupName | 否 | String | 告警分组名称。 查询名称中包含给定字符串的告警分组 示例值:告警分组-11 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AlertGroupSet | Array of PrometheusAlertGroupSet | 告警分组信息 注意:此字段可能返回 null,表示取不到有效值。 |
TotalCount | Integer | 告警分组总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 列出实例下所有告警规则
列出实例下所有告警规则,包含启用与禁用
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrometheusAlertGroups
<公共请求参数>
{
"InstanceId": "prom-xxxxxxxx"
}
输出示例
{
"Response": {
"AlertGroupSet": [
{
"AMPReceivers": [],
"CreatedAt": "2023-08-01T20:29:56+08:00",
"CustomReceiver": {
"Type": "",
"Url": ""
},
"GroupId": "alert-xxxxxxxx",
"GroupName": "查询告警分组测试-1",
"Rules": [
{
"Annotations": [
{
"Key": "summary",
"Value": "{{$value}}"
}
],
"Duration": "",
"Expr": "expr1",
"Labels": [
{
"Key": "_interval_",
"Value": "10m"
}
],
"RuleName": "规则-1",
"State": 2
}
],
"TemplateId": "",
"UpdatedAt": "2023-08-01T20:29:56+08:00"
}
],
"RequestId": "bc70036f-db50-4b46-abbc-bd41eeb06f7a",
"TotalCount": 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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
FailedOperation.BadYamlFormat | Yaml 格式不正确。 |
FailedOperation.DbQueryFailed | 数据库查询失败。 |
FailedOperation.DbRecordCreateFailed | 创建数据库记录失败。 |
FailedOperation.DbRecordDeleteFailed | 数据库记录删除失败。 |
FailedOperation.DbRecordUpdateFailed | 数据库记录更新失败。 |
FailedOperation.GenerateInstanceIDFailed | 生成资源ID错误。 |
FailedOperation.ResourceExist | 资源已经存在。 |
FailedOperation.ResourceNotFound | 资源不存在。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |