ListSystemAlarms - 查询系统告警信息

查看数据库审计指定时间段内产生的系统运行告警信息。

接口说明

使用说明

本接口用于查询告警信息,如有告警请及时关注处理,避免影响审计结果。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-dbaudit:ListSystemAlarmslist
*全部资源
*

请求参数

名称类型必填描述示例值
RegionIdstring

数据库审计实例的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。接口的参数说明,请参见 DescribeRegions

注意 调用 DescribeRegions 接口查询 D100 实例支持的地域时,公共参数的 Version(API 版本)必须取值2018-03-20

cn-hangzhou
InstanceIdstring

审计的实例 ID。

您可以通过调用 DescribeInstances 接口获取实例 ID。接口的参数说明,请参见 DescribeInstances

注意 调用 DescribeInstances 接口查询 D100 实例列表时,公共参数的 Version(API 版本)必须取值2018-03-20

dbaudit-cn-78v1gc****
AlarmTypeinteger

告警异常类型。取值:

  • 17:表示 Agent 连接异常。
  • 110:表示无审计数据。
17
BeginDatestring

要查询的告警信息的开始日期。格式:yyyy-MM-dd HH:mm:ss

2019-06-06 00:00:00
EndDatestring

要查询的告警信息的结束日期。格式:yyyy-MM-dd HH:mm:ss

2019-06-06 23:59:59
Langstring

请求和接收消息的语言类型。取值:

  • zh(默认):中文。
  • en:英文。
zh

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

1B217656-2267-4FBF-B26C-CDD201BDC3B8
Alarmsarray<object>

系统告警列表。

Infoobject
ReadMarkinteger

该告警信息是否被标记为已读。取值:

  • 0:表示未读。
  • 1:表示已读。
0
AlarmDetailstring

告警异常详细描述。

10.0.XX.XX上的Agent连接异常!
AlarmTypestring

告警异常类型。取值:

  • 17:Agent 连接异常。
  • 110:无审计数据。
17
AlarmIdinteger

告警 ID。

1****
CreateTimestring

系统告警异常的发生时间。

2019-06-06 05:03:17

示例

正常返回示例

JSON格式

{
  "RequestId": "1B217656-2267-4FBF-B26C-CDD201BDC3B8",
  "Alarms": [
    {
      "ReadMark": 0,
      "AlarmDetail": "10.0.XX.XX上的Agent连接异常!",
      "AlarmType": "17",
      "AlarmId": 0,
      "CreateTime": "2019-06-06 05:03:17"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-16OpenAPI 描述信息更新查看变更详情