# 告警记录 - ListAlertRecord

## 简介

获取时间段内的告警记录





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `ListAlertRecord`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.ckcloudai.com/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **ProjectId** | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](/docs/api/summary/get_project_list) |**Yes**|
| **StartAt** | int | 开始时间，查询告警记录开始时间，不支持查询距当前时间一年前的数据)，值为10位数时间戳 |**Yes**|
| **EndAt** | int | 结束时间，查询告警记录结束时间(查询开始时间和结束时间不能超过一个月)，值为10位数时间戳 |**Yes**|
| **Fuzzy** | string | 模糊查询(支持资源id模糊搜索) |No|
| **Filter.ProductTypes.N** | int | 产品ID，根据产品类型精确搜索对应的告警记录，参见 [产品概览](https://docs.ucloud.cn/cloudwatch/metric/intro) |No|
| **Filter.Levels.N** | string | 告警级别，根据告警级别精确搜索对应的告警记录，枚举值:P0,P1,P2,P3 |No|
| **Filter.Status.N** | string | 告警状态，根据告警状态精确搜索对应的告警记录，枚举值：firing-告警中，resolved-已恢复 |No|
| **OrderType** | string | 排序(默认根据告警发生时间倒序)，枚举值：asc-升序，desc-降序 |No|
| **Limit** | int | 查询返回数量，默认值300，最大值：300。<br /> |No|
| **Offset** | int | 数据偏移量 (默认0)<br /> |No|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|
| **Data** | array[[*AlertRecord*](#AlertRecord)] | 告警记录集合 |No|
| **TotalCount** | int | 告警记录总数 |No|

#### 数据模型


#### AlertRecord

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Region** | string | 可用区 |No|
| **RecordID** | int | 告警记录RecordID |No|
| **ProjectID** | int | 项目ProjectID |No|
| **StrategyName** | string | 告警记录触发告警策略名称 |No|
| **ProductType** | int | 产品类型 |No|
| **ProductName** | string | 产品类型名称 |No|
| **ResourceID** | string | 资源id |No|
| **MetricID** | int | 指标id |No|
| **MetricName** | string | 指标名称 |No|
| **UnitName** | string | 指标单位名称 |No|
| **StrategyID** | int | 告警记录触发告警策略Id |No|
| **RuleID** | int | 告警记录触发告警规则Id |No|
| **Tag** | array[string] | 告警点tag信息 |No|
| **Value** | int | 告警当前值 |No|
| **ThresholdCompare** | int | 比较符 |No|
| **ThresholdValue** | int | 告警阈值 |No|
| **ShieldRuleID** | int | 告警屏蔽规则id(如果配置了屏蔽规则，并且满足条件) |No|
| **Level** | string | 告警等级 |No|
| **Status** | string | 告警状态 |No|
| **StartAt** | int | 告警触发时间 |No|
| **EndAt** | int | 告警恢复时间 |No|
| **ContentAttr** | object | 产品相关的额外属性 |No|

## 示例

### 请求示例
    
```
https://api.ckcloudai.com/?Action=ListAlertRecord
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=lHbpbCJv
&RecordID=1
&StartAt=4
&EndAt=7
&Fuzzy=hAVEfaDE
&RecordID=6
&StartAt=5
&EndAt=8
&Fuzzy=jVymouaW
&Fuzzy=WYjEKfyo
&Filter.ProductTypes.N=6
&Filter.Levels.N=lxexxlZh
&Filter.Status.N=wakzNxlZ
&OrderType=JXKKXtZY
&Limit=3
&Offset=3
```

### 响应示例
    
```json
{
  "Action": "ListAlertRecordResponse",
  "Data": [
    {
      "IsShield": false,
      "Level": "P2",
      "MetricID": 13333,
      "MetricName": "CPU使用率",
      "ProductName": "云主机",
      "ProductType": 1,
      "ProjectID": 23332,
      "RecordID": 1111,
      "Region": "cn-bj2",
      "ResourceID": "uhost-xxx",
      "RuleID": 1234,
      "ShieldRuleID": 0,
      "StartAt": 1755104487,
      "Status": "firing",
      "StrategyID": 3333,
      "StrategyName": "资源组告警",
      "Tag": [],
      "ThresholdCompare": 1,
      "ThresholdValue": 0,
      "UnitName": "%",
      "Value": 0,
      "Zone": "cn-bj2-05"
    }
  ],
  "RetCode": 0,
  "TotalCount": 1,
  "TraceId": "217e6c67-9c34-4c48-8c0e-c4ab7380e51c"
}
```