DescribeAlarms - 查询报警任务的信息 - 弹性伸缩

调用API DescribeAlarms查询报警任务信息，及时了解已有报警任务的配置和监控项数据的变化趋势，帮助您实时发现系统资源异常，确保系统的稳定性和可靠性。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ess:DescribeAlarms	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	报警任务所属地域的 ID。	cn-qingdao
ScalingGroupId	string	否	报警任务关联的伸缩组的 ID。	asg-bp18p2yfxow2dloq****
AlarmTaskId	string	否	报警任务 ID。	asg-bp1hvbnmkl10vll5**_f95ce797-dc2e-4bad-9618-14fee7d1**
State	string	否	报警任务的状态。取值范围： ALARM：报警，已满足报警条件。 OK：正常，尚未满足报警条件。 INSUFFICIENT_DATA：数据不足，不足以判断是否满足了报警条件。	OK
IsEnable	boolean	否	报警任务是否启用。取值范围： true：已启用。 false：已停用。	true
MetricType	string	否	监控项类型。取值范围： system：使用云监控系统指标。 custom：使用上报到云监控的自定义指标。	system
MetricName	string	否	监控项名称。	CpuUtilization
PageSize	integer	否	分页查询时设置的每页行数。最大值：50。默认值：10。	10
PageNumber	integer	否	伸缩规则列表的页码，起始值：1。默认值：1。	1

返回参数

名称	类型	描述	示例值
	object	响应结构。
