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