文档

GetQuotaAlarm - 查询配额用量告警详情

更新时间:

查询目标配额告警详情。

接口说明

本文将提供一个示例,查询配额告警78d7e436-4b25-4897-84b5-d7b656bb****的详情。返回结果显示配额告警的详情,包括:告警 ID、告警名称、告警创建时间、通知对象等。

调试

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

授权信息

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

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

请求参数

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

配额告警 ID。

关于如何获取配额告警 ID,请参见 ListQuotaAlarms

78d7e436-4b25-4897-84b5-d7b656bb****

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

返回参数

名称类型描述示例值
object

无。

RequestIdstring

请求 ID。

81B9D511-F3DD-43B1-9A81-1795DDB52ADF
QuotaAlarmobject

配额告警详情。

ThresholdPercentfloat

配额告警阈值的百分比。

50
ThresholdTypestring

配额告警类型。取值:

  • used:配额已使用量告警。
  • usable:配额剩余可用量告警。
used
QuotaDimensionobject

配额维度。

{"regionId":"cn-hangzhou"}
CreateTimestring

配额告警创建时间。

2021-01-21T03:47:28Z
QuotaActionCodestring

配额 ID。

q_security-groups
AlarmNamestring

配额告警名称。

安全组总数量上限
NotifyTargetstring

配额告警通知对象。

accountContact
NotifyChannelsarray

告警通知渠道。

string

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

  • sms:短信。

  • email:邮箱。

["sms", "email"]
QuotaUsagefloat

配额用量。

28
QuotaValuefloat

配额值。

804
AlarmIdstring

配额告警 ID。

78d7e436-4b25-4897-84b5-d7b656bb****
Thresholdfloat

配额告警阈值的数值。

29
ProductCodestring

云服务名称缩写。

ecs
Webhookstring

配额中心将告警信息通过 HTTP 协议的 POST 请求发送到指定公网的 URL 地址。

https://alert.aliyun.com/callback

示例

正常返回示例

JSON格式

{
  "RequestId": "81B9D511-F3DD-43B1-9A81-1795DDB52ADF",
  "QuotaAlarm": {
    "ThresholdPercent": 50,
    "ThresholdType": "used",
    "QuotaDimension": {
      "regionId": "cn-hangzhou"
    },
    "CreateTime": "2021-01-21T03:47:28Z",
    "QuotaActionCode": "q_security-groups",
    "AlarmName": "安全组总数量上限",
    "NotifyTarget": "accountContact",
    "NotifyChannels": [
      "[\"sms\", \"email\"]"
    ],
    "QuotaUsage": 28,
    "QuotaValue": 804,
    "AlarmId": "78d7e436-4b25-4897-84b5-d7b656bb****",
    "Threshold": 29,
    "ProductCode": "ecs",
    "Webhook": "https://alert.aliyun.com/callback"
  }
}

错误码

HTTP status code错误码错误信息
400RAM.PERMISSION.DENIEDYou are not authorized to do this action or the API input parameter is invalid.

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

变更历史

变更时间变更内容概要操作
2023-09-22OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-09-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
2023-05-06OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