PageSize	integer	每页行数。	10
RequestId	string	请求 ID。	871C7C53-34A4-45AA-8C14-4B72FA6A****
PageNumber	integer	当前页码。	1
TotalCount	integer	报警任务的总数。	2
AlarmList	array<object>	报警任务的列表。
Alarm	object	报警任务的列表。
AlarmTaskId	string	报警任务 ID。	asg-bp1hvbnmkl10vll5**_f95ce797-dc2e-4bad-9618-14fee7d1**
MetricName	string	监控项名称。可能值： CpuUtilization：（ECS）CPU 使用率（%）。 ConcurrentConnections：（ECS）ECS 同时连接数（个）。 IntranetTx：（ECS）内网出流量（Kb/min）。 IntranetRx：（ECS）内网入流量（Kb/min）。 VpcInternetTx：（ECS）外网出流量（Kb/min）。 VpcInternetRx：（ECS）外网入流量（Kb/min）。 SystemDiskReadBps：（ECS）系统盘读 BPS（Byte/s）。 SystemDiskWriteBps：（ECS）系统盘写 BPS（Byte/s）。 SystemDiskReadOps：（ECS）系统盘读 IOPS（次/s）。 SystemDiskWriteOps：（ECS）系统盘写 IOPS（次/s）。 CpuUtilizationAgent：（Agent）CPU 使用率（%）。 GpuUtilizationAgent：（Agent）GPU 使用率（%）。 GpuMemoryFreeUtilizationAgent：（Agent）GPU 内存空闲率（%）。 GpuMemoryUtilizationAgent：（Agent）GPU 内存使用率（%）。 MemoryUtilization：（Agent）内存（%）。 LoadAverage：（Agent）系统平均负载。 TcpConnection：（Agent）TCP 总连接数（个）。 TcpConnection：（Agent）TCP 已建立连接数（个）。 PackagesNetOut：（Agent）内网网卡发包数（个/s）。 PackagesNetIn：（Agent）内网网卡收包数（个/s）。 PackagesNetOut：（Agent）外网网卡发包数（个/s）。 PackagesNetIn：（Agent）外网网卡收包数（个/s）。 EciPodCpuUtilization：CPU 使用率（%）。 EciPodMemoryUtilization：内存（%）。 LoadBalancerRealServerAverageQps：（ALB）服务器组单机 QPS（次/s）。更多信息，请参见系统监控报警任务。	CpuUtilization
EvaluationCount	integer	触发执行伸缩规则需要满足阈值表达式的次数，例如，CPU 使用率平均值 3 次的统计结果均大于等于 80%。	3
State	string	报警任务的状态。可能值： ALARM：报警，已满足报警条件。 OK：正常，尚未满足报警条件。 INSUFFICIENT_DATA：数据不足，不足以判断是否满足了报警条件。	ALARM
Period	integer	统计监控项数据的周期，单位为秒。可能值： 15。 60。 120。 300。 900。说明仅 ECS 类型的伸缩组支持设置 15 秒的统计周期。	300
ScalingGroupId	string	报警任务关联的伸缩组的 ID。	asg-bp18p2yfxow2dloq****
ComparisonOperator	string	监控项统计值与阈值的比较符，用于指定监控项统计值与阈值在什么关系下满足条件。可能值：监控项统计值大于等于阈值。取值：>=。监控项统计值小于等于阈值。取值：<=。监控项统计值大于阈值。取值：>。监控项统计值小于阈值。取值：<。	>=
Effective	string	指定报警任务的生效时间段。	* * * * * ?
Description	string	报警任务的描述。	Test alarm task.
MetricType	string	监控项类型。可能值： system：使用云监控系统指标。 custom：使用上报到云监控的自定义指标。	system
Name	string	报警任务的名称。	TestAlarmTask
Threshold	float	监控指标的阈值，满足阈值表达式达到指定次数即触发执行伸缩规则。	80.0
Enable	boolean	报警任务是否启用。可能值： true：已启用。 false：已停用。	true
Statistics	string	统计监控项数据的方法。可能值： Average：平均值。 Minimum：最小值。 Maximum：最大值。	Average
Dimensions	array<object>	监控项关联的维度信息。
Dimension	object	监控项关联的维度信息。
DimensionKey	string	监控项关联的维度信息键，可能值： user_id：您的账号 ID。 scaling_group：被监控的伸缩组。 device：网卡设备的类型。 state：TCP 连接的状态。	device
DimensionValue	string	监控项关联的维度信息值，取值范围由维度信息键决定。 `user_id`：由系统自动填充。 `scaling_group`：由系统自动填充。 `device`取值范围： eth0：对于经典网络实例，eth0 表示内网网卡。对于 VPC 实例，只存在 eth0 一张网卡。 eth1：对于经典网络实例，eth1 代表外网网卡。 `state`取值范围： TCP_TOTAL：表示总的 TCP 连接数。 ESTABLISHED：表示已建立的 TCP 连接数。	eth0
AlarmActions	array	报警任务关联伸缩规则的唯一标识符的列表。
AlarmAction	string	报警任务关联伸缩规则的唯一标识符的列表。	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp163l21e07uh**
Expressions	array<object>	多指标报警规则的相关信息。
Expression	object	多指标报警规则的相关信息。
MetricName	string	多指标报警规则的监控指标名称。可能值： CpuUtilization：（ECS）CPU 使用率（%）。 ConcurrentConnections：（ECS）ECS 同时连接数（个）。 IntranetTx：（ECS）内网出流量（Kb/min）。 IntranetRx：（ECS）内网入流量（Kb/min）。 VpcInternetTx：（ECS）外网出流量（Kb/min）。 VpcInternetRx：（ECS）外网入流量（Kb/min）。 SystemDiskReadBps：（ECS）系统盘读 BPS（Byte/s）。 SystemDiskWriteBps：（ECS）系统盘写 BPS（Byte/s）。 SystemDiskReadOps：（ECS）系统盘读 IOPS（次/s）。 SystemDiskWriteOps：（ECS）系统盘写 IOPS（次/s）。 CpuUtilizationAgent：（Agent）CPU 使用率（%）。 GpuUtilizationAgent：（Agent）GPU 使用率（%）。 GpuMemoryFreeUtilizationAgent：（Agent）GPU 内存空闲率（%）。 GpuMemoryUtilizationAgent：（Agent）GPU 内存使用率（%）。 MemoryUtilization：（Agent）内存（%）。 LoadAverage：（Agent）系统平均负载。 TcpConnection：（Agent）TCP 总连接数（个）。 TcpConnection：（Agent）TCP 已建立连接数（个）。 PackagesNetOut：（Agent）内网网卡发包数（个/s）。 PackagesNetIn：（Agent）内网网卡收包数（个/s）。 PackagesNetOut：（Agent）外网网卡发包数（个/s）。 PackagesNetIn：（Agent）外网网卡收包数（个/s）。 EciPodCpuUtilization：CPU 使用率（%）。 EciPodMemoryUtilization：内存（%）。 LoadBalancerRealServerAverageQps：（ALB）服务器组单机 QPS（次/s）。更多信息，请参见系统监控报警任务。	CpuUtilization
ComparisonOperator	string	多指标报警规则的监控项统计值与阈值的比较符，用于指定监控项统计值与阈值在什么关系下满足条件。可能值：监控项统计值大于等于阈值。取值：>=。监控项统计值小于等于阈值。取值：<=。监控项统计值大于阈值。取值：>。监控项统计值小于阈值。取值：<。	>=
Period	integer	多指标报警规则中统计监控项数据的周期，单位为秒。可能值： 15。 60。 120。 300。 900。说明仅当监控 ECS 类型伸缩组时，使用云监控（Agent 开头的监控项）客户端采集的监控项指标，才可以选择 15 秒的统计周期。	900
Statistics	string	多指标报警规则中统计监控项数据的方法。可能值： Average：平均值。 Minimum：最小值。 Maximum：最大值。	Average
Threshold	float	多指标报警规则中监控指标的阈值，满足阈值表达式达到指定次数即触发执行伸缩规则。	40.0
ExpressionsLogicOperator	string	多指标报警条件之间的关系。可能值： `&&`：当所有监控指标都符合报警条件时，才能触发报警。即当多指标报警规则下的表达式均为`true`时，才能触发报警。 `\|\|`：如果其中一个指标符合报警条件，即可触发报警。	&&

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "871C7C53-34A4-45AA-8C14-4B72FA6A****",
  "PageNumber": 1,
  "TotalCount": 2,
  "AlarmList": [
    {
      "AlarmTaskId": "asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****",
      "MetricName": "CpuUtilization",
      "EvaluationCount": 3,
      "State": "ALARM",
      "Period": 300,
      "ScalingGroupId": "asg-bp18p2yfxow2dloq****",
      "ComparisonOperator": ">=",
      "Effective": "* * * * * ?",
      "Description": "Test alarm task.",
      "MetricType": "system",
      "Name": "TestAlarmTask",
      "Threshold": 80,
      "Enable": true,
      "Statistics": "Average",
      "Dimensions": [
        {
          "DimensionKey": "device",
          "DimensionValue": "eth0"
        }
      ],
      "AlarmActions": [
        "ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp163l21e07uh****"
      ],
      "Expressions": [
        {
          "MetricName": "CpuUtilization",
          "ComparisonOperator": ">=",
          "Period": 900,
          "Statistics": "Average",
          "Threshold": 40
        }
      ],
      "ExpressionsLogicOperator": "&&",
      "HybridMonitorNamespace": "",
      "HybridMetrics": [
        {
          "Id": "",
          "Expression": "",
          "MetricName": "",
          "Statistic": "",
          "Dimensions": [
            {
              "DimensionKey": "",
              "DimensionValue": ""
            }
          ]
        }
      ],
      "PromQL": ""
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-09-13	OpenAPI 返回结构发生变更	查看变更详情