修改告警触发策略

最近更新时间:2019-05-16 19:39:25

1. 接口描述

接口请求域名: as.tencentcloudapi.com 。

本接口(ModifyScalingPolicy)用于修改告警触发策略。

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:as.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyScalingPolicy
Version String 公共参数,本接口取值:2018-04-19
Region String 公共参数,详见产品支持的 地域列表
AutoScalingPolicyId String 告警策略ID。
ScalingPolicyName String 告警策略名称。
AdjustmentType String 告警触发后,期望实例数修改方式。取值 :
  • CHANGE_IN_CAPACITY:增加或减少若干期望实例数
  • EXACT_CAPACITY:调整至指定期望实例数
  • PERCENT_CHANGE_IN_CAPACITY:按百分比调整期望实例数
  • AdjustmentValue Integer 告警触发后,期望实例数的调整值。取值:
  • 当 AdjustmentType 为 CHANGE_IN_CAPACITY 时,AdjustmentValue 为正数表示告警触发后增加实例,为负数表示告警触发后减少实例
  • 当 AdjustmentType 为 EXACT_CAPACITY 时,AdjustmentValue 的值即为告警触发后新的期望实例数,需要大于或等于0
  • 当 AdjustmentType 为 PERCENT_CHANGE_IN_CAPACITY 时,AdjusmentValue 为正数表示告警触发后按百分比增加实例,为负数表示告警触发后按百分比减少实例,单位是:%。
  • Cooldown Integer 冷却时间,单位为秒。
    MetricAlarm MetricAlarm 告警监控指标。
    NotificationUserGroupIds.N Array of String 通知组ID,即为用户组ID集合,用户组ID可以通过DescribeUserGroup查询。
    如果需要清空通知用户组,需要在列表中传入特定字符串 "NULL"。

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 修改告警触发策略

    输入示例

    https://as.tencentcloudapi.com/?Action=ModifyScalingPolicy
    &AutoScalingPolicyId=asp-iir70sxv
    &ScalingPolicyName=cpu_policy_test
    &AdjustmentType=CHANGE_IN_CAPACITY
    &AdjustmentValue=1
    &Cooldown=60
    &MetricAlarm.ComparisonOperator=GREATER_THAN
    &MetricAlarm.MetricName=CPU_USAGE
    &MetricAlarm.Statistic=AVERAGE
    &MetricAlarm.Threshold=50
    &MetricAlarm.Period=60
    &MetricAlarm.ContinuousTime=5
    &NotificationUserGroupIds.0=1678
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "91413a64-9587-486b-aef4-9aba5e8a0068"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InvalidParameterValue.ScalingPolicyNameDuplicate 告警策略名称重复。
    ResourceNotFound.ScalingPolicyNotFound 告警策略不存在。