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

查询目标配额告警详情。

接口说明

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

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

调试

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

授权信息

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

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

请求参数

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

配额告警 ID。

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

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

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

返回参数

名称类型描述示例值
object

无。

QuotaAlarmobject

配额告警详情。

AlarmIdstring

配额告警 ID。

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

配额告警名称。

安全组总数量上限
CreateTimestring

配额告警创建时间。

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

告警通知渠道。

NotifyChannelsstring

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

  • sms:短信。

  • email:邮箱。

["sms", "email"]
NotifyTargetstring

配额告警通知对象。

accountContact
ProductCodestring

云服务名称缩写。

ecs
QuotaActionCodestring

配额 ID。

q_security-groups
QuotaDimensionobject

配额维度。

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

配额用量。

28
QuotaValuefloat

配额值。

804
Thresholdfloat

配额告警阈值的数值。

29
ThresholdPercentfloat

配额告警阈值的百分比。

50
ThresholdTypestring

配额告警类型。取值:

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

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

https://alert.aliyun.com/callback
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400RAM.PERMISSION.DENIEDYou are not authorized to do this action or the API input parameter is invalid.没有权限或者参数非法
400ALARM.NOT.FOUNDThe AlarmId provided does not exist in our records.配额预警不存在。

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

变更历史

变更时间变更内容概要操作
2023-09-22OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
2023-09-04OpenAPI 错误码发生变更查看变更详情
2023-05-06OpenAPI 返回结构发生变更查看变更详情