创建告警触发策略
最近更新时间: 2024-09-03 18:49:37
1. 接口描述
接口请求域名： as.api3.cloud.sunhongs.com。
本接口（CreateScalingPolicy）用于创建告警触发策略。
默认接口请求频率限制：20次/秒。
接口更新时间：2022-11-04 09:58:02。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateScalingPolicy |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-19 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| AutoScalingGroupId | 是 | 否 | String | 伸缩组ID。 |
| ScalingPolicyName | 是 | 否 | String | 告警触发策略名称。 |
| AdjustmentType | 是 | 否 | String | 告警触发后，期望实例数修改方式。取值 ：<br><li>CHANGE_IN_CAPACITY：增加或减少若干期望实例数</li><li>EXACT_CAPACITY：调整至指定期望实例数</li> <li>PERCENT_CHANGE_IN_CAPACITY：按百分比调整期望实例数</li> |
| AdjustmentValue | 是 | 否 | Int64 | 告警触发后，期望实例数的调整值。取值：<br><li>当 AdjustmentType 为 CHANGE_IN_CAPACITY 时，AdjustmentValue 为正数表示告警触发后增加实例，为负数表示告警触发后减少实例 </li> <li> 当 AdjustmentType 为 EXACT_CAPACITY 时，AdjustmentValue 的值即为告警触发后新的期望实例数，需要大于或等于0 </li> <li> 当 AdjustmentType 为 PERCENT_CHANGE_IN_CAPACITY 时，AdjusmentValue 为正数表示告警触发后按百分比增加实例，为负数表示告警触发后按百分比减少实例，单位是：%。 |
| Cooldown | 否 | 否 | Uint64 | 冷却时间，单位为秒。默认冷却时间300秒。 |
| MetricAlarm | 是 | 否 | MetricAlarm | 告警监控指标。 |
| NotificationUserGroupIds | 否 | 否 | Array of String | 通知组ID，即为用户组ID集合，用户组ID可以通过DescribeUserGroup查询。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AutoScalingPolicyId | String | 告警触发策略ID。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound.AutoScalingGroupIdNotFound | |
| InvalidParameterValue.ScalingPolicyNameDuplicate | |
| InvalidParameterValue.LimitExceeded | |
| InvalidParameterValue.UserGroupIdNotFound | |
| InternalError.RequestError |