1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
获取2.0实例告警策略列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribePrometheusAlertPolicy。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例ID 示例值:prom-253ac24d |
Offset | 否 | Integer | 分页偏移量,默认为0。 示例值:1 示例值:0 |
Limit | 否 | Integer | 分页返回数量,默认为20,最大值为100 示例值:100 |
Filters.N | 否 | Array of Filter | 仅支持按Name, Values字段过滤: - Name = Name 按照给定的告警规则名称列表匹配 - Name = ID 按照给定的告警规则ID列表匹配 示例值:{Name: "Name", Values: ["test-alert"]} |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AlertRules | Array of PrometheusAlertPolicyItem | 告警详情 注意:此字段可能返回 null,表示取不到有效值。 |
Total | Integer | 总数 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例告警列表
查询实例告警列表
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrometheusAlertPolicy
<公共请求参数>
{
"InstanceId": "prom-as3d2s1a",
"Limit": 1,
"Filters": [
{
"Name": "Name",
"Values": [
"alert-test"
]
}
],
"Offset": 0
}
输出示例
{
"Response": {
"AlertRules": [
{
"Id": "alert-23a6d2ga",
"Name": "alert-test",
"TemplateId": "temp-as12sf12",
"ClusterId": "",
"Notification": {
"Enabled": true,
"Type": "amp",
"RepeatInterval": "5m",
"TimeRangeStart": "0:00:00",
"TimeRangeEnd": "23:59:59",
"ReceiverGroups": [
"notice-13hs61s2"
],
"WebHook": "http://127.0.0.1:9090/alert",
"AlertManager": {
"ClusterType": "tke",
"ClusterId": "cls-a2df21xa",
"Url": "http://127.0.0.1:9090"
},
"PhoneNotifyOrder": [
1
],
"PhoneCircleTimes": 0,
"PhoneInnerInterval": 0,
"PhoneCircleInterval": 0,
"PhoneArriveNotice": true,
"NotifyWay": [
"abc"
]
},
"Rules": [
{
"Name": "rule-1",
"Rule": "up{} != 1",
"Labels": [
{
"Name": "level",
"Value": "warnning"
}
],
"Template": "test alert",
"For": "5m",
"Describe": "test alert",
"Annotations": [
{
"Name": "creator",
"Value": "programer"
}
],
"RuleState": 1
}
],
"UpdatedAt": "2024-07-21 18:10:14"
}
],
"Total": 1,
"RequestId": "3f04883c-eda1-4498-b024-d266baec6040"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.ComponentClientCommon | FailedOperation.ComponentClientCommon |
FailedOperation.ComponentClientHttp | FailedOperation.ComponentClientHttp |
FailedOperation.ComponentClientUnpack | FailedOperation.ComponentClientUnpack |
FailedOperation.DoTRPCTransferFailed | DoTRPCTransferFailed |
FailedOperation.KubeClientConf | FailedOperation.KubeClientConf |
FailedOperation.KubeCommon | FailedOperation.KubeCommon |
InternalError | 内部错误。 |
InternalError.DbRecordNotFound | InternalError.DbRecordNotFound |
InternalError.Param | InternalError.Param |
InternalError.UnexpectedInternal | InternalError.UnexpectedInternal |
InvalidParameter | 参数错误。 |
InvalidParameter.Param | InvalidParameter.Param |
InvalidParameter.PromClusterNotFound | InvalidParameter.PromClusterNotFound |
InvalidParameter.PromInstanceNotFound | InvalidParameter.PromInstanceNotFound |
ResourceNotFound | 资源不存在。 |