1. 接口描述
接口请求域名： pts.tencentcloudapi.com 。
返回告警历史项的列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAlertRecords。 |
| Version | 是 | String | 公共参数，本接口取值：2021-07-28。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| ProjectIds.N | 是 | Array of String | 项目 ID 列表 示例值：["project-xx"] |
| ScenarioIds.N | 否 | Array of String | 场景 ID 列表 示例值：["scenario-xx"] |
| JobIds.N | 否 | Array of String | 任务 ID 列表 示例值：["job-xx"] |
| Ascend | 否 | Boolean | 是否正序 示例值：true |
| OrderBy | 否 | String | 排序项 示例值：CreatedAt |
| Offset | 否 | Integer | 偏移量，默认为0 示例值：1 |
| Limit | 否 | Integer | 返回数量，默认为20，最大为100 示例值：10 |
| ScenarioNames.N | 否 | Array of String | 按场景名筛选 示例值：["my-scenario"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AlertRecordSet | Array of AlertRecord | 告警历史 注意：此字段可能返回 null，表示取不到有效值。 |
| Total | Integer | 告警历史记录的总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询告警历史
输入示例
POST / HTTP/1.1
Host: pts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlertRecords
<公共请求参数>
{
"OrderBy": "xx",
"JobIds": [
"xx"
],
"Ascend": true,
"Limit": 1,
"Offset": 1,
"ProjectIds": [
"xx"
],
"ScenarioIds": [
"xx"
]
}输出示例
{
"Response": {
"AlertRecordSet": [
{
"CreatedAt": "2021-12-22T15:04:36+08:00",
"UpdatedAt": "2021-12-22T15:04:36+08:00",
"AppId": 123,
"Uin": "123",
"SubAccountUin": "123",
"AlertRecordId": "alert-q5qn20zy",
"ProjectId": "project-cphgtuvq",
"ScenarioId": "scenario-lkbg8f20",
"ScenarioName": "my-scenario",
"JobId": "job-b8eklbx8",
"JobSLADescription": "this is a test",
"Status": 1
}
],
"RequestId": "xx",
"Total": 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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。