ListAlarmHistories - 查询配额用量告警历史记录

查询配额告警历史记录。

接口说明

配额告警功能已升级,本 API 即将废弃,本 API 仅可查询旧版配额用量告警历史记录,若您想查询新版配额用量告警历史记录,请您使用云监控 API DescribeAlertLogCountDescribeAlertLogList 进行操作。使用 API 对新版配额告警进行操作的更多信息,请参见使用 API 管理新版配额告警

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quotas:ListAlarmHistories

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

NextToken

string

用来标记开始查询数据的位置。置空表示从头开始。

1

MaxResults

integer

本次查询最大记录条数。

取值范围:1~200。默认值:30。

30

Keyword

string

查询关键字。

Quantity

StartTime

integer

查询开始时间。

20201020

EndTime

integer

查询结束时间。

20201024

ProductCode

string

云服务名称缩写。

说明

关于支持配额中心的云服务,请参见支持配额中心的云服务

ecs

AlarmId

string

告警 ID。

18b3be23-b7b0-4d45-91bc-d0c331aa****

返回参数

名称

类型

描述

示例值

object

无。

AlarmHistories

array<object>

配额告警历史记录详情。

object

配额告警历史记录详情。

AlarmName

string

配额告警名称。

q_security-groups alarm

CreateTime

string

配额告警创建时间。

2021-01-24T09:20:09Z

NotifyChannels

array

配额告警通知渠道。

string

配额告警通知渠道。取值:

  • sms:短信。

  • email:邮件。

["sms", "email"]

NotifyTarget

string

配额告警通知对象。

accountContact

ProductCode

string

云服务名称缩写。

ecs

QuotaActionCode

string

配额 ID。

q_security-groups

QuotaUsage

number

已使用配额。

31

Threshold

number

配额告警阈值的数值。

29

ThresholdPercent

number

配额告警阈值的百分比。

80

MaxResults

integer

本次查询返回的最大记录条数。

4

NextToken

string

用来标记返回查询数据的位置。空表示数据已经查询完毕。

1

RequestId

string

请求 ID。

CB38DDF9-B1E0-48C1-9966-19C443C2841E

TotalCount

integer

本次请求返回的全部记录条数。

4

示例

正常返回示例

JSON格式

{
  "AlarmHistories": [
    {
      "AlarmName": "q_security-groups alarm",
      "CreateTime": "2021-01-24T09:20:09Z",
      "NotifyChannels": [
        "[\"sms\", \"email\"]"
      ],
      "NotifyTarget": "accountContact",
      "ProductCode": "ecs",
      "QuotaActionCode": "q_security-groups",
      "QuotaUsage": 31,
      "Threshold": 29,
      "ThresholdPercent": 80
    }
  ],
  "MaxResults": 4,
  "NextToken": "1",
  "RequestId": "CB38DDF9-B1E0-48C1-9966-19C443C2841E",
  "TotalCount": 4
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidStartTime Invalid StartTime 查询开始时间无效。
400 InvalidEndTime Invalid EndTime 查询结束时间无效。

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

变更历史

更多信息,参考变更详情