有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(CreateScalingPolicy)用于创建告警触发策略。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateScalingPolicy。
Version String 公共参数,本接口取值:2018-04-19。
Region String 公共参数,详见产品支持的 地域列表
AutoScalingGroupId String 伸缩组ID。
示例值:asg-12wjuh0s
ScalingPolicyName String 告警触发策略名称。
示例值:cpu_policy_test
ScalingPolicyType String 告警触发策略类型,默认类型为SIMPLE。取值范围:
  • SIMPLE:简单策略
  • TARGET_TRACKING:目标追踪策略

  • 示例值:SIMPLE
    AdjustmentType String 告警触发后,期望实例数修改方式,仅适用于简单策略。取值范围:
  • CHANGE_IN_CAPACITY:增加或减少若干期望实例数
  • EXACT_CAPACITY:调整至指定期望实例数
  • PERCENT_CHANGE_IN_CAPACITY:按百分比调整期望实例数

  • 示例值:CHANGE_IN_CAPACITY
    AdjustmentValue Integer 告警触发后,期望实例数的调整值,仅适用于简单策略。
  • 当 AdjustmentType 为 CHANGE_IN_CAPACITY 时,AdjustmentValue 为正数表示告警触发后增加实例,为负数表示告警触发后减少实例
  • 当 AdjustmentType 为 EXACT_CAPACITY 时,AdjustmentValue 的值即为告警触发后新的期望实例数,需要大于或等于0
  • 当 AdjustmentType 为 PERCENT_CHANGE_IN_CAPACITY 时,AdjusmentValue 为正数表示告警触发后按百分比增加实例,为负数表示告警触发后按百分比减少实例,单位是:%。
    示例值:1
  • Cooldown Integer 冷却时间,单位为秒,仅适用于简单策略。默认冷却时间300秒。
    示例值:60
    MetricAlarm MetricAlarm 告警监控指标,仅适用于简单策略。
    PredefinedMetricType String 预定义监控项,仅适用于目标追踪策略。取值范围:
  • ASG_AVG_CPU_UTILIZATION:平均CPU使用率
  • ASG_AVG_LAN_TRAFFIC_OUT:平均内网出带宽
  • ASG_AVG_LAN_TRAFFIC_IN:平均内网入带宽
  • ASG_AVG_WAN_TRAFFIC_OUT:平均外网出带宽
  • ASG_AVG_WAN_TRAFFIC_IN:平均外网出带宽

  • 示例值:ASG_AVG_CPU_UTILIZATION
    TargetValue Integer 目标值,仅适用于目标追踪策略。
  • ASG_AVG_CPU_UTILIZATION:[1, 100),单位:%
  • ASG_AVG_LAN_TRAFFIC_OUT:>0,单位:Mbps
  • ASG_AVG_LAN_TRAFFIC_IN:>0,单位:Mbps
  • ASG_AVG_WAN_TRAFFIC_OUT:>0,单位:Mbps
  • ASG_AVG_WAN_TRAFFIC_IN:>0,单位:Mbps

  • 示例值:10
    EstimatedInstanceWarmup Integer 实例预热时间,单位为秒,仅适用于目标追踪策略。取值范围为0-3600,默认预热时间300秒。
    示例值:300
    DisableScaleIn Boolean 是否禁用缩容,仅适用于目标追踪策略,默认值为 false。取值范围:
  • true:目标追踪策略仅触发扩容
  • false:目标追踪策略触发扩容和缩容

  • 示例值:false
    NotificationUserGroupIds.N Array of String 此参数已不再生效,请使用创建通知
    通知组ID,即为用户组ID集合。
    示例值:["1678"]

    3. 输出参数

    参数名称 类型 描述
    AutoScalingPolicyId String 告警触发策略ID。
    示例值:asp-iir70sxv
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 创建目标追踪策略:CPU 平均利用率

    保持伸缩组 CPU 平均利用率接近60%,告警触发的扩容实例预热300秒,关闭禁用缩容。

    输入示例

    POST / HTTP/1.1
    Host: as.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateScalingPolicy
    <公共请求参数>
    
    {
        "AutoScalingGroupId": "asg-9dn1a5y6",
        "ScalingPolicyName": "cpu_target_tracking_test",
        "ScalingPolicyType": "TARGET_TRACKING",
        "PredefinedMetricType": "ASG_AVG_CPU_UTILIZATION",
        "EstimatedInstanceWarmup": 300,
        "DisableScaleIn": false,
        "TargetValue": 60
    }

    输出示例

    {
        "Response": {
            "AutoScalingPolicyId": "asp-ljr51ssq",
            "RequestId": "58a8ac17-e864-4bf6-81c7-c5dc63b0057d"
        }
    }

    示例2 创建简单策略: CPU 平均利用率

    1分钟内,CPU平均利用率大于50%,连续发生5次,期望实例数增加1。

    输入示例

    POST / HTTP/1.1
    Host: as.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateScalingPolicy
    <公共请求参数>
    
    {
        "AutoScalingGroupId": "asg-12wjuh0s",
        "Cooldown": "60",
        "ScalingPolicyType": "SIMPLE",
        "ScalingPolicyName": "cpu_policy_test",
        "AdjustmentType": " CHANGE_IN_CAPACITY",
        "MetricAlarm": {
            "Period": "60",
            "ContinuousTime": "5",
            "ComparisonOperator": "GREATER_THAN",
            "Statistic": "AVERAGE",
            "Threshold": "50",
            "MetricName": "CPU_UTILIZATION"
        },
        "NotificationUserGroupIds": [
            "1678"
        ],
        "AdjustmentValue": "1"
    }

    输出示例

    {
        "Response": {
            "AutoScalingPolicyId": "asp-iir70sxv",
            "RequestId": "fb02c8bd-5f38-4786-91b6-0c6e06a88832"
        }
    }

    示例3 创建简单策略:内存平均利用率

    1分钟内,内存平均利用率小于35%,连续发生5次,减少50%实例。

    输入示例

    POST / HTTP/1.1
    Host: as.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateScalingPolicy
    <公共请求参数>
    
    {
        "AutoScalingGroupId": "asg-12wjuh0s",
        "Cooldown": "300",
        "ScalingPolicyType": "SIMPLE",
        "ScalingPolicyName": "mem_policy_test",
        "AdjustmentType": " PERCENT_CHANGE_IN_CAPACITY",
        "MetricAlarm": {
            "Period": "60",
            "ContinuousTime": "5",
            "ComparisonOperator": "LESS_THAN",
            "Statistic": "AVERAGE",
            "Threshold": "50",
            "MetricName": "MEM_UTILIZATION"
        },
        "NotificationUserGroupIds": [
            "1678"
        ],
        "AdjustmentValue": "-50"
    }

    输出示例

    {
        "Response": {
            "AutoScalingPolicyId": "asp-f59pppuh",
            "RequestId": "116213d6-2269-44cc-af76-c4a8dc7dbdf9"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError.CallMonitorError Monitor接口调用失败。
    InternalError.CallNotificationError 通知服务接口调用失败。
    InternalError.RequestError 内部请求错误。
    InvalidParameter.ActionNotFound 无效的Action请求。
    InvalidParameterValue.InvalidAutoScalingGroupId 伸缩组ID无效。
    InvalidParameterValue.InvalidNotificationUserGroupId 指定的通知组 ID 不是数值字符串格式。
    InvalidParameterValue.LimitExceeded 取值超出限制。
    InvalidParameterValue.Range 取值超出指定范围。
    InvalidParameterValue.ScalingPolicyNameDuplicate 告警策略名称重复。
    InvalidParameterValue.ThresholdOutOfRange 指定的阈值不在有效范围。
    InvalidParameterValue.TooLong 取值过多。
    InvalidParameterValue.UserGroupIdNotFound 用户组不存在。
    LimitExceeded.QuotaNotEnough 当前剩余配额不足。
    LimitExceeded.TargetTrackingScalingPolicy 每个伸缩组限制创建一个目标追踪策略。
    ResourceNotFound.AutoScalingGroupNotFound 伸缩组不存在。