AddVmToScalingGroup
接口描述
手动添加云主机进伸缩组 (1) 检查云主机是否可以加入伸缩组,是否在同一个vpc下,是否在同一个地域,是否在同一个可用区,是否超过最大实例数,
并且云主机和伸缩组的状态都必须是Running
(2)只有健康检查有问题才会将云主机移除伸缩组,修改配置,定时任务,告警任务,手动添加的云主机只参与计数,不会移除
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
InstanceIds |
String[] |
是 |
云主机实例Id数组:加入伸缩组中的云主机实例必须和当前伸缩组在同一地域,同一可用区,同一VPC,并且云主机的状态是Running |
|
Id |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
ChangeActiveConfig
接口描述
切换伸缩组配置
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩配置唯一标识:伸缩配置Id |
|
GroupId |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
CreateAutoScalingGroup
接口描述
创建伸缩组:创建伸缩组需要设置负载均衡,监听器,最小实例数,最大实例数,退出策略等; 负载均衡和监听器是健康检查的数据来源;
最小实例数和最大实例数规定了该伸缩组云主机实例范围; 退出策略:在进行伸缩活动中云主机退出伸缩组的方式
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
RegionId |
String |
是 |
地域:Region的信息可以通过调用ListRegions接口获取,具体可参考ListRegions接口 |
|
ZoneId |
String |
是 |
可用区:Zone的信息可以通过调用listZones接口获取,具体可参考listZones接口 |
|
MaxNum |
Integer |
是 |
最大实例数:伸缩组中可以运行的最大云主机数据,取值范围:[0,1000] |
|
MinNum |
Integer |
是 |
最小实例数:伸缩组中最少处于运行状态的云主机数目,取值范围:[0,1000] |
|
QuitPolicy |
QuitPolicyType |
是 |
退出策略:云主机退出伸缩组的退出策略,分为最新退出策略(LatestExit)和最早退出策略(FirstExit)两种. |
|
CoolingTime |
Integer |
是 |
冷却时间:伸缩组进行两次伸缩活动的时间间隔,在冷却时间内伸缩组不会触发伸缩活动,取值范围:[300,9999] |
|
VpcId |
String |
是 |
vpcId |
|
LoadbalanceId |
String |
否 |
负载均衡:Loadbalance的信息可以通过调用ListLoadbalances接口获取,具体可参考ListLoadbalances接口 |
|
ListenerId |
String |
否 |
监听器:根据负载均衡获取其对应的监听器,具体可参考ListListeners接口 |
|
IsRelResources |
Boolean |
否 |
是否释放资源:当云主机退出伸缩组的时候,是否对云主机进行释放操作(现在是关机操作),默然为不释放 |
|
Description |
String |
否 |
描述 请填写中文, 英文字母, 数字, 空格,@ 和 _, -, 最长128个字符 |
|
RecycleInstanceType |
RecycleInstanceType |
否 |
|
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
CreateAutoScalingGroupConfig
接口描述
创建伸缩组配置,当伸缩组被触发要进行伸缩活动的时候的时候,以该伸缩组配置进行创建云主机,云主机的配置在该配置中进行定义
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
RegionId |
String |
是 |
地域:该地域决定了用户创建的云主机分布在哪里,Region的信息可以通过调用ListRegions接口获取,具体可参考ListRegions接口 |
|
ZoneId |
String |
是 |
可用区:Zone的信息可以通过调用listZones接口获取,具体可参考listZones接口 |
|
PodId |
String |
否 |
高可用域:Pod的信息可以通过调用ListPods接口获取,具体可参考ListPods接口 |
|
NetworkId |
String |
否 |
网络域:创建云主机的时候需要选择Vpc以及其所在的网络域,可以通过调用SelectVpcItem接口获取Vpc的相关信息 |
|
Port |
Integer |
否 |
监听端口:取值范围:[1, 65535] |
|
Weight |
Integer |
否 |
权重:取值范围:[1, 100],默认为10 |
|
DisplayName |
String |
是 |
伸缩配置显示名称: 请填写中文, 英文字母, 数字, @ 和 _, -, 最长 64 个字符 |
|
ImageId |
String |
是 |
镜像:是创建云主机的模板,通过ListImages接口可以获取,具体可参考ListImages接口 |
|
SecurityGroupId |
String |
否 |
安全组:securityGroup的信息可以通过调用ListSecurityGroups接口获取, |
|
InstanceType |
String |
是 |
云主机规格:云主机的产品名称为Instance,以产品名称作为入参调用ListProductSeries接口可以获取产品系列, |
|
ChargeType |
ChargeType |
否 |
付费类型:按小时计费(Hour),按量计费(Usage),按量预付费(PreUsage),包月计费(Monthly),免费(Free),包年计费( |
|
DiskType |
String |
否 |
磁盘类型:不同的云主机系列对应不同的磁盘系列,以云主机系列为入参调用ListEbsProductSeries获取该云主机系列对应的磁盘系列, |
|
DiskSizes |
Integer[] |
否 |
磁盘大小,磁盘大小的范围为[20,5000] 入参格式:请输入以逗号为分隔的Integer类型 |
|
Description |
String |
否 |
备注 请填写中文, 英文字母, 数字, 空格,@ 和 _, -, 最长128个字符 |
|
ASGroupId |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
FunctionNames |
String |
否 |
方法名 |
|
PodSelectStrategy |
PodSelectStrategy |
否 |
高可用域选择策略:伸缩组进行伸缩活动创建云主机的时候选择在高可用域的方式,分为轮训(polling)的方式和指定高可用域(specify) |
|
Disks |
String |
是 |
json |
|
SubnetId |
String |
是 |
子网Id |
|
GeneratePasswordType |
GeneratePasswordType |
否 |
云主机生成密码方式,默认为随机生成 |
|
KeyId |
String |
否 |
密钥对id,若密码生成方式为Key(密钥对),则keyId为必传参数 |
|
EncodedByBase64 |
boolean |
否 |
是否进行Base64编码,true:进行编码;false:不进行编码。 |
|
CustomizedData |
String |
否 |
自定义数据 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
DeleteAutoScalingGroup
接口描述
删除伸缩组 DeleteAutoScalingGroupAction
删除伸缩组条件:stopped状态的伸缩组才可以进行删除操作,且无告警任务和定时任务,否则会报有资源依赖 删除伸缩组程: (1)从elb资源池移除云主机
(2) 将ASGroupInstance这张表中对应的云主机enableFlag设置为0 (3)将伸缩组配置配置状态设置为InActive (4)
删除该伸缩组上的监控
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
DeleteAutoScalingGroupConfig
接口描述
删除伸缩组配置
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩组配置唯一标识:伸缩组配置Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
GetAutoScalingGroup
接口描述
获取伸缩组详情
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
ASGroupDetail |
AutoScalingGroupBean |
获取伸缩组详情 |
|
GetAutoScalingGroupConfig
接口描述
获取伸缩组配置详情
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩组配置唯一标识:伸缩组配置Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
ASGroupConfigDetail |
AutoScalingGroupConfigBean |
获取伸缩组配置详情 |
|
GetAutoScalingGroupInstanceNumber
接口描述
获取伸缩组最大最小实例数限制
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
MaxNumber |
Long |
最大的实例数限制 |
|
MixNumber |
Long |
最小的实例数限制 |
|
ListASGroupInstances
接口描述
获取伸缩组中云主机实例列表
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
ScaleType |
String |
否 |
伸缩方式:自动伸缩(Auto),手工伸缩(Manual) |
|
Status |
InstanceScalingStatus[] |
否 |
云主机在伸缩组的状态,枚举类型;取值:正在加入(Adding),加入失败(AddFailed),正在服务中(Serving),正在移出中(Removing),移出失败(RemoveFailed),移出成功(Removed); |
|
PageNumber |
Integer |
否 |
分页页码,默认为1 |
|
PageSize |
Integer |
否 |
分页大小,默认为10 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
Instances |
List<ASGroupInstanceBean> |
伸缩组中云主机实例列表 |
|
Total |
Long |
列表大小 |
|
ListAutoScalingGroupConfig
接口描述
查询伸缩组配置
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
PageNumber |
Integer |
否 |
分页页码,默认为1 |
|
PageSize |
Integer |
否 |
分页大小,默认为10 |
|
GroupId |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
AutoScalingConfigs |
List<AutoScalingGroupConfigBean> |
伸缩组配置列表 |
|
TotalCount |
Long |
列表大小 |
|
ListAutoScalingGroups
接口描述
获取伸缩组列表
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Name |
String |
否 |
名称 |
|
ZoneName |
String |
否 |
可用区名称 |
|
Status |
AutoScalingStatus[] |
否 |
弹性伸缩组状态,枚举类型;取值如:运行中(Running),启动中(Starting)等 |
|
PageNumber |
Integer |
否 |
分页页码,默认为1 |
|
PageSize |
Integer |
否 |
分页大小,默认为10 |
|
OrderBy |
String |
否 |
排序关键字:根据接口入参,如该接口可以按照名称、可用区名称和伸缩组状态进行排序,默认按照id进行排序 |
|
OrderType |
String |
否 |
排序方式: 分为 ASC(升序)和DESC(降序) |
|
RegionId |
String |
否 |
地域Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
AutoScalingGroups |
List<AutoScalingGroupBean> |
伸缩组列表 |
|
TotalCount |
Long |
列表大小 |
|
ListAvailableInstances
接口描述
查询伸缩组中活动的云主机列表
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
PageNumber |
Integer |
否 |
分页页码,默认为1 |
|
PageSize |
Integer |
否 |
分页大小,默认为10 |
|
RegionId |
String |
是 |
地域Id |
|
Id |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
OrderBy |
String |
否 |
排序关键字:根据接口入参,如该接口可以按照地域和伸缩组Id进行排序,默认按照id进行排序 |
|
OrderType |
String |
否 |
排序方式:分为 ASC(升序)和DESC(降序) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
TotalCount |
Long |
列表大小 |
|
Instances |
List<InstanceBean> |
伸缩组中活动的云主机列表 |
|
ListLoadbalancesByVpcId
接口描述
根据vpcId查询elb列表
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
VpcId |
String |
是 |
vpcId |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
Loadbalances |
List<LoadbalanceBean> |
elb列表 |
|
RemoveInstanceFromASGroup
接口描述
手动将云主机移出伸缩组
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
AsGroupId |
String |
是 |
伸缩组id |
|
InstanceId |
String |
是 |
云主机id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
SeparateInstanceFromASGroup
接口描述
将自动云主机分离出伸缩组
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
AsGroupId |
String |
是 |
伸缩组id |
|
InstanceId |
String |
是 |
云主机id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
SetInstanceProtected
接口描述
云主机设置保护状态
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
GroupId |
String |
否 |
伸缩组Id |
|
InstanceId |
String |
否 |
云主机Id |
|
IsProtected |
Boolean |
否 |
是否保护 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
StartAutoScalingGroup
接口描述
启动伸缩组 补充注释: 1.校验:asGroup状态非stopped, 2.asGropConfig不为空, 3.balance校验 2.启动时
2.1:若groupId对应的主机数量(通过serving,removeFailed过滤)小于min值,则做弹性"增",
做startAsGroup工作流数据准备,
比最小值多出来的主机做pod分配,pod分配一个是固定pod,另一个是高可用pod,高可用pod是将主机均匀分散到各个pod serving:
addInstanceToPool removeFaild 做云主机的释放或移除失败时 启动startAsGroup的工作流
问题1:如果instance已经分配了pod,再次分配的pod不一致会不会存在问题?
2.2:大于min值,asGroup状态直接改成running,asGroup下的告警任务重新注册,发送通知用户mq,通过资源发布上报event,异步监听
,发送mq 问题2: 绑定的主机数大于max值没有处理 定时任务不需要重新注册了吗?定时任务和告警任务的区别 告警:资源使用率
定时任务:定时执行伸缩规则,做资源的定时增减 问题4: 资源上报后,接下来会有哪些操作
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
CheckIpEnough |
Boolean |
否 |
|
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
StopAutoScalingGroup
接口描述
关闭伸缩组,是关闭伸缩组活动,不对云主机做任何操作
(1)只有在伸缩组状态是running状态的时候,才可以进行关闭操作
(2) 在关闭伸缩活动的时候需要判断其中是否有正在加入和正在移除的云主机,如果有,不可以进行关闭伸缩组的操作
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
UpdateAutoScalingGroup
接口描述
修改伸缩组配置: 1、判断当前伸缩组vm数量 是否大于 修改后的最大值,则需要干掉多余的,默认按vm加入先后顺序; 2、判断当前伸缩组mv数量 是否小于
修改后的最小值,则需要增加不足的vm
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
MaxNum |
Integer |
是 |
最大实例数:伸缩组中可以运行的最大云主机数据,取值范围:[0,1000] |
|
MinNum |
Integer |
是 |
最小实例数:伸缩组中最少处于运行状态的云主机数目,取值范围:[0,1000] |
|
QuitPolicy |
QuitPolicyType |
否 |
退出策略:枚举类型;云主机退出伸缩组的退出策略,分为最新退出策略(LatestExit)和最早退出策略(FirstExit)两种. |
|
CoolingTime |
Integer |
否 |
冷却时间:伸缩组进行两次伸缩活动的时间间隔,在冷却时间内伸缩组不会触发伸缩活动,取值范围:[300,9999] |
|
LoadbalanceId |
String |
否 |
负载均衡:Loadbalance的信息可以通过调用ListLoadbalances接口获取,具体可参考ListLoadbalances接口 |
|
ListenerId |
String |
否 |
监听器:根据负载均衡获取其对应的监听器,具体可参考ListListeners接口 |
|
IsRelResources |
Boolean |
否 |
是否释放资源:当云主机退出伸缩组的时候,是否对云主机进行释放操作(现在是关机操作),默然为不释放 |
|
Description |
String |
否 |
描述:符合正则表达式"^[一-龥a-zA-Z][一-龥a-zA-Z0-9-_@]{0,19}$" |
|
RecycleInstanceType |
RecycleInstanceType |
否 |
实例回收模式 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
UpdateAutoScalingGroupConfig
接口描述
修改伸缩组配置
(1)不允许修改后端端口,网络
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩组配置Id |
|
PodId |
String |
否 |
高可用域:Pod的信息可以通过调用ListPods接口获取,具体可参考ListPods接口 |
|
Port |
Integer |
否 |
监听端口:取值范围:[1, 65535] |
|
Weight |
Integer |
否 |
权重:取值范围:[1, 100],默认为10 |
|
ImageId |
String |
否 |
镜像:是创建云主机的模板,通过ListImages接口可以获取,具体可参考ListImages接口 |
|
SecurityGroupId |
String |
否 |
安全组:securityGroup的信息可以通过调用ListSecurityGroups接口获取, |
|
InstanceType |
String |
否 |
云主机规格:云主机的产品名称为Instance,以产品名称作为入参调用ListProductSeries接口可以获取产品系列, |
|
DiskType |
String |
否 |
磁盘类型:枚举类型;不同的云主机系列对应不同的磁盘系列, |
|
DiskSizes |
Integer[] |
否 |
磁盘大小,磁盘大小的范围为[20,5000] 入参格式:请输入以逗号为分隔的Integer类型 |
|
DisplayName |
String |
是 |
伸缩配置显示名称: 请填写中文, 英文字母, 数字, @ 和 _, -, 最长 64 个字符 |
|
Description |
String |
否 |
备注 |
|
FunctionNames |
String |
否 |
方法名 |
|
PodSelectStrategy |
PodSelectStrategy |
否 |
高可用域选择策略:伸缩组进行伸缩活动创建云主机的时候选择在高可用域的方式,分为轮训(polling)的方式和指定高可用域(specify) |
|
Disks |
String |
否 |
磁盘信息 |
|
SubnetId |
String |
否 |
子网Id |
|
GeneratePasswordType |
GeneratePasswordType |
否 |
云主机生成密码方式,默认为随机生成 |
|
KeyId |
String |
否 |
密钥对id,若密码生成方式为Key(密钥对),则keyId为必传参数 |
|
EncodedByBase64 |
boolean |
否 |
是否进行Base64编码,true:进行编码;false:不进行编码。 |
|
CustomizedData |
String |
否 |
自定义数据 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
AddRulesToASGroup
接口描述
关联伸缩规则到伸缩组
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
RuleIds |
String[] |
是 |
伸缩规则uuid数组列表 |
|
Id |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
CancelAssociateRule
接口描述
取消伸缩组关联规则
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
RuleId |
String |
是 |
伸缩规则唯一标识:伸缩规则Id |
|
GroupId |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
CheckExecuteRuleToASGroup
接口描述
手动执行规则前进行检查
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
RuleId |
String |
是 |
伸缩规则唯一标识:伸缩规则Id |
|
GroupId |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
CreateAutoScalingRule
接口描述
创建伸缩规则 在创建告警任务和定时任务的时候需要配置伸缩规则,当任务执行伸缩组以该伸缩规则进行伸缩活动
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
DisplayName |
String |
否 |
伸缩规则显示名称: |
|
ChangeNum |
Integer |
是 |
每次伸缩活动,加入或者移除伸缩组的云主机数目 |
|
GroupId |
String |
否 |
伸缩组唯一标识:伸缩组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
DeleteAutoScalingRule
接口描述
删除伸缩规则
删除伸缩规则的条件:伸缩规则没有被定时任务或者告警任务引用
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩规则唯一标识:伸缩规则Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
ExecuteRuleByManualToASGroup
接口描述
手动执行伸缩规则进行伸缩活动
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
RuleId |
String |
是 |
伸缩规则唯一标识:伸缩规则Id |
|
GroupId |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
JobId |
String |
任务 Id |
|
GetAutoScalingRule
接口描述
获取伸缩规则详情
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩规则唯一标识:伸缩规则Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
AutoScalingRule |
AutoScalingRuleBean |
获取伸缩规则详情 |
|
ListASGroupAssociateRules
接口描述
获取伸缩组关联的伸缩规则列表
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
PageNumber |
Integer |
否 |
分页页码,默认为1 |
|
PageSize |
Integer |
否 |
分页大小,默认为10 |
|
Id |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
AutoScalingRules |
List<AutoScalingRuleBean> |
伸缩规则列表 |
|
TotalCount |
Long |
列表大小 |
|
ListAutoScalingRules
接口描述
获取伸缩规则列表
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
PageNumber |
Integer |
否 |
分页页码,默认为1 |
|
PageSize |
Integer |
否 |
分页大小,默认为10 |
|
Name |
String |
否 |
名称 |
|
DisplayName |
String |
否 |
显示名称 |
|
ChangeNum |
Integer |
否 |
每次伸缩活动,加入或者移除伸缩组的云主机数目 |
|
OrderBy |
String |
否 |
排序关键字:根据接口入参,如该接口可以按照名称、可用区名称和每次伸缩活动,加入或者移除伸缩组的云主机数目进行排序,默认按照id进行排序 |
|
OrderType |
String |
否 |
排序方式:分为 ASC(升序)和DESC(降序) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
AutoScalingRules |
List<AutoScalingRuleBean> |
伸缩规则列表 |
|
TotalCount |
Long |
列表大小 |
|
ListGroupCanAssociateRules
接口描述
获取伸缩组未关联过的伸缩规则列表
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
PageNumber |
Integer |
否 |
分页页码,默认为1 |
|
PageSize |
Integer |
否 |
分页大小,默认为10 |
|
Id |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
AutoScalingRules |
List<AutoScalingRuleBean> |
伸缩规则列表 |
|
TotalCount |
Long |
列表大小 |
|
ListRulesForNoPage
接口描述
查询租户当前有效的伸缩规则列表不分页
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
PageNumber |
Integer |
否 |
分页页码,默认为1 |
|
PageSize |
Integer |
否 |
分页大小,默认为10 |
|
Name |
String |
否 |
名称 |
|
DisplayName |
String |
否 |
显示名称 |
|
ChangeNum |
Integer |
否 |
每次伸缩活动,加入或者移除伸缩组的云主机数目 |
|
OrderBy |
String |
否 |
排序关键字:根据接口入参,如该接口可以按照名称、可用区名称和每次伸缩活动,加入或者移除伸缩组的云主机数目进行排序,默认按照id进行排序 |
|
OrderType |
String |
否 |
排序方式:分为 ASC(升序)和DESC(降序) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
AutoScalingRules |
List<AutoScalingRuleBean> |
伸缩规则列表 |
|
TotalCount |
Long |
列表大小 |
|
UpdateAutoScalingRule
接口描述
修改伸缩规则: 对于伸缩规则是无状态的,所以用户在任何情况下都可以对伸缩规则进行修改
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩规则Id |
|
ChangeNum |
Integer |
是 |
每次伸缩活动,加入或者移除伸缩组的云主机数目 |
|
DisplayName |
String |
否 |
伸缩规则显示名称 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
CreateAutoScalingAlarmTask
接口描述
创建弹性伸缩组告警任务:弹性伸缩组的告警任务是对其中云主机的性能如cpu.busy进行监控,用户需要设置监控项,监控函数,告警次数,告警阈值,伸缩规则;
当告警任务被触发的时候,伸缩组将根据当前的伸缩规则进行伸缩活动
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
DisplayName |
String |
是 |
伸缩组告警任务显示名称 |
|
GroupId |
String |
是 |
弹性伸缩组唯一标识:伸缩组Id |
|
RuleId |
String |
是 |
伸缩规则唯一标识:伸缩规则Id |
|
MonitorItemType |
MonitorItemType |
是 |
监控项:枚举类型;现阶段支持的监控项:lvxRealServer("lvx.RealServer.Status"),CPU("cpu.busy"), |
|
MonitorFunType |
MonitorFunType |
是 |
监控统计函数:枚举类型;取值:min、max、avg、count、rate count |
|
Times |
Integer |
是 |
连续告警次数 |
|
Operator |
OperatorType |
是 |
判断表达式:枚举类型;如:lt("<"),elt("<="),eq("=="),neq("!="),gt(">"),egt(">="), |
|
RightValue |
Double |
是 |
阈值 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
CreateAutoScalingScheduledTask
接口描述
创建伸缩组定时任务:对伸缩组配置了定时任务,当定时任务执行时伸缩组根据伸缩规则进行伸缩活动
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
DisplayName |
String |
是 |
定时任务显示名 |
|
GroupId |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
RuleId |
String |
是 |
伸缩规则唯一标识:伸缩规则Id |
|
ExecuteTime |
String |
是 |
执行时间,时间格式:Timestamp yyyy-mm-dd hh:mm:ss[.fffffffff] |
|
RepeatType |
RepeatType |
是 |
定时任务重复周期,枚举类型;取值:Once,Daily,Weekly,Monthly |
|
SpecificTime |
String |
否 |
重复类型为周:需要指定周几,传值为MON、FRI等缩写 |
|
BeginTime |
String |
否 |
定时任务开始时间,时间格式:Timestamp yyyy-mm-dd hh:mm:ss[.fffffffff] |
|
EndTime |
String |
否 |
定时任务结束时间,时间格式:Timestamp yyyy-mm-dd hh:mm:ss[.fffffffff] |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
DeleteAutoScalingAlarmTask
接口描述
删除伸缩组告警任务
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
告警任务唯一标识:告警任务Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
DeleteAutoScalingGroupScheduledTask
接口描述
删除伸缩组定时任务
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩组定时任务唯一标识:伸缩组定时任务Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
GetASGroupActivityCause
接口描述
获取伸缩组活动触发条件(健康检查、定时任务、告警、手动执行伸缩规则等)
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
JobId |
String |
是 |
伸缩组活动触发JobId |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
ASGroupActivityCause |
ASGroupActivityCauseBean |
|
|
GetAutoScalingAlarmTask
接口描述
获取弹性伸缩告警任务详情
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
弹性伸缩告警任务唯一标识:告警任务Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
ASAlarmTaskDetail |
AutoScalingAlarmTaskBean |
弹性伸缩告警任务详情 |
|
GetAutoScalingScheduledTask
接口描述
获取伸缩组定时任务详情
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩组定时任务Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
ASScheduledTask |
AutoScalingScheduledTaskBean |
获取伸缩组定时任务详情 |
|
ListAutoScalingAlarmTasks
接口描述
获取伸缩组告警任务列表
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Name |
String |
否 |
名称 |
|
DisplayName |
String |
否 |
显示名称 |
|
PageNumber |
Integer |
否 |
分页页码,默认为1 |
|
PageSize |
Integer |
否 |
分页大小,默认为10 |
|
OrderBy |
String |
否 |
排序关键字:根据接口入参,如该接口可以按照名称和显示名称进行排序,默认按照id进行排序 |
|
OrderType |
String |
否 |
排序方式: 分为 ASC(升序)和DESC(降序) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
TotalCount |
Long |
列表大小 |
|
AsAlarmTasks |
List<AutoScalingAlarmTaskBean> |
伸缩组告警任务列表 |
|
ListAutoScalingGroupActives
接口描述
获取伸缩活动详情列表
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
否 |
伸缩组唯一标识:伸缩组Id |
|
PageNumber |
Integer |
否 |
分页页码,默认为1 |
|
PageSize |
Integer |
否 |
分页大小,默认为10 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
TotalCount |
Long |
列表大小 |
|
Actives |
List<AutoScalingGroupActiveBean> |
伸缩活动详情列表 |
|
ListAutoScalingGroupActivityDetail
接口描述
伸缩活动详情列表展示展示
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
PageNumber |
Integer |
否 |
分页页码,默认为1 |
|
PageSize |
Integer |
否 |
分页大小,默认为10 |
|
JobId |
String |
是 |
Job Id |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
Details |
List<ASGroupActivityDetailBean> |
伸缩活动详情 |
|
Total |
Long |
列表大小 |
|
ListAutoScalingScheduledTasks
接口描述
获取伸缩组定时任务列表
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Name |
String |
否 |
名称 |
|
DisplayName |
String |
否 |
显示名称 |
|
PageNumber |
Integer |
否 |
分页页码,默认为1 |
|
PageSize |
Integer |
否 |
分页大小,默认为10 |
|
OrderBy |
String |
否 |
排序关键字:根据接口入参,如该接口可以按照名称和显示名称进行排序,默认按照id进行排序 |
|
OrderType |
String |
否 |
排序方式:分为 ASC(升序)和DESC(降序) |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
AutoScalingScheduledTasks |
List<AutoScalingScheduledTaskBean> |
伸缩组定时任务列表 |
|
TotalCount |
Long |
列表大小 |
|
UpdateAutoScalingAlarmTask
接口描述
修改伸缩组告警任务
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
伸缩组告警任务Id |
|
DisplayName |
String |
是 |
伸缩组告警任务显示名称 |
|
GroupId |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
RuleId |
String |
是 |
伸缩规则唯一标识:伸缩规则Id |
|
MonitorItemType |
MonitorItemType |
是 |
监控项:枚举类型;现阶段支持的监控项:lvxRealServer("lvx.RealServer.Status"),CPU("cpu.busy"), |
|
MonitorFunType |
MonitorFunType |
是 |
监控统计函数:枚举类型;取值:min、max、avg、count、rate count |
|
Times |
Integer |
是 |
连续告警次数 |
|
Operator |
OperatorType |
是 |
判断表达式如:枚举类型;取值:lt("<"),elt("<="),eq("=="),neq("!="),gt(">"),egt(">="), |
|
RightValue |
Double |
是 |
阈值 |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
UpdateAutoScalingGroupScheduledTask
接口描述
修改弹性伸缩组定时任务
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
Id |
String |
是 |
定时任务Id |
|
DisplayName |
String |
否 |
任务名称 |
|
GroupId |
String |
是 |
伸缩组唯一标识:伸缩组Id |
|
RuleId |
String |
是 |
伸缩规则唯一标识:伸缩规则Id |
|
ExecuteTime |
String |
是 |
执行时间,时间格式:Timestamp yyyy-mm-dd hh:mm:ss[.fffffffff] |
|
RepeatType |
RepeatType |
否 |
定时任务重复周期:枚举类型;取值:Once,Daily,Weekly,Monthly |
|
SpecificTime |
String |
否 |
重复类型为周:需要指定周几,传值为MON、FRI等缩写 |
|
BeginTime |
String |
否 |
定时任务开始时间,时间格式:Timestamp yyyy-mm-dd hh:mm:ss[.fffffffff] |
|
EndTime |
String |
否 |
定时任务结束时间,时间格式:Timestamp yyyy-mm-dd hh:mm:ss[.fffffffff] |
|
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
AutoScaling
接口描述
健康检查回调地址URI
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |
AutoScalingAlarm
接口描述
监控告警回调地址URI
请求参数
参数名称 |
参数类型 |
是否必须 |
参数描述 |
备注 |
响应参数
参数名称 |
参数类型 |
参数描述 |
备注 |