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

查询目标配额告警详情。

接口说明

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

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

quotas:GetQuotaAlarm

get

*QuotaAlarm

acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}

请求参数

名称

类型

必填

描述

示例值

AlarmId

string

配额告警 ID。

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

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

返回参数

名称

类型

描述

示例值

object

无。

QuotaAlarm

object

配额告警详情。

AlarmId

string

配额告警 ID。

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

AlarmName

string

配额告警名称。

q_security-groups alarm

CreateTime

string

配额告警创建时间。

2021-01-21T03:47:28Z

NotifyChannels

array

告警通知渠道。

string

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

  • sms:短信。

  • email:邮箱。

["sms", "email"]

NotifyTarget

string

配额告警通知对象。

accountContact

ProductCode

string

云服务名称缩写。

ecs

QuotaActionCode

string

配额 ID。

q_security-groups

QuotaDimension

object

配额维度。

{"regionId":"cn-hangzhou"}

QuotaUsage

number

配额用量。

28

QuotaValue

number

配额值。

804

Threshold

number

配额告警阈值的数值。

29

ThresholdPercent

number

配额告警阈值的百分比。

50

ThresholdType

string

配额告警类型。取值:

  • used:配额已使用量告警。

  • usable:配额剩余可用量告警。

used

Webhook

string

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

https://alert.aliyun.com/callback

RequestId

string

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "QuotaAlarm": {
    "AlarmId": "78d7e436-4b25-4897-84b5-d7b656bb****",
    "AlarmName": "q_security-groups alarm",
    "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

错误码

错误信息

描述

400 RAM.PERMISSION.DENIED You are not authorized to do this action or the API input parameter is invalid. 没有权限或者参数非法
400 ALARM.NOT.FOUND The AlarmId provided does not exist in our records. 配额预警不存在。

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

变更历史

更多信息,参考变更详情