伸缩活动相关接口
更新时间：2024-06-13
查询伸缩活动
接口描述
查询伸缩日志列表的接口
请求结构
Method: Get
Url: /v1/record
请求参数
| 名称 | 类型 | 是否必须 | 描述 | 参数位置 |
|---|---|---|---|---|
| groupid | String | 是 | 伸缩组 ID | QueryParam |
| pageNo | int | 是 | 页的号码 | QueryParam |
| orderBy | String | 是 | 开始的时间，只支持：startTime | QueryParam |
| order | String | 否 | 默认 desc 降序 | QueryParam |
| pageSize | int | 否 | 每页的大小，默认 1000 | QueryParam |
| startTime | Date | 否 | 活动开始时间，格式：2022-03-15T10:30:00Z，不填写默认不约束 | QueryParam |
| endTime | Date | 否 | 活动结束时间，格式：2022-03-15T10:30:00Z，不填写默认不约束 | QueryParam |
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| orderBy | String | 排序字段 |
| order | String | 排序方式 |
| pageNo | int | 页码数 |
| pageSize | int | 每页返回结果数 |
| totalCount | int | 符合条件的查询结果数 |
| result | List<AsRecord> | 查询结果 |
请求示例
// 查询 asg-sTufxxxx 的执行活动
GET /v1/record?groupid=asg-sTufxxxx&pageNo=1&orderBy=startTime&startTime=2023-12-08T02:21:17Z&endTime=2023-12-08T02:21:17Z 响应示例
{
"orderBy": "startTime",
"order": "desc",
"pageNo": 1,
"pageSize": 1000,
"totalCount": 1,
"result": [
{
"groupId": "asg-sTufxxxx",
"recordId": "task-FRGCxxxx",
"startTime": "2023-12-08T02:21:17Z",
"result": "SUCCESS",
"actualScaleNode": [
"i-mGi6xxxx"
],
"remainedNode": [
"i-yq8qxxxx",
"i-iaBoxxxx",
"i-J4Rtxxxx",
"i-Ut5Yxxxx"
],
"action": "MANUAL_SCALE_DOWN",
"scaleCondition": null,
"ruleId": "",
"message": "",
"expectAction": {
"actionType": "DECREASE",
"actionNum": 1,
"adjustToNum": 4
},
"executeType": "DECREASE",
"dagId": "d-IGHJtMBh4ncm"
}
]
}执行伸缩规则
接口描述
对某个伸缩组执行伸缩规则
请求结构
Method: Post
Url: /v1/group/{groupId}?execRule
请求参数
| 名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| groupid | String | 是 | PathParam | 伸缩组 ID |
| ruleId | String | 是 | RequestBody | 伸缩组规则的 ID |
| execRule | String | 是 | QueryParam | 不需要赋值，只用于标识执行伸缩规则 |
响应参数
无响应参数，根据响应状态判断是否成功
请求示例
POST /v1/group/asg-sTufxxxx?execRule
{
"ruleId" : "asrule-Z5l7xxxx"
}响应示例
无返回
手动扩容
接口描述
对伸缩组进行扩容
请求结构
Method: Post
Url: /v1/group/{groupId}?scalingUp
请求参数
| 名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| groupid | String | 是 | PathParam | 伸缩组 ID |
| scalingUp | String | 是 | QueryParam | 不需要赋值，只用于标识扩容操作 |
| nodeCount | int | 否 | RequestBody | 节点数量 |
| zone | List<String> | 是 | RequestBody | 区域信息 |
| expansionStrategy | String | 否 | RequestBody | 扩容策略 ( Priority - 以单独可用区进行创建 ; Balanced - 在选定可用区中均衡创建) |
响应参数
无响应参数，根据响应状态判断是否成功
请求示例
POST /v1/group/asg-sTufxxxx?scalingUp
{
"nodeCount":1,
"zone":["zoneB"],
"expansionStrategy":"Priority"
}响应示例
无返回
手动缩容
接口描述
对伸缩组进行缩容
请求结构
Method: Post
Url: /v1/group/{groupId}?scalingDown
请求参数
| 名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| groupid | String | 是 | PathParam | 伸缩组 ID |
| scalingDown | String | 是 | QueryParam | 不需要赋值，只用于标识缩容操作 |
| nodes | List<String> | 是 | RequestBody | 期望缩容的节点列表 |
响应参数
无响应参数，根据响应状态判断是否成功
请求示例
POST /v1/group/asg-sTufxxxx?scalingDown
{
"nodes" : [
"i-XPWvxxxx"
]
}响应示例
无返回
手动调整到节点数
接口描述
将伸缩组中节点数设置为指定值
请求结构
Method: Post
Url: /v1/group/{groupId}?adjustNode
请求参数
| 名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| groupid | String | 是 | PathParam | 伸缩组 ID |
| adjustNode | String | 是 | QueryParam | 不需要赋值，只用于标识调整节点操作 |
| adjustNum | int | 是 | RequestBody | 期望调整到的节点数 |
响应参数
无响应参数，根据响应状态判断是否成功
请求示例
POST /v1/group/asg-sTufxxxx?adjustNode
{
"adjustNum" : 3
}响应示例
无返回
手动添加节点
接口描述
将指定节点添加到伸缩组中
请求结构
Method: Post
Url: /v1/group/{groupId}?attachNode
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| groupid | String | 伸缩组 ID | 是 | PathParam |
| attachNode | String | 不需要赋值，只用于标识添加节点操作 | 是 | QueryParam |
| nodes | List<String> | 期望添加的节点列表 | 是 | RequestBody |
响应参数
无响应参数，根据响应状态判断是否成功
请求示例
POST /v1/group/asg-sTufLpId?attachNode
{
"nodes" : [
"i-XPWvxxxx"
]
}响应示例
无返回
附录
AsRecord
| 字段名 | 类型 | 描述 |
|---|---|---|
| groupId | String | 伸缩组ID |
| recordId | String | 记录ID |
| startTime | String | 开始时间 |
| result | String | 执行结果 |
| actualScaleNode | List<String> | 实际操作的节点列表 |
| remainedNode | List<String> | 剩余的节点列表 |
| action | Action | 动作 |
| scaleCondition | ScaleCondition | 伸缩条件 |
| ruleId | String | 规则 ID |
| expectAction | ExpectAction | 预期的行为 |
| executeType | String | 执行类型 |
ScaleCondition
| 字段名 | 类型 | 描述 |
|---|---|---|
| targetType | String | 指标类型，如伸缩组指标为ASG |
| targetId | String | 报警监控实例，如伸缩组ID：asg-CClxxxxx |
| indicator | String | 监控指标。如伸缩组CPU使用率均值为CPUUsagePercent_Average |
| threshold | String | 阈值 |
| unit | String | 单位 |
| comparisonOperator | String | 比较运算符，支持'>'，'<'，'=' |
| cronTime | String | 定时规则或周期规则：当日执行时间。如12:30 |
| type | String | 包括：CRONTAB(定时伸缩),ALARM(报警触发伸缩),PERIOD(周期伸缩) |
| periodType | String | 周期单位，可选值为DAY/WEEK/MONTH/CronExpression |
| periodValue | int | 周期触发日期，1-7标识周1-周日，1-31表示1号到31号，与periodType相关 |
ExpectAction
| 字段名 | 类型 | 描述 |
|---|---|---|
| actionType | String | 动作类型。包括：INCREASE(扩容),DECREASE(缩容),ADJUST(调整至) |
| actionNum | int | 动作数量 |
| adjustToNum | int | 调整到的数量 |
Action
| 字段名 | 描述 |
|---|---|
| MANUAL_ATTACH_NODE | 手动添加节点 |
| MANUAL_DETACH_NODE | 手动删除节点 |
| MANUAL_SCALE_UP | 扩容 |
| MANUAL_SCALE_DOWN | 缩容 |
| MANUAL_SCALE_ADJUST | 调整 |