文档

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

更新时间:

查询配额告警历史记录。

调试

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

授权信息

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

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

请求参数

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

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

1
MaxResultsinteger

本次查询最大记录条数。

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

30
Keywordstring

查询关键字。

数量
StartTimelong

查询开始时间。

20201020
EndTimelong

查询结束时间。

20201024
ProductCodestring

云服务名称缩写。

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

告警 ID。

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

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

无。

TotalCountinteger

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

4
NextTokenstring

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

1
RequestIdstring

请求 ID。

CB38DDF9-B1E0-48C1-9966-19C443C2841E
MaxResultsinteger

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

4
AlarmHistoriesobject []

配额告警历史记录详情。

QuotaUsagefloat

已使用配额。

31
ThresholdPercentfloat

配额告警阈值的百分比。

80
CreateTimestring

配额告警创建时间。

2021-01-24T09:20:09Z
QuotaActionCodestring

配额 ID。

q_security-groups
AlarmNamestring

配额告警名称。

安全组总数量上限
NotifyTargetstring

配额告警通知对象。

accountContact
NotifyChannelsarray

配额告警通知渠道。

string

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

  • sms:短信。

  • email:邮件。

["sms", "email"]
Thresholdfloat

配额告警阈值的数值。

29
ProductCodestring

云服务名称缩写。

ecs

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidStartTimeInvalid StartTime查询开始时间无效。
400InvalidEndTimeInvalid EndTime查询结束时间无效。

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

变更历史

变更时间变更内容概要操作
2024-01-31OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:AlarmId
  • 本页导读 (1)
文档反馈