接口功能介绍
调用disableApplicationScalingRule禁用已部署应用的弹性扩缩容策略
接口约束
无
URI
POST /v1/app/inst/disableApplicationScalingRule
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID,请参考调用前必知-概述 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
appDeployId | 是 | String | 应用部署ID,数据来源于已部署应用列表 | ||
ruleId | 是 | String | 策略ID,数据来源于获取弹性扩缩容策略接口 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应编码 | 2000 | |
message | String | 消息内容 | ||
returnObj | Object | 返回对象 | returnObj | |
error | String | 调用错误时返回的错误编码 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
ruleId | String | 策略ID | ||
name | String | 策略名称 | ||
type | String | 策略类型 | ||
enable | Boolean | 禁用/启用策略 | ||
minReplicas | Integer | 最小应用实例数,可选范围: 0 - 1000 | 0 | |
maxReplicas | Integer | 最大应用实例数,可选范围: 2 - 1000 | 0 | |
trigger | Array of Strings | 触发条件配置数组 | trigger | |
behaviour | Object | 弹性扩缩容策略 | behaviour | |
createTime | String | 创建时间 | ||
createStaff | String | 创建用户 | ||
updateTime | String | 更新时间 | ||
updateStaff | String | 更新用户 |
表 trigger
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
name | String | 触发器名称 | ||
type | String | 触发器类型, 包括cron和metric类型 | ||
typeName | String | 触发器类型名称 | ||
metaData | Object | 触发器元数据 | metaData |
表 metaData
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
period | String | 周期类型,可填数据daily、weekly和monthly | ||
timerInDay | String | 按天触发配置列表 | ||
timerInWeek | Array of Strings | 按周触发 | ||
timerInMonth | Integer | 按月触发 | 0 | |
metricName | String | 指标类型,包括system_cpu、system_mem、incall_qps和incall_rt | ||
metricDesc | String | 指标描述 | ||
targetValAvg | Boolean | 按均值计算指标数据 | ||
targetValue | Integer | 目标值 | 0 | |
metricWindow | Integer | 指标聚合时间范围 | 0 |
表 behaviour
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
scaleDown | Object | 缩容行为对象 | scaleDown | |
scaleUp | Object | 扩容行为对象 | scaleUp |
表 scaleDown/scaleUp
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
selectPolicy | String | 选择策略 | ||
stabilizationWindowSeconds | Integer | 冷却时间 | 0 | |
policies | Array of Strings | 策略列表,最至少添加1条策略 | policies |
表 policies
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
periodSeconds | Integer | 扩缩容策略时间周期 | 0 | |
type | String | 扩缩容策略类型, 数据可填写Pods和Percent | ||
value | Integer | 扩缩容策略最大步长/百分比 | 0 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"appDeployId": "ddbdbfcc-8436-4ad4-9c1f-cdf64f45294b",
"ruleId": "a526001d-5b40-4651-9adf-35df5490c190"
}
响应示例
{
"statusCode": 2000,
"message": "成功",
"returnObj": {
"ruleId": "a526001d-5b40-4651-9adf-35df5490c190",
"name": "test-scale-rule1",
"type": "trigger",
"enable": false,
"minReplicas": 0,
"maxReplicas": 2,
"trigger": [
{
"name": "test-scale-rule-trigger1",
"type": "cron",
"metaData": {
"period": "daily",
"timerInDay": [
{
"atTime": "08: 00",
"horizonMode": true,
"targetReplicas": 1
},
{
"atTime": "10: 00",
"horizonMode": true,
"targetReplicas": 0
}
],
"timerInWeek": [
],
"timerInMonth": [
]
}
}
],
"behaviour": {
"scaleDown": {
"selectPolicy": "Min",
"stabilizationWindowSeconds": 5,
"policies": [
{
"periodSeconds": 54,
"type": "Pods",
"value": 2
}
]
},
"scaleUp": {
"selectPolicy": "Max",
"stabilizationWindowSeconds": 3,
"policies": [
{
"periodSeconds": 4,
"type": "Pods",
"value": 2
}
]
}
},
"createTime": "2022-08-30T20: 17: 19.000+08: 00",
"createStaff": "1234567890@qq.com#测试",
"updateTime": "2022-08-31T09: 13: 40.739+08: 00",
"updateStaff": "1234567890@qq.com#测试"
}
}
状态码
请参考 状态码
错误码
请参考 错误码