1. 接口描述
接口请求域名： tke.tencentcloudapi.com 。
获取告警历史
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribePrometheusAlertHistory。 |
| Version | 是 | String | 公共参数，本接口取值：2018-05-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例id 示例值：prom-abcdfas |
| RuleName | 否 | String | 告警名称 示例值：test |
| StartTime | 否 | String | 开始时间 示例值：2021-02-19 16:51:44 |
| EndTime | 否 | String | 结束时间 示例值：2021-02-19 16:51:44 |
| Labels | 否 | String | label集合 |
| Offset | 否 | Integer | 分片 示例值：0 |
| Limit | 否 | Integer | 分片 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Items | Array of PrometheusAlertHistoryItem | 告警历史 |
| Total | Integer | 总数 示例值：0 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询告警历史
查询告警历史
输入示例
https://tke.tencentcloudapi.com/?Action=DescribePrometheusAlertHistory
&InstanceId=prom-adsdfdsf
&RuleName=test
&<公共请求参数>输出示例
{
"Response": {
"Items": [
{
"Content": "pod发生重启",
"StartTime": "2021-02-19 16:51:44",
"RuleName": "test"
}
],
"Total": 1,
"RequestId": "7ef8496c-b966-4c23-b160-dsadahsjf12ehjh"
}
}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.ComponentClientHttp | 内部HTTP客户端错误。 |
| FailedOperation.ComponentClientUnpack | 内部HTTP解包失败。 |
| FailedOperation.KubeCommon | KubernetesAPI错误。 |
| InternalError | 内部错误。 |
| InternalError.DbRecordNotFound | 记录未找到。 |
| InternalError.Param | Param。 |
| InternalError.UnexpectedInternal | 未知的内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ClusterNotFound | 集群ID不存在。 |
| InvalidParameter.Param | 参数错误。 |
| InvalidParameter.PromInstanceNotFound | Prometheus实例不存在。 |
