调用DescribeAlarms查询报警任务的信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAlarms

系统规定参数。取值:DescribeAlarms

RegionId String cn-qingdao

报警任务所属地域的ID。

ScalingGroupId String asg-bp18p2yfxow2dloq****

报警任务关联的伸缩组的ID。

AlarmTaskId String asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****

报警任务ID。

State String OK

报警任务的状态。取值范围:

  • ALARM:报警,已满足报警条件。
  • OK:正常,尚未满足报警条件。
  • INSUFFICIENT_DATA:数据不足,不足以判断是否满足了报警条件。
IsEnable Boolean true

报警任务是否启用。取值范围:

  • true:已启用。
  • false:已停用。
MetricType String system

监控项类型。取值范围:

  • system:使用云监控系统指标。
  • custom:使用上报到云监控的自定义指标。
MetricName String CpuUtilization

报警任务的名称。

PageSize Integer 10

分页查询时设置的每页行数。最大值:50。

默认值:10。

PageNumber Integer 1

报警任务列表的页码。起始值:1。

默认值:1。

返回数据

名称 类型 示例值 描述
PageSize Integer 10

每页行数。

RequestId String 871C7C53-34A4-45AA-8C14-4B72FA6A****

请求ID。

PageNumber Integer 1

当前页码。

TotalCount Integer 2

报警任务的总数。

AlarmList Array of Alarm

报警任务的列表。

Alarm
AlarmTaskId String asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****

报警任务ID。

MetricName String CpuUtilization

监控项名称。可能值:

  • CpuUtilization:(ECS)CPU使用率(%)。
  • IntranetTx:(ECS)内网出流量(KByte/min)。
  • IntranetRx:(ECS)内网入流量(KByte/min)。
  • VpcInternetTx:(ECS)外网出流量(KByte/min)。
  • VpcInternetRx:(ECS)外网入流量(KByte/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)内网网卡发包数(个)。
  • PackagesNetIn:(Agent)内网网卡收包数(个)。
  • EciPodCpuUtilization:CPU使用率(%)。
  • EciPodMemoryUtilization:内存(%)。

更多信息,请参见系统监控报警任务

EvaluationCount Integer 3

触发执行伸缩规则需要满足阈值表达式的次数,例如,CPU使用率平均值3次的统计结果均大于等于80%。

State String ALARM

报警任务的状态。可能值:

  • ALARM:报警,已满足报警条件。
  • OK:正常,尚未满足报警条件。
  • INSUFFICIENT_DATA:数据不足,不足以判断是否满足了报警条件。
Period Integer 300

统计监控项数据的周期,单位为秒。可能值:

  • 15。
  • 60。
  • 120。
  • 300。
  • 900。
说明 仅当监控ECS类型伸缩组时,使用云监控(Agent开头的监控项)客户端采集的监控项指标,才可以选择15秒的统计周期。
ScalingGroupId String asg-bp18p2yfxow2dloq****

报警任务关联的伸缩组的ID。

ComparisonOperator String >=

监控项统计值与阈值的比较符,用于指定监控项统计值与阈值在什么关系下满足条件。可能值:

  • 监控项统计值大于等于阈值。取值:>=。
  • 监控项统计值小于等于阈值。取值:<=。
  • 监控项统计值大于阈值。取值:>。
  • 监控项统计值小于阈值。取值:<。
Effective String Test
说明 该参数正在邀测中,暂未开放使用。
Description String Test alarm task.

报警任务的描述。

MetricType String system

监控项类型。可能值:

  • system:使用云监控系统指标。
  • custom:使用上报到云监控的自定义指标。
Name String TestAlarmTask

报警任务的名称。

Threshold Float 80.0

监控指标的阈值,满足阈值表达式达到指定次数即触发执行伸缩规则。

Enable Boolean true

报警任务是否启用。可能值:

  • true:已启用。
  • false:已停用。
Statistics String Average

统计监控项数据的方法。可能值:

  • Average:平均值。
  • Minimum:最小值。
  • Maximum:最大值。
Dimensions Array of Dimension

监控项关联的维度信息。

Dimension
DimensionKey String device

监控项关联的维度信息键,可能值:

  • user_id:您的账号ID。
  • scaling_group:被监控的伸缩组。
  • device:网卡设备的类型。
  • state:TCP连接的状态。
DimensionValue String eth0

监控项关联的维度信息值,可能值由维度信息键决定。

user_id:由系统自动填充。

scaling_group:由系统自动填充。

device的可能值:

  • eth0:对于经典网络实例,eth0表示内网网卡。对于VPC实例,只存在eth0一张网卡。
  • eth1:对于经典网络实例,eth1代表外网网卡。

state的可能值:

  • TCP_TOTAL:表示总的TCP连接数。
  • ESTABLISHED:表示已建立的TCP连接数。
AlarmActions Array of String ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp163l21e07uh****

报警任务关联伸缩规则的唯一标识符的列表。

Expressions Array of Expression

多指标报警规则的相关信息。

Expression
MetricName String CpuUtilization

多指标报警规则的监控指标名称。可能值:

  • CpuUtilization:(ECS)CPU使用率(%)。
  • IntranetTx:(ECS)内网出流量(KByte/min)。
  • IntranetRx:(ECS)内网入流量(KByte/min)。
  • VpcInternetTx:(ECS)外网出流量(KByte/min)。
  • VpcInternetRx:(ECS)外网入流量(KByte/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)内网网卡发包数(个)。
  • PackagesNetIn:(Agent)内网网卡收包数(个)。
  • EciPodCpuUtilization:CPU使用率(%)。
  • EciPodMemoryUtilization:内存(%)。

更多信息,请参见系统监控报警任务

ComparisonOperator String >=

多指标报警规则的监控项统计值与阈值的比较符,用于指定监控项统计值与阈值在什么关系下满足条件。可能值:

  • 监控项统计值大于等于阈值。取值:>=。
  • 监控项统计值小于等于阈值。取值:<=。
  • 监控项统计值大于阈值。取值:>。
  • 监控项统计值小于阈值。取值:<。

默认值:>=。

Period Integer 900

多指标报警规则中统计监控项数据的周期,单位为秒。可能值:

  • 15。
  • 60。
  • 120。
  • 300。
  • 900。
说明 仅当监控ECS类型伸缩组时,使用云监控(Agent开头的监控项)客户端采集的监控项指标,才可以选择15秒的统计周期。
Statistics String Average

多指标报警规则中统计监控项数据的方法。可能值:

  • Average:平均值。
  • Minimum:最小值。
  • Maximum:最大值。
Threshold Float 40.0

多指标报警规则中监控指标的阈值,满足阈值表达式达到指定次数即触发执行伸缩规则。

ExpressionsLogicOperator String &&

多指标报警条件之间的关系。可能值:

  • &&:当所有监控指标都符合报警条件时,才能触发报警。即当多指标报警规则下的表达式均为true时,才能触发报警。
  • ||:如果其中一个指标符合报警条件,即可触发报警。

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=DescribeAlarms
&RegionId=cn-qingdao
&ScalingGroupId=asg-bp18p2yfxow2dloq****
&AlarmTaskId=asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****
&State=OK
&IsEnable=true
&MetricType=system
&MetricName=CpuUtilization
&PageSize=10
&PageNumber=1
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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" : "Test",
    "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" : "&&"
  } ]
}

错误码

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