1. 接口描述
接口请求域名: as.tencentcloudapi.com 。
本接口(ModifyScalingPolicy)用于修改告警触发策略。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyScalingPolicy。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
AutoScalingPolicyId | 是 | String | 告警策略ID。 示例值:asp-iir70sxv |
ScalingPolicyName | 否 | String | 告警策略名称。 示例值:cpu_policy_test |
AdjustmentType | 否 | String | 告警触发后,期望实例数修改方式,仅适用于简单策略。取值范围: 示例值:CHANGE_IN_CAPACITY |
AdjustmentValue | 否 | Integer | 告警触发后,期望实例数的调整值,仅适用于简单策略。 示例值:1 |
Cooldown | 否 | Integer | 冷却时间,仅适用于简单策略,单位为秒。 示例值:60 |
MetricAlarm | 否 | MetricAlarm | 告警监控指标,仅适用于简单策略。 |
PredefinedMetricType | 否 | String | 预定义监控项,仅适用于目标追踪策略。取值范围: 示例值:ASG_AVG_CPU_UTILIZATION |
TargetValue | 否 | Integer | 目标值,仅适用于目标追踪策略。 示例值:10 |
EstimatedInstanceWarmup | 否 | Integer | 实例预热时间,单位为秒,仅适用于目标追踪策略。取值范围为0-3600。 示例值:300 |
DisableScaleIn | 否 | Boolean | 是否禁用缩容,仅适用于目标追踪策略。取值范围: 示例值:false |
NotificationUserGroupIds.N | 否 | Array of String | 此参数已不再生效,请使用创建通知。 通知组ID,即为用户组ID集合。 示例值:["1678"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改简单类型告警触发策略
指定策略ID,修改简单策略相关属性。
输入示例
POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyScalingPolicy
<公共请求参数>
{
"AutoScalingPolicyId": "asp-iir70sxv",
"Cooldown": "60",
"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": {
"RequestId": "91413a64-9587-486b-aef4-9aba5e8a0068"
}
}
示例2 修改目标追踪类型告警触发策略
指定策略ID,修改目标追踪策略相关属性。
输入示例
POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyScalingPolicy
<公共请求参数>
{
"AutoScalingPolicyId": "asp-9uroe7ta",
"ScalingPolicyName": "target-trackiing-test-policy",
"DisableScaleIn": false,
"EstimatedInstanceWarmup": 300,
"TargetValue": 60,
"PredefinedMetricType": "ASG_AVG_CPU_UTILIZATION"
}
输出示例
{
"Response": {
"RequestId": "881a6752-55e8-4485-878a-a80065732a9f"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.RequestError | 内部请求错误。 |
InvalidParameter.ActionNotFound | 无效的Action请求。 |
InvalidParameterValue.InvalidAutoScalingPolicyId | 告警策略ID无效。 |
InvalidParameterValue.InvalidNotificationUserGroupId | 指定的通知组 ID 不是数值字符串格式。 |
InvalidParameterValue.Range | 取值超出指定范围。 |
InvalidParameterValue.ScalingPolicyNameDuplicate | 告警策略名称重复。 |
InvalidParameterValue.ThresholdOutOfRange | 指定的阈值不在有效范围。 |
InvalidParameterValue.UserGroupIdNotFound | 用户组不存在。 |
ResourceNotFound.AutoScalingGroupNotFound | 伸缩组不存在。 |
ResourceNotFound.ScalingPolicyNotFound | 告警策略不存在。 |