调用ListAlertMessages获取报警信息的列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dataworks:* | List |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PageNumber | integer | 是 | 分页的页数。默认值为 1、最小值为 1、最大值为 30。 | 1 |
| PageSize | integer | 是 | 每页显示的条数，默认为 10，最大 100 条。 | 10 |
| BeginTime | string | 是 | 起始报警时间，需要使用 yyyy-MM-dd'T'HH:mm:ssZ 的 UTC 格式。 | 2020-04-02T00:00:00+0800 |
| EndTime | string | 是 | 截止报警时间，需要使用 yyyy-MM-dd'T'HH:mm:ssZ 的 UTC 格式。 | 2020-04-04T00:00:00+0800 |
| RemindId | long | 否 | 自定义规则的 ID，当 AlertRuleTypes 参数配置为 USER_DEFINE 自定义规则时生效。 该参数与 BaselineId 参数配置一个即可。 | 9527 |
| AlertMethods | string | 否 | 报警方式，取值如下：
多个报警方式之间使用英文逗号（,）分隔。 | SMS,MAIL,PHONE |
| AlertUser | string | 否 | 报警接收人的阿里云 UID。 | 123456 |
| AlertRuleTypes | string | 否 | 规则类型，包括 GLOBAL（全局规则）、USER_DEFINE（自定义规则）和 OTHER（其它）。多个规则类型之间使用英文逗号（,）分隔。 | GLOBAL,USER_DEFINE,OTHER |
| BaselineId | long | 否 | 基线 ID。当 AlertRuleTypes 参数配置为 GLOBAL 时生效。 该参数与 RemindId 参数配置一个即可。 | 1234 |
返回参数
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"RequestId": "0000-ABCD-EFG****",
"ErrorMessage": "The specified parameters are invalid.",
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"Success": true,
"Data": {
"PageNumber": "1",
"PageSize": "10",
"TotalCount": "100",
"AlertMessages": [
{
"RemindId": 1234,
"AlertMessageStatus": "READY_TO_SEND",
"AlertUser": "9527952795****",
"AlertTime": 1553531401000,
"AlertMethod": "SMS",
"Source": "REMIND_ALERT",
"Content": "节点出错",
"RemindName": "自定义监控规则名称",
"AlertId": 1234,
"Instances": [
{
"Status": "NOT_RUN",
"InstanceId": 12345,
"NodeName": "节点名称",
"NodeId": 1234,
"ProjectId": 1234
}
],
"Topics": [
{
"TopicName": "9527出错",
"InstanceId": 12345,
"TopicId": 1234,
"TopicOwner": "9527952795****",
"NodeId": 1234,
"TopicStatus": "FIXING"
}
],
"Nodes": [
{
"Owner": "95279527952****",
"NodeName": "节点名称",
"NodeId": 1234,
"ProjectId": 1234
}
],
"SlaAlert": {
"Status": "SAFE",
"BaselineOwner": "952795279****",
"BaselineId": 1234,
"BaselineName": "基线名称",
"Bizdate": 1553443200000,
"ProjectId": 1234,
"InGroupId": 1
}
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 没有权限，请授权 |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | 对该资源的请求已超过您的可用上限。 |
| 429 | Throttling.Api.Risk | The request for this resource has exceeded your daily available limit. | 对该资源的请求已超过您的每日可用上限。 |
| 429 | Throttling.Resource | You have reached the limit for the resource. Please contact us by submitting a ticket. | - |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks系统繁忙，请稍后再试。 |
| 429 | Throttling.User | Your request is too frequent. Try again later. | 您的请求过于频繁，请尝试放缓请求速度。 |
| 500 | Forbidden.Not.Server | The dataworksAPI service is not available in this area. Please try it in another area. | 该地域还未开放DataWorks的API服务，请尝试其它地域。 |
| 500 | InternalError.System | An internal system error occurred. Try again later. | 系统内部错误，请稍后再试。 |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系统内部错误，请稍后再试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史