全部产品
Search

搜索本产品

    弹性伸缩：CreateAlarm - 创建一个报警任务

    文档中心

    弹性伸缩：CreateAlarm - 创建一个报警任务

    更新时间：Nov 11, 2024

    针对具有突发性或时间上不易预测的业务，调用CreateAlarm创建一个报警任务，该任务关联云监控指标后，可以动态调整伸缩组内的ECS实例或ECI实例数量，并实时监控实例指标，帮助您更好地管理和维护云资源。

    接口说明

    • 如果您创建自定义监控类型的报警任务（MetricType=custom），您需要先将自定义监控项指标上报到云监控。具体操作，请参见自定义监控报警任务。
    • 创建报警任务时，您需要指定监控项（MetricName），并配合维度信息（Dimensions.DimensionKey 和 Dimensions.DimensionValue），来确定伸缩组中该监控项数据的聚合范围。例如，指定 user_id 和 scaling_group 来确定聚合该用户、该伸缩组下所有 ECS 实例或 ECI 实例的监控项数据。
      • 自定义监控报警任务（MetricType=custom）的监控项取决于您自有的监控指标。
      • 系统监控报警任务（MetricType=system）支持的监控项的更多信息，请参见系统监控报警任务。
    说明 维度信息中，user_id 和 scaling_group 由系统自动填充，device、state 需要您手动指定。更多信息，请参见参数Dimensions.DimensionKey和Dimensions.DimensionValue。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    RegionIdstring是

    伸缩组所属的地域 ID。

    		cn-hangzhou
    Namestring否

    报警任务的名称。

    		TestAlarmTask
    Descriptionstring否

    报警任务的描述。

    		Test alarm task.
    ScalingGroupIdstring是

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

    		asg-bp18p2yfxow2dloq****
    MetricNamestring否

    监控项名称。取值范围与报警任务的监控类型有关：

    • 当报警任务为自定义监控类型（即 MetricType=custom）时，取值范围是您自有的监控项范围。

    • 当报警任务为系统监控类型（即 MetricType=system）时，取值范围如下：

      • 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
    MetricTypestring否

    监控项类型。取值范围：

    • system：使用云监控系统指标。
    • custom：使用上报到云监控的自定义指标。
    		system
    Periodinteger否

    统计监控项数据的周期，单位：秒。取值范围：

    • 15。
    • 60。
    • 120。
    • 300。
    • 900。
    说明 仅 ECS 类型的伸缩组支持设置 15 秒的统计周期。

    默认值：300。

    		300
    Statisticsstring否

    统计监控项数据的方法。取值范围：

    • Average：平均值。
    • Minimum：最小值。
    • Maximum：最大值。

    默认值：Average。

    		Average
    Thresholdfloat否

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

    		80.0
    ComparisonOperatorstring否

    监控项统计值与阈值的比较符，用于指定监控项统计值与阈值在什么关系下满足条件。取值范围：

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

    默认值：>=。

    		>=
    EvaluationCountinteger否

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

    默认值：3。

    		3
    GroupIdinteger否

    自定义监控项所属云监控应用分组的 ID，仅在监控项类型为 custom 时需要指定该参数。

    		4055401
    Effectivestring否

    指定报警任务的生效时间段，默认所有时间都生效。

    该参数遵循 Cron 表达式，默认格式为X X X X X ?，含义如下：

    • X：一个域的占位符，依次表示秒、分钟、小时、日期和月。X 可以是确定的取值，也可以是具有逻辑意义的特殊字符。X 的取值范围，请参见 Cron 表达式。

    • ？：表示不指定值。

    说明 该参数指定值默认为 UTC+8 时区，支持在 Cron 表达式之前添加时区信息TZ=+yy来指定时区，其中 y 表示时区的数值。例如，TZ=+00 * * 1-2 * * ?表示报警任务在 UTC+0 时区每天 01:00~02:59 之间生效。

    取值示例及含义如下：

    • * * * * * ? ：所有时间都生效。

    • * * 17-18 * * ? ：在 UTC+8 时区每天 17:00~18:59 之间生效。

    • TZ=+00 * * 1-2 * * ?：在 UTC+0 时区每天 01:00~02:59 之间生效。

    		TZ=+00 * * 1-2 * * ?
    AlarmActionsarray否

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

    string否

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

    		ari:acs:ess:cn-hangzhou:1406926****:scalingrule/asr-bp163l21e07uhn****
    Dimensionsarray<object>否

    监控项关联的维度信息。

    object否

    监控项关联的维度信息。

    DimensionKeystring否

    监控项关联的维度信息键，取值范围与报警任务的监控类型有关：

    • 当报警任务为自定义监控类型（即 MetricType=custom）时，不限制取值范围，由您自行指定。

    • 当报警任务为系统监控类型（即 MetricType=system）时，取值范围如下：

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

    监控项关联的维度信息值，取值范围由 Dimensions.DimensionKey 决定：

    • 当 Dimensions.DimensionKey 的取值是自定义的，即报警任务是自定义监控类型（即 MetricType=custom）时，该参数不限制取值范围，由您自行指定。

    • 当 Dimensions.DimensionKey 的取值是系统指定的取值范围中的，即报警任务为系统监控类型（即 MetricType=system）时，该参数取值范围如下：

      • user_id：由系统自动填充。

      • scaling_group：由系统自动填充。

      • device：

        • eth0：对于经典网络实例，eth0 表示内网网卡。对于 VPC 实例，只存在 eth0 一张网卡。

        • eth1：对于经典网络实例，eth1 代表外网网卡。

      • state：

        • TCP_TOTAL：表示总的 TCP 连接数。

        • ESTABLISHED：表示已建立的 TCP 连接数。

    		eth0
    Expressionsarray<object>否

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

    object否

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

    MetricNamestring否

    多指标报警规则的监控指标名称。取值范围与报警任务的监控类型有关：

    • 当报警任务为自定义监控类型（即 MetricType=custom）时，取值范围是您自有的监控项范围。

    • 当报警任务为系统监控类型（即 MetricType=system）时，取值范围如下：

      • 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
    ComparisonOperatorstring否

    多指标报警规则的监控项统计值与阈值的比较符，用于指定监控项统计值与阈值在什么关系下满足条件。取值范围：

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

    默认值：>=。

    		>=
    Periodinteger否

    多指标报警规则中统计监控项数据的周期，单位：秒。取值范围：

    • 15。
    • 60。
    • 120。
    • 300。
    • 900。
    说明 仅 ECS 类型的伸缩组支持设置 15 秒的统计周期。

    默认值：300。

    		900
    Statisticsstring否

    多指标报警规则中统计监控项数据的方法。取值范围：

    • Average：平均值。
    • Minimum：最小值。
    • Maximum：最大值。

    默认值：Average。

    		Average
    Thresholdfloat否

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

    		40.0
    ExpressionsLogicOperatorstring否

    多指标报警条件之间的关系。取值范围：

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

    默认值： &&。

    		&&

    返回参数

    名称类型描述示例值
    object

    创建报警任务的返回信息集合。

    AlarmTaskIdstring

    报警任务 ID。

    		asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****
    RequestIdstring

    请求 ID。

    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

    示例

    正常返回示例

    JSON格式

    {
  "AlarmTaskId": "asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史