;
/**
* 重试策略,取值包括 IMMEDIATE_RETRY、 INCREMENTAL_INTERVALS、NO_RETRY,默认取值为 IMMEDIATE_RETRY。部分成功的伸缩活动判定为一次失败活动。
IMMEDIATE_RETRY,立即重试,在较短时间内快速重试,连续失败超过一定次数(5次)后不再重试。INCREMENTAL_INTERVALS,间隔递增重试,随着连续失败次数的增加,重试间隔逐渐增大,重试间隔从秒级到1天不等。 NO_RETRY,不进行重试,直到再次收到用户调用或者告警信息后才会重试。
*/
RetryPolicy?: string;
/**
* 可用区校验策略,取值包括 ALL 和 ANY,默认取值为ANY。在伸缩组实际变更资源相关字段时(启动配置、可用区、子网)发挥作用。
ALL,所有可用区(Zone)或子网(SubnetId)都可用则通过校验,否则校验报错。 ANY,存在任何一个可用区(Zone)或子网(SubnetId)可用则通过校验,否则校验报错。可用区或子网不可用的常见原因包括该可用区CVM实例类型售罄、该可用区CBS云盘售罄、该可用区配额不足、该子网IP不足等。
如果 Zones/SubnetIds 中可用区或者子网不存在,则无论 ZonesCheckPolicy 采用何种取值,都会校验报错。
*/
ZonesCheckPolicy?: string;
/**
* 服务设置,包括云监控不健康替换等服务设置。
*/
ServiceSettings?: ServiceSettings;
/**
* 实例具有IPv6地址数量的配置,取值包括0、1。默认值为 0,表示实例不分配 IPv6 地址。需使用支持 IPv6 的私有网络,需在子网中开启 IPv6 CIDR,其他使用限制可参考 IPv6使用限制。
*/
Ipv6AddressCount?: number;
/**
* 多可用区/子网策略,取值包括 PRIORITY 和 EQUALITY,默认为 PRIORITY。
PRIORITY,按照可用区/子网列表的顺序,作为优先级来尝试创建实例,如果优先级最高的可用区/子网可以创建成功,则总在该可用区/子网创建。 EQUALITY:扩容出的实例会打散到多个可用区/子网,保证扩容后的各个可用区/子网实例数相对均衡。 与本策略相关的注意点:
当伸缩组为基础网络时,本策略适用于多可用区;当伸缩组为VPC网络时,本策略适用于多子网,此时不再考虑可用区因素,例如四个子网ABCD,其中ABC处于可用区1,D处于可用区2,此时考虑子网ABCD进行排序,而不考虑可用区1、2。 本策略适用于多可用区/子网,不适用于启动配置的多机型。多机型按照优先级策略进行选择。 按照 PRIORITY 策略创建实例时,先保证多机型的策略,后保证多可用区/子网的策略。例如多机型A、B,多子网1、2、3,会按照A1、A2、A3、B1、B2、B3 进行尝试,如果A1售罄,会尝试A2(而非B1)。
*/
MultiZoneSubnetPolicy?: string;
/**
* 伸缩组实例健康检查类型,取值如下:
CVM:根据实例网络状态判断实例是否处于不健康状态,不健康的网络状态即发生实例 PING 不可达事件,详细判断标准可参考[实例健康检查](https://cloud.tencent.com/document/product/377/8553)CLB:根据 CLB 的健康检查状态判断实例是否处于不健康状态,CLB健康检查原理可参考[健康检查](https://cloud.tencent.com/document/product/214/6097)
*/
HealthCheckType?: string;
/**
* CLB健康检查宽限期,单位为秒。
取值范围:[0, 7200]
默认值:0
*/
LoadBalancerHealthCheckGracePeriod?: number;
/**
* 实例分配策略,取值包括 LAUNCH_CONFIGURATION 和 SPOT_MIXED。
LAUNCH_CONFIGURATION,代表传统的按照启动配置模式。 SPOT_MIXED,代表竞价混合模式。目前仅支持启动配置为按量计费模式时使用混合模式,混合模式下,伸缩组将根据设定扩容按量或竞价机型。使用混合模式时,关联的启动配置的计费类型不可被修改。
*/
InstanceAllocationPolicy?: string;
/**
* 竞价混合模式下,各计费类型实例的分配策略。
仅当 InstanceAllocationPolicy 取 SPOT_MIXED 时可用。
*/
SpotMixedAllocationPolicy?: SpotMixedAllocationPolicy;
/**
* 容量重平衡功能,仅对伸缩组内的竞价实例有效。取值范围:
TRUE,开启该功能,当伸缩组内的竞价实例即将被竞价实例服务自动回收前,AS 主动发起竞价实例销毁流程,如果有配置过缩容 hook,则销毁前 hook 会生效。销毁流程启动后,AS 会异步开启一个扩容活动,用于补齐期望实例数。 FALSE,不开启该功能,则 AS 等待竞价实例被销毁后才会去扩容补齐伸缩组期望实例数。
*/
CapacityRebalance?: boolean;
/**
* 实例名称序号相关设置。开启后为伸缩组内自动创建的实例名称添加递增的数字序号。
*/
InstanceNameIndexSettings?: InstanceNameIndexSettings;
/**
* 实例主机名序号相关设置。开启后为伸缩组内自动创建的实例主机名添加递增的数字序号。
*/
HostNameIndexSettings?: HostNameIndexSettings;
/**
* 匹配期望数并发扩容功能,不能在InstanceAllocationPolicy为竞价混合模式时设置,也不能在ScalingMode为扩容优先开机模式时设置。目前仅支持两个匹配期望数扩容活动并发进行,不支持指定数量扩容、缩容等其他类型活动并发。设置为FALSE表示不开启。
*/
ConcurrentScaleOutForDesiredCapacity?: boolean;
}
/**
* ScaleOutInstances请求参数结构体
*/
export interface ScaleOutInstancesRequest {
/**
* 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。
通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 希望扩容的实例数量。该参数的静态取值范围是 [1,2000],同时该参数不得大于期望数与最大值的差值。例如伸缩组期望数为 20,最大值为 100,此时可取值范围为 [1,80]。
*/
ScaleOutNumber: number;
}
/**
* 弹性伸缩事件通知
*/
export interface AutoScalingNotification {
/**
* 伸缩组ID。
*/
AutoScalingGroupId?: string;
/**
* 用户组ID列表。
*/
NotificationUserGroupIds?: Array;
/**
* 通知事件列表。取值范围如下:
SCALE_OUT_SUCCESSFUL:扩容成功
SCALE_OUT_FAILED:扩容失败
SCALE_IN_SUCCESSFUL:缩容成功
SCALE_IN_FAILED:缩容失败
REPLACE_UNHEALTHY_INSTANCE_SUCCESSFUL:替换不健康子机成功
REPLACE_UNHEALTHY_INSTANCE_FAILED:替换不健康子机失败
*/
NotificationTypes?: Array;
/**
* 事件通知ID。
*/
AutoScalingNotificationId?: string;
/**
* 通知接收端类型。取值范围如下:
USER_GROUP:用户组
TDMQ_CMQ_TOPIC:TDMQ CMQ 主题
TDMQ_CMQ_QUEUE:TDMQ CMQ 队列
CMQ_QUEUE:CMQ 队列,[CMQ 接口已下线](https://cloud.tencent.com/document/product/1496/83970),已无法选用
CMQ_TOPIC:CMQ 主题,[CMQ 接口已下线](https://cloud.tencent.com/document/product/1496/83970),已无法选用
*/
TargetType?: string;
/**
* TDMQ CMQ 队列名。
*/
QueueName?: string;
/**
* TDMQ CMQ 主题名。
*/
TopicName?: string;
}
/**
* ModifyScheduledAction请求参数结构体
*/
export interface ModifyScheduledActionRequest {
/**
* 待修改的定时任务ID。可以通过调用接口 [DescribeScheduledActions](https://cloud.tencent.com/document/api/377/20450) ,取返回信息中的 ScheduledActionId 获取定时任务ID。
*/
ScheduledActionId: string;
/**
* 定时任务名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。同一伸缩组下必须唯一。
*/
ScheduledActionName?: string;
/**
* 当定时任务触发时,设置的伸缩组最大实例数。
*/
MaxSize?: number;
/**
* 当定时任务触发时,设置的伸缩组最小实例数。
*/
MinSize?: number;
/**
* 当定时任务触发时,设置的伸缩组期望实例数。
*/
DesiredCapacity?: number;
/**
* 定时任务的首次触发时间,取值为`北京时间`(UTC+8),按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ss+08:00`。
*/
StartTime?: string;
/**
* 定时任务的结束时间,取值为`北京时间`(UTC+8),按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ss+08:00`。
此参数与`Recurrence`需要同时指定,到达结束时间之后,定时任务将不再生效。
*/
EndTime?: string;
/**
* 定时任务的重复方式。为标准 Cron 格式,[Recurrence参数限制](https://cloud.tencent.com/document/product/377/88119)为5个字段,由空格分开,结构为:分,小时,日期,月份,星期。此参数与`EndTime`需要同时指定。
*/
Recurrence?: string;
/**
* 停用期望数更新。默认值为 False,表示定时任务触发时期望实例数正常更新。
该值为 True 时,定时任务触发时不会主动修改期望实例数,但可能会因最大最小值机制修改期望实例数。
以下案例的前提都是停用期望数更新为 True:
- 定时任务触发时,原期望数为 5,定时任务将最小值改为 10,最大值改为 20,期望数改为 15,由于停用期望数更新,15不生效,但原期望数 5 小于最小值 10,最终新期望数为 10。
- 定时任务触发时,原期望数为 25,定时任务将最小值改为 10,最大值改为 20,期望数改为 15,由于停用期望数更新,15不生效,但原期望数 25 大于最大值 20,最终新期望数为 20。
- 定时任务触发时,原期望数为 13,定时任务将最小值改为 10,最大值改为 20,期望数改为 15,由于停用期望数更新,15不生效,期望数保持为 13 。
*/
DisableUpdateDesiredCapacity?: boolean;
}
/**
* DescribeAutoScalingGroups请求参数结构体
*/
export interface DescribeAutoScalingGroupsRequest {
/**
* 按照一个或者多个伸缩组ID查询。伸缩组ID形如:`asg-nkdwoui0`。每次请求的上限为100。参数不支持同时指定`AutoScalingGroupIds`和`Filters`。
*/
AutoScalingGroupIds?: Array;
/**
* 过滤条件。
auto-scaling-group-id - String - 是否必填:否 -(过滤条件)按照伸缩组ID过滤。
可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
auto-scaling-group-name - String - 是否必填:否 -(过滤条件)按照伸缩组名称过滤。
vague-auto-scaling-group-name - String - 是否必填:否 -(过滤条件)按照伸缩组名称模糊搜索。
launch-configuration-id - String - 是否必填:否 -(过滤条件)按照启动配置ID过滤。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/config) 或调用接口 [DescribeLaunchConfigurations](https://cloud.tencent.com/document/api/377/20445) ,取返回信息中的 LaunchConfigurationId 获取启动配置ID。
tag-key - String - 是否必填:否 -(过滤条件)按照标签键进行过滤。可通过调用接口 [GetTags](https://cloud.tencent.com/document/product/651/72275) ,取返回信息中的 TagKey 获取标签键。
tag-value - String - 是否必填:否 -(过滤条件)按照标签值进行过滤。可通过调用接口 [GetTags](https://cloud.tencent.com/document/product/651/72275) ,取返回信息中的 TagValue 获取标签值。
tag:tag-key - String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换,请参考示例2。可通过调用接口 [GetTags](https://cloud.tencent.com/document/product/651/72275) ,取返回信息中的 TagKey 获取标签键。
每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。参数不支持同时指定`AutoScalingGroupIds`和`Filters`。
*/
Filters?: Array;
/**
* 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Limit?: number;
/**
* 偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Offset?: number;
}
/**
* 符合条件的启动配置信息的集合。
*/
export interface LaunchConfiguration {
/**
* 实例所属项目ID。
*/
ProjectId?: number;
/**
* 启动配置ID。
*/
LaunchConfigurationId?: string;
/**
* 启动配置名称。
*/
LaunchConfigurationName?: string;
/**
* 实例机型。
*/
InstanceType?: string;
/**
* 实例系统盘配置信息。
*/
SystemDisk?: SystemDisk;
/**
* 实例数据盘配置信息。
*/
DataDisks?: Array;
/**
* 实例登录设置。
*/
LoginSettings?: LimitedLoginSettings;
/**
* 公网带宽相关信息设置。
*/
InternetAccessible?: InternetAccessible;
/**
* 实例所属安全组。
*/
SecurityGroupIds?: Array;
/**
* 启动配置关联的伸缩组。
*/
AutoScalingGroupAbstractSet?: Array;
/**
* 自定义数据。
注意:此字段可能返回 null,表示取不到有效值。
*/
UserData?: string;
/**
* 启动配置创建时间,为标准`UTC`时间。
*/
CreatedTime?: string;
/**
* 实例的增强服务启用情况与其设置。
*/
EnhancedService?: EnhancedService;
/**
* 镜像ID。
*/
ImageId?: string;
/**
* 启动配置当前状态。取值范围:NORMAL:正常IMAGE_ABNORMAL:启动配置镜像异常CBS_SNAP_ABNORMAL:启动配置数据盘快照异常SECURITY_GROUP_ABNORMAL:启动配置安全组异常
*/
LaunchConfigurationStatus?: string;
/**
* 实例计费类型,取值范围如下:
POSTPAID_BY_HOUR:按小时后付费
SPOTPAID:竞价付费
PREPAID:预付费,即包年包月
CDCPAID:专用集群付费
*/
InstanceChargeType?: string;
/**
* 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceMarketOptions?: InstanceMarketOptionsRequest;
/**
* 实例机型列表。
*/
InstanceTypes?: Array;
/**
* 实例标签列表。扩容出来的实例会自动带上标签,最多支持10个标签。
*/
InstanceTags?: Array;
/**
* 标签列表,该参数内的标签仅用于绑定启动配置,不会传递给基于该启动配置扩容的 CVM 实例。
*/
Tags?: Array;
/**
* 版本号。
*/
VersionNumber?: number;
/**
* 更新时间,为标准`UTC`时间。
*/
UpdatedTime?: string;
/**
* CAM角色名称。可通过[DescribeRoleList](https://cloud.tencent.com/document/product/598/36223)接口返回值中的roleName获取。
*/
CamRoleName?: string;
/**
* 上次操作时,InstanceTypesCheckPolicy 取值。
*/
LastOperationInstanceTypesCheckPolicy?: string;
/**
* 云服务器主机名(HostName)的相关设置。
*/
HostNameSettings?: HostNameSettings;
/**
* 云服务器实例名(InstanceName)的相关设置。
*/
InstanceNameSettings?: InstanceNameSettings;
/**
* 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
*/
InstanceChargePrepaid?: InstanceChargePrepaid;
/**
* 云盘类型选择策略。取值范围:ORIGINAL:使用设置的云盘类型AUTOMATIC:自动选择当前可用区下可用的云盘类型
*/
DiskTypePolicy?: string;
/**
* 高性能计算集群ID。
注意:此字段默认为空。
*/
HpcClusterId?: string;
/**
* IPv6公网带宽相关信息设置。
*/
IPv6InternetAccessible?: IPv6InternetAccessible;
/**
* 置放群组id,仅支持指定一个。
*/
DisasterRecoverGroupIds?: Array;
/**
* 镜像族名称。
*/
ImageFamily?: string;
/**
* 本地专用集群 ID。
*/
DedicatedClusterId?: string;
}
/**
* 自定义 Metadata
*/
export interface Metadata {
/**
* 自定义 Metadata 键值对列表
*/
Items?: Array;
}
/**
* DescribeAccountLimits返回参数结构体
*/
export interface DescribeAccountLimitsResponse {
/**
* 用户账户被允许创建的启动配置最大数量
*/
MaxNumberOfLaunchConfigurations: number;
/**
* 用户账户启动配置的当前数量
*/
NumberOfLaunchConfigurations: number;
/**
* 用户账户被允许创建的伸缩组最大数量
*/
MaxNumberOfAutoScalingGroups: number;
/**
* 用户账户伸缩组的当前数量
*/
NumberOfAutoScalingGroups: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateLaunchConfiguration返回参数结构体
*/
export interface CreateLaunchConfigurationResponse {
/**
* 当通过本接口来创建启动配置时会返回该参数,表示启动配置ID。
*/
LaunchConfigurationId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 与本次伸缩活动相关的实例信息。
*/
export interface RelatedInstance {
/**
* 实例ID。
*/
InstanceId?: string;
/**
* 实例在伸缩活动中的状态。取值如下:
INIT:初始化中
RUNNING:实例操作中
SUCCESSFUL:活动成功
FAILED:活动失败
*/
InstanceStatus?: string;
}
/**
* 伸缩配置建议。
*/
export interface Advice {
/**
* 问题描述。
*/
Problem?: string;
/**
* 问题详情。
*/
Detail?: string;
/**
* 建议解决方案。
*/
Solution?: string;
/**
* 伸缩建议警告级别。取值范围:
WARNING:警告级别
CRITICAL:严重级别
*/
Level?: string;
}
/**
* EnterStandby请求参数结构体
*/
export interface EnterStandbyRequest {
/**
* 伸缩组 ID。可以通过如下方式获取可用的伸缩组ID:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。
通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 运行中状态实例列表,不支持传入非运行中状态实例。可以通过以下方式获取可用的实例ID:
通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。
通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。
*/
InstanceIds: Array;
}
/**
* CreateLifecycleHook返回参数结构体
*/
export interface CreateLifecycleHookResponse {
/**
* 生命周期挂钩ID
*/
LifecycleHookId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ClearLaunchConfigurationAttributes返回参数结构体
*/
export interface ClearLaunchConfigurationAttributesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAutoScalingGroups返回参数结构体
*/
export interface DescribeAutoScalingGroupsResponse {
/**
* 伸缩组详细信息列表。
*/
AutoScalingGroupSet?: Array;
/**
* 符合条件的伸缩组数量。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateScheduledAction请求参数结构体
*/
export interface CreateScheduledActionRequest {
/**
* 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。
通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 定时任务名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。同一伸缩组下必须唯一。
*/
ScheduledActionName: string;
/**
* 当定时任务触发时,设置的伸缩组最小实例数。
*/
MinSize: number;
/**
* 定时任务的首次触发时间,取值为`北京时间`(UTC+8),按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ss+08:00`。
*/
StartTime: string;
/**
* 当定时任务触发时,设置的伸缩组期望实例数。
*/
DesiredCapacity: number;
/**
* 当定时任务触发时,设置的伸缩组最大实例数。
*/
MaxSize: number;
/**
* 定时任务的结束时间,取值为`北京时间`(UTC+8),按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ss+08:00`。
此参数与`Recurrence`需要同时指定,到达结束时间之后,定时任务将不再生效。
*/
EndTime?: string;
/**
* 定时任务的重复方式。为标准 Cron 格式。定时任务中的 [Recurrence参数限制](https://cloud.tencent.com/document/product/377/88119) 为5个字段,由空格分开,结构为:分,小时,日期,月份,星期。此参数与`EndTime`需要同时指定。
*/
Recurrence?: string;
/**
* 停用期望数更新。默认值为 False,表示定时任务触发时期望实例数正常更新。
该值为 True 时,定时任务触发时不会主动修改期望实例数,但可能会因最大最小值机制修改期望实例数。
以下案例的前提都是停用期望数更新为 True:
- 定时任务触发时,原期望数为 5,定时任务将最小值改为 10,最大值改为 20,期望数改为 15,由于停用期望数更新,15不生效,但原期望数 5 小于最小值 10,最终新期望数为 10。
- 定时任务触发时,原期望数为 25,定时任务将最小值改为 10,最大值改为 20,期望数改为 15,由于停用期望数更新,15不生效,但原期望数 25 大于最大值 20,最终新期望数为 20。
- 定时任务触发时,原期望数为 13,定时任务将最小值改为 10,最大值改为 20,期望数改为 15,由于停用期望数更新,15不生效,期望数保持为 13 。
*/
DisableUpdateDesiredCapacity?: boolean;
}
/**
* ExitStandby请求参数结构体
*/
export interface ExitStandbyRequest {
/**
* 伸缩组 ID。可以通过如下方式获取可用的伸缩组ID:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。
通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 备用中状态 CVM 实例列表。可以通过以下方式获取可用的实例ID:
通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。
通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。
*/
InstanceIds: Array;
}
/**
* 启动配置的系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
*/
export interface SystemDisk {
/**
* 系统盘类型。系统盘类型限制详见[云硬盘类型](https://cloud.tencent.com/document/product/362/2353)。取值范围
LOCAL_BASIC:本地硬盘
LOCAL_SSD:本地SSD硬盘
CLOUD_BASIC:普通云硬盘
CLOUD_PREMIUM:高性能云硬盘
CLOUD_SSD:SSD云硬盘
CLOUD_BSSD:通用型SSD云硬盘
CLOUD_HSSD:增强型SSD云硬盘
CLOUD_TSSD:极速型SSD云硬盘
默认取值:CLOUD_PREMIUM。
*/
DiskType?: string;
/**
* 系统盘大小,单位:GB。默认值为 50
*/
DiskSize?: number;
}
/**
* 竞价相关选项
*/
export interface SpotMarketOptions {
/**
* 竞价出价,例如“1.05”
*/
MaxPrice: string;
/**
* 竞价请求类型,当前仅支持类型:one-time,默认值为one-time
*/
SpotInstanceType?: string;
}
/**
* StopAutoScalingInstances返回参数结构体
*/
export interface StopAutoScalingInstancesResponse {
/**
* 伸缩活动ID
*/
ActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeScalingPolicies请求参数结构体
*/
export interface DescribeScalingPoliciesRequest {
/**
* 按照一个或者多个告警策略ID查询。告警策略ID形如:asp-i9vkg894。每次请求的实例的上限为100。参数不支持同时指定`AutoScalingPolicyIds`和`Filters`。
*/
AutoScalingPolicyIds?: Array;
/**
* 过滤条件。
auto-scaling-policy-id - String - 是否必填:否 -(过滤条件)按照告警策略ID过滤。
auto-scaling-group-id - String - 是否必填:否 -(过滤条件)按照伸缩组ID过滤。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
scaling-policy-name - String - 是否必填:否 -(过滤条件)按照告警策略名称过滤。
scaling-policy-type - String - 是否必填:否 -(过滤条件)按照告警策略类型过滤,取值范围为SIMPLE,TARGET_TRACKING。两者分别表示简单策略和目标追踪策略。
每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。参数不支持同时指定`AutoScalingPolicyIds`和`Filters`。
*/
Filters?: Array;
/**
* 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Limit?: number;
/**
* 偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Offset?: number;
}
/**
* 云服务器实例名称(InstanceName)的相关设置
*/
export interface InstanceNameSettings {
/**
* 云服务器的实例名。字符长度为[2, 108]。
*/
InstanceName: string;
/**
* 云服务器实例名的风格,取值范围包括 ORIGINAL 和 UNIQUE,默认为 ORIGINAL。
ORIGINAL,AS 直接将入参中所填的 InstanceName 传递给 CVM,CVM 可能会对 InstanceName 追加序列号,伸缩组中实例的 InstanceName 会出现冲突的情况。
UNIQUE,入参所填的 InstanceName 相当于实例名前缀,AS 和 CVM 会对其进行拓展,伸缩组中实例的 InstanceName 可以保证唯一。
*/
InstanceNameStyle?: string;
/**
* 云服务器实例名后缀。字符长度为[1,105],且与 InstanceName 的长度和不能超过107。
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceNameSuffix?: string;
/**
* 云服务器的实例名分隔符。默认的分隔符是点号(.),可选短横线(-)或空字符串。
分隔符用于拼接实例名,递增序号,后缀。假设实例名为 testGpu4090 ,递增序号为 0007,后缀为 server:
- 分隔符为英文点号(.),最终拼接为 testGpu4090.007.server
- 分隔符为短横线(-),最终拼接为 testGpu4090-007-server
- 分隔符为空字符串,最终拼接为 testGpu4090007server
*/
InstanceNameDelimiter?: string;
}
/**
* 伸缩活动状态详细描述。
*/
export interface DetailedStatusMessage {
/**
* 错误类型。
*/
Code?: string;
/**
* 可用区信息。
*/
Zone?: string;
/**
* 实例ID。
*/
InstanceId?: string;
/**
* 实例计费类型。
*/
InstanceChargeType?: string;
/**
* 子网ID。
*/
SubnetId?: string;
/**
* 错误描述。
*/
Message?: string;
/**
* 实例类型。
*/
InstanceType?: string;
}
/**
* ModifyScheduledAction返回参数结构体
*/
export interface ModifyScheduledActionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AttachLoadBalancers返回参数结构体
*/
export interface AttachLoadBalancersResponse {
/**
* 伸缩活动ID
*/
ActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ExecuteScalingPolicy返回参数结构体
*/
export interface ExecuteScalingPolicyResponse {
/**
* 伸缩活动ID
*/
ActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 应用型负载均衡器标识信息
*/
export interface ForwardLoadBalancerIdentification {
/**
* 负载均衡器ID
*/
LoadBalancerId: string;
/**
* 应用型负载均衡监听器 ID
*/
ListenerId: string;
/**
* 转发规则ID,注意:针对七层监听器此参数必填
*/
LocationId?: string;
/**
* 监听器或转发路径需解绑的端口号列表。
取值范围:[1, 65535]
不传递该参数时,默认解绑指定监听器或转发路径关联的所有端口。
*/
PortList?: Array;
}
/**
* SetInstancesProtection返回参数结构体
*/
export interface SetInstancesProtectionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* StartAutoScalingInstances返回参数结构体
*/
export interface StartAutoScalingInstancesResponse {
/**
* 伸缩活动ID
*/
ActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CompleteLifecycleAction请求参数结构体
*/
export interface CompleteLifecycleActionRequest {
/**
* 生命周期挂钩ID。可以通过调用接口 [DescribeLifecycleHooks](https://cloud.tencent.com/document/api/377/34452) ,取返回信息中的 LifecycleHookId 获取生命周期挂钩ID。
*/
LifecycleHookId: string;
/**
* 生命周期动作的结果,取值范围如下:
CONTINUE: 默认值,表示继续执行扩缩容活动
ABANDON: 针对扩容挂钩,挂钩超时或 LifecycleCommand 执行失败的 CVM 实例会直接释放或移出;而针对缩容挂钩,会继续执行缩容活动。
*/
LifecycleActionResult: string;
/**
* 实例ID,`InstanceId` 和 `LifecycleActionToken` 参数必须填写其中一个。可通过登录 [控制台](https://console.cloud.tencent.com/cvm/index) 或调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。
*/
InstanceId?: string;
/**
* 生命周期动作令牌,`InstanceId` 和 `LifecycleActionToken` 必须填充其中一个。
该参数获取方式如下:配置 `NotificationTarget ` 参数的挂钩被触发时,向 `NotificationTarget ` 参数中指定的消息队列投递包含令牌的消息,消息队列的消费者可从消息中获取令牌。
*/
LifecycleActionToken?: string;
}
/**
* CreateScalingPolicy返回参数结构体
*/
export interface CreateScalingPolicyResponse {
/**
* 告警触发策略ID。
*/
AutoScalingPolicyId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateNotificationConfiguration返回参数结构体
*/
export interface CreateNotificationConfigurationResponse {
/**
* 通知ID。
*/
AutoScalingNotificationId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRefreshActivities请求参数结构体
*/
export interface DescribeRefreshActivitiesRequest {
/**
* 刷新活动ID列表。ID形如:`asr-5l2ejpfo`。每次请求的上限为100。参数不支持同时指定`RefreshActivityIds`和`Filters`。
*/
RefreshActivityIds?: Array;
/**
* 过滤条件。
auto-scaling-group-id - String - 是否必填:否 -(过滤条件)按照伸缩组ID过滤。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
refresh-activity-status-code - String - 是否必填:否 -(过滤条件)按照刷新活动状态过滤。(INIT:初始化中 | RUNNING:运行中 | SUCCESSFUL:活动成功 | FAILED_PAUSE:失败暂停 | AUTO_PAUSE:自动暂停 | MANUAL_PAUSE:手动暂停 | CANCELLED:活动取消 | FAILED:活动失败)
refresh-activity-type - String - 是否必填:否 -(过滤条件)按照刷新活动类型过滤。(NORMAL:正常刷新活动 | ROLLBACK:回滚刷新活动)
refresh-activity-id - String - 是否必填:否 -(过滤条件)按照刷新活动ID过滤。
每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定RefreshActivityIds和Filters。
*/
Filters?: Array;
/**
* 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Limit?: number;
/**
* 偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Offset?: number;
}
/**
* DescribeLaunchConfigurations返回参数结构体
*/
export interface DescribeLaunchConfigurationsResponse {
/**
* 符合条件的启动配置数量。
*/
TotalCount?: number;
/**
* 启动配置详细信息列表。
*/
LaunchConfigurationSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RemoveInstances请求参数结构体
*/
export interface RemoveInstancesRequest {
/**
* 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。
通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* CVM实例ID列表。可以通过以下方式获取可用的实例ID:
通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。
通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。
*/
InstanceIds: Array;
}
/**
* DeleteScalingPolicy返回参数结构体
*/
export interface DeleteScalingPolicyResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 资源类型及标签键值对
*/
export interface Tag {
/**
* 标签键
*/
Key: string;
/**
* 标签值
*/
Value: string;
/**
* 标签绑定的资源类型,当前支持类型:"auto-scaling-group", "launch-configuration"。分别表示:伸缩组资源,启动配置资源。
*/
ResourceType?: string;
}
/**
* DetachLoadBalancers请求参数结构体
*/
export interface DetachLoadBalancersRequest {
/**
* 伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 传统负载均衡器ID列表,列表长度上限为20,LoadBalancerIds 和 ForwardLoadBalancerIdentifications 二者同时最多只能指定一个。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
*/
LoadBalancerIds?: Array;
/**
* 负载均衡器标识信息列表,列表长度上限为100,LoadBalancerIds 和 ForwardLoadBalancerIdentifications二者同时最多只能指定一个。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
*/
ForwardLoadBalancerIdentifications?: Array;
}
/**
* DescribeAutoScalingInstances请求参数结构体
*/
export interface DescribeAutoScalingInstancesRequest {
/**
* 待查询云服务器(CVM)的实例ID列表,列表长度上限为100,不支持同时指定 InstanceIds 和 Filters。
可以通过以下方式获取可用的实例ID:
通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。
通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。
*/
InstanceIds?: Array;
/**
* 过滤条件。
instance-id - String - 是否必填:否 -(过滤条件)按照实例ID过滤。可通过登录[控制台](https://console.cloud.tencent.com/cvm/index)或调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。
auto-scaling-group-id - String - 是否必填:否 -(过滤条件)按照伸缩组ID过滤。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
private-ip-address - String - 是否必填:否 -(过滤条件)按照实例内网IP过滤。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `PrivateIpAddresses`获取实例内网IP。
每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。
*/
Filters?: Array;
/**
* 偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Limit?: number;
}
/**
* ModifyLoadBalancers请求参数结构体
*/
export interface ModifyLoadBalancersRequest {
/**
* 伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 传统负载均衡器ID列表,目前长度上限为20,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
*/
LoadBalancerIds?: Array;
/**
* 负载均衡器列表,目前长度上限为100,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
*/
ForwardLoadBalancers?: Array;
/**
* 负载均衡器校验策略,取值包括 ALL 和 DIFF,默认取值为 ALL。
ALL,所有负载均衡器都合法则通过校验,否则校验报错。
DIFF,仅校验负载均衡器参数中实际变化的部分,如果合法则通过校验,否则校验报错。
*/
LoadBalancersCheckPolicy?: string;
}
/**
* RemoveInstances返回参数结构体
*/
export interface RemoveInstancesResponse {
/**
* 伸缩活动ID
*/
ActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyScalingPolicy返回参数结构体
*/
export interface ModifyScalingPolicyResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteLaunchConfiguration请求参数结构体
*/
export interface DeleteLaunchConfigurationRequest {
/**
* 需要删除的启动配置ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/config) 或调用接口 [DescribeLaunchConfigurations](https://cloud.tencent.com/document/api/377/20445) ,取返回信息中的 LaunchConfigurationId 获取启动配置ID。
*/
LaunchConfigurationId: string;
}
/**
* SetInstancesProtection请求参数结构体
*/
export interface SetInstancesProtectionRequest {
/**
* 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
通过登录 控制台 查询伸缩组ID。通过调用接口 DescribeAutoScalingGroups ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 实例ID。可以通过以下方式获取可用的实例ID:
通过登录控制台查询实例ID。通过调用接口 DescribeInstances ,取返回信息中的 InstanceId 获取实例ID。
*/
InstanceIds: Array;
/**
* 实例是否需要设置保护。
*/
ProtectedFromScaleIn: boolean;
}
/**
* DeleteNotificationConfiguration返回参数结构体
*/
export interface DeleteNotificationConfigurationResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DetachInstances返回参数结构体
*/
export interface DetachInstancesResponse {
/**
* 伸缩活动ID
*/
ActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 滚动更新设置。
*/
export interface RollingUpdateSettings {
/**
* 批次数量。批次数量为大于 0 的正整数,但不能大于待刷新实例数量。
*/
BatchNumber: number;
/**
* 批次间暂停策略。默认值为 Automatic,取值范围如下:
FIRST_BATCH_PAUSE:第一批次更新完成后暂停
BATCH_INTERVAL_PAUSE:批次间暂停
AUTOMATIC:不暂停
*/
BatchPause?: string;
/**
* 最大额外数量。设置该参数后,在滚动更新开始前根据启动配置创建一批按量计费的额外实例,滚动更新完成后销毁额外实例。
该参数用于保证滚动更新过程中可用实例的数量,最大额外数量不能超过滚动更新单个批次的刷新实例数。回滚流程暂不支持该参数。
*/
MaxSurge?: number;
/**
* 失败处理策略。默认值为 AUTO_PAUSE,取值范围如下:
AUTO_PAUSE:刷新失败后暂停
AUTO_ROLLBACK:刷新失败后回滚。回滚时每批次回滚一台实例,CheckInstanceTargetHealth 参数值与原刷新活动一致。MaxSurge参数引入的扩缩容流程失败无需回滚,会用取消动作代替回滚
AUTO_CANCEL:刷新失败后取消
*/
FailProcess?: string;
}
/**
* ModifyLaunchConfigurationAttributes返回参数结构体
*/
export interface ModifyLaunchConfigurationAttributesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateLaunchConfiguration请求参数结构体
*/
export interface CreateLaunchConfigurationRequest {
/**
* 启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
*/
LaunchConfigurationName: string;
/**
* 指定有效的镜像ID,格式形如img-8toqc6s3。镜像Id与镜像族名称,二者必填一个且只能填写一个。镜像类型分为四种:
公共镜像自定义镜像共享镜像服务市场镜像
可通过以下方式获取可用的镜像ID:
公共镜像、自定义镜像、共享镜像的镜像ID可通过登录控制台查询;服务镜像市场的镜像ID可通过云市场查询。通过调用接口 DescribeImages ,取返回信息中的ImageId字段。
*/
ImageId?: string;
/**
* 启动配置所属项目ID。默认值为0,表示使用默认项目。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。注意:伸缩组内实例所属项目ID取伸缩组项目ID,与这里取值无关。
*/
ProjectId?: number;
/**
* 实例机型。不同实例机型指定了不同的资源规格,具体取值可通过调用接口 DescribeInstanceTypeConfigs 来获得最新的规格表或参见实例类型描述。InstanceType和InstanceTypes参数互斥,二者必填一个且只能填写一个。
*/
InstanceType?: string;
/**
* 实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
*/
SystemDisk?: SystemDisk;
/**
* 实例数据盘配置信息。若不指定该参数,则默认不购买数据盘,最多支持指定11块数据盘。
*/
DataDisks?: Array;
/**
* 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
*/
InternetAccessible?: InternetAccessible;
/**
* 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。
*/
LoginSettings?: LoginSettings;
/**
* 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId字段来获取。若不指定该参数,则默认不绑定安全组。
*/
SecurityGroupIds?: Array;
/**
* 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。
*/
EnhancedService?: EnhancedService;
/**
* 经过 Base64 编码后的自定义数据,最大长度不超过16KB。
*/
UserData?: string;
/**
* 实例计费类型,CVM默认值按照POSTPAID_BY_HOUR处理。
POSTPAID_BY_HOUR:按小时后付费SPOTPAID:竞价付费PREPAID:预付费,即包年包月CDCPAID:专用集群付费
*/
InstanceChargeType?: string;
/**
* 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。
*/
InstanceMarketOptions?: InstanceMarketOptionsRequest;
/**
* 实例机型列表,不同实例机型指定了不同的资源规格,最多支持10种实例机型。InstanceType和InstanceTypes参数互斥,二者必填一个且只能填写一个。具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表或参见实例规格描述。
*/
InstanceTypes?: Array;
/**
* CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。
*/
CamRoleName?: string;
/**
* 实例类型校验策略,取值包括 ALL 和 ANY,默认取值为ANY。该参数仅在 InstanceTypes 入参包含多个机型时生效。
ALL,所有实例类型(InstanceType)都可用则通过校验,否则校验报错。 ANY,存在任何一个实例类型(InstanceType)可用则通过校验,否则校验报错。实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。如果 InstanceTypes 中一款机型不存在或者已下线,则无论 InstanceTypesCheckPolicy 采用何种取值,都会校验报错。
*/
InstanceTypesCheckPolicy?: string;
/**
* 标签列表。通过指定该参数,可以为扩容的实例绑定标签。最多支持指定10个标签。
*/
InstanceTags?: Array;
/**
* 标签描述列表。通过指定该参数可以支持绑定标签到启动配置。每个启动配置最多支持30个标签。
*/
Tags?: Array;
/**
* 云服务器主机名(HostName)的相关设置。不支持windows实例设置主机名。 新增该属性时,必须传递云服务器的主机名,其它未传递字段会设置为默认值。会校验主机名(如果存在后缀则加上后缀)是否超过最大位数46。
*/
HostNameSettings?: HostNameSettings;
/**
* 云服务器实例名(InstanceName)的相关设置。如果用户在启动配置中设置此字段,则伸缩组创建出的实例 InstanceName 参照此字段进行设置,并传递给 CVM;如果用户未在启动配置中设置此字段,则伸缩组创建出的实例 InstanceName 按照“as-{{ 伸缩组AutoScalingGroupName }}”进行设置,并传递给 CVM。新增该属性时,必须传递云服务器的实例名称,其它未传递字段会设置为默认值。会校验实例名称(如果存在后缀则加上后缀)是否超过最大位数108。
*/
InstanceNameSettings?: InstanceNameSettings;
/**
* 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
*/
InstanceChargePrepaid?: InstanceChargePrepaid;
/**
* 云盘类型选择策略,默认取值 ORIGINAL,取值范围:
ORIGINAL:使用设置的云盘类型AUTOMATIC:自动选择当前可用的云盘类型
*/
DiskTypePolicy?: string;
/**
* 高性能计算集群ID。可通过调用DescribeHpcClusters接口获取该参数。注意:此字段默认为空。
*/
HpcClusterId?: string;
/**
* IPv6公网带宽相关信息设置。若新建实例包含IPv6地址,该参数可为新建实例的IPv6地址分配公网带宽。关联启动配置的伸缩组Ipv6AddressCount参数为0时,该参数不会生效。
*/
IPv6InternetAccessible?: IPv6InternetAccessible;
/**
* 置放群组id,仅支持指定一个。
*/
DisasterRecoverGroupIds?: Array;
/**
* 镜像族名称。镜像Id与镜像族名称,二者必填一个且只能填写一个。可通过调用DescribeImages接口获取该参数。
*/
ImageFamily?: string;
/**
* 本地专用集群ID。可通过 DescribeDedicatedClusters 接口获取该参数。
*/
DedicatedClusterId?: string;
/**
* 自定义metadata。
*/
Metadata?: Metadata;
}
/**
* 伸缩组
*/
export interface AutoScalingGroup {
/**
* 伸缩组ID
*/
AutoScalingGroupId?: string;
/**
* 伸缩组名称
*/
AutoScalingGroupName?: string;
/**
* 伸缩组当前状态。取值范围:
NORMAL:正常CVM_ABNORMAL:启动配置异常LB_ABNORMAL:负载均衡器异常LB_LISTENER_ABNORMAL:负载均衡器监听器异常LB_LOCATION_ABNORMAL:负载均衡器监听器转发配置异常VPC_ABNORMAL:VPC网络异常SUBNET_ABNORMAL:VPC子网异常INSUFFICIENT_BALANCE:余额不足LB_BACKEND_REGION_NOT_MATCH:CLB实例后端地域与AS服务所在地域不匹配LB_BACKEND_VPC_NOT_MATCH:CLB实例VPC与伸缩组VPC不匹配
*/
AutoScalingGroupStatus?: string;
/**
* 创建时间,采用UTC标准计时
*/
CreatedTime?: string;
/**
* 默认冷却时间,单位秒
*/
DefaultCooldown?: number;
/**
* 期望实例数
*/
DesiredCapacity?: number;
/**
* 启用状态,取值包括ENABLED和DISABLED
*/
EnabledStatus?: string;
/**
* 应用型负载均衡器列表
*/
ForwardLoadBalancerSet?: Array;
/**
* 实例数量
*/
InstanceCount?: number;
/**
* 状态为IN_SERVICE实例的数量
*/
InServiceInstanceCount?: number;
/**
* 启动配置ID
*/
LaunchConfigurationId?: string;
/**
* 启动配置名称
*/
LaunchConfigurationName?: string;
/**
* 传统型负载均衡器ID列表
*/
LoadBalancerIdSet?: Array;
/**
* 最大实例数
*/
MaxSize?: number;
/**
* 最小实例数
*/
MinSize?: number;
/**
* 项目ID
*/
ProjectId?: number;
/**
* 子网ID列表
*/
SubnetIdSet?: Array;
/**
* 销毁策略。取值范围如下:
OLDEST_INSTANCE:优先销毁伸缩组中最旧的实例,默认取值。NEWEST_INSTANCE:优先销毁伸缩组中最新的实例。
*/
TerminationPolicySet?: Array;
/**
* 私有网络ID。
*/
VpcId?: string;
/**
* 可用区列表
*/
ZoneSet?: Array;
/**
* 重试策略,部分成功的伸缩活动判定为一次失败活动。取值范围如下:
IMMEDIATE_RETRY:默认取值,表示立即重试,在较短时间内快速重试,连续失败超过一定次数(5次)后不再重试。INCREMENTAL_INTERVALS:间隔递增重试,随着连续失败次数的增加,重试间隔逐渐增大。前 10 次重试为快速重试,后续重试间隔逐步递增至 10 分钟、30 分钟、60 分钟、一天。NO_RETRY,不进行重试,直到再次收到用户调用或者告警信息后才会重试。
*/
RetryPolicy?: string;
/**
* 伸缩组是否处于伸缩活动中,IN_ACTIVITY表示处于伸缩活动中,NOT_IN_ACTIVITY表示不处于伸缩活动中。
*/
InActivityStatus?: string;
/**
* 伸缩组标签列表
*/
Tags?: Array;
/**
* 服务设置
*/
ServiceSettings?: ServiceSettings;
/**
* 实例具有IPv6地址数量的配置,取值包括0、1。默认值为 0,表示实例不分配 IPv6 地址。需使用支持 IPv6 的私有网络,需在子网中开启 IPv6 CIDR,其他使用限制可参考 IPv6使用限制。
*/
Ipv6AddressCount?: number;
/**
* 多可用区/子网策略。
PRIORITY,按照可用区/子网列表的顺序,作为优先级来尝试创建实例,如果优先级最高的可用区/子网可以创建成功,则总在该可用区/子网创建。 EQUALITY:每次选择当前实例数最少的可用区/子网进行扩容,使得每个可用区/子网都有机会发生扩容,多次扩容出的实例会打散到多个可用区/子网。
*/
MultiZoneSubnetPolicy?: string;
/**
* 伸缩组实例健康检查类型,取值如下:
CVM:根据实例网络状态判断实例是否处于不健康状态,不健康的网络状态即发生实例 PING 不可达事件,详细判断标准可参考[实例健康检查](https://cloud.tencent.com/document/product/377/8553)CLB:根据 CLB 的健康检查状态判断实例是否处于不健康状态,CLB健康检查原理可参考[健康检查](https://cloud.tencent.com/document/product/214/6097)
*/
HealthCheckType?: string;
/**
* CLB健康检查宽限期.当扩容的实例进入IN_SERVICE后,在宽限期时间范围内将不会被标记为不健康CLB_UNHEALTHY。
默认值:0。取值范围[0, 7200],单位:秒。
*/
LoadBalancerHealthCheckGracePeriod?: number;
/**
* 实例分配策略,取值包括 LAUNCH_CONFIGURATION 和 SPOT_MIXED。
LAUNCH_CONFIGURATION,代表传统的按照启动配置模式。 SPOT_MIXED,代表竞价混合模式。目前仅支持启动配置为按量计费模式时使用混合模式,混合模式下,伸缩组将根据设定扩容按量或竞价机型。使用混合模式时,关联的启动配置的计费类型不可被修改。
*/
InstanceAllocationPolicy?: string;
/**
* 竞价混合模式下,各计费类型实例的分配策略。
仅当 InstanceAllocationPolicy 取 SPOT_MIXED 时才会返回有效值。
*/
SpotMixedAllocationPolicy?: SpotMixedAllocationPolicy;
/**
* 容量重平衡功能,仅对伸缩组内的竞价实例有效。取值范围:
TRUE,开启该功能,当伸缩组内的竞价实例即将被竞价实例服务自动回收前,AS 主动发起竞价实例销毁流程,如果有配置过缩容 hook,则销毁前 hook 会生效。销毁流程启动后,AS 会异步开启一个扩容活动,用于补齐期望实例数。 FALSE,不开启该功能,则 AS 等待竞价实例被销毁后才会去扩容补齐伸缩组期望实例数。
*/
CapacityRebalance?: boolean;
/**
* 实例名称序号相关设置。
*/
InstanceNameIndexSettings?: InstanceNameIndexSettings;
/**
* 实例主机名序号相关设置。
*/
HostNameIndexSettings?: HostNameIndexSettings;
/**
* 匹配期望数并发扩容功能,不能在InstanceAllocationPolicy为竞价混合模式时设置,也不能在ScalingMode为扩容优先开机模式时设置。目前仅支持两个匹配期望数扩容活动并发进行,不支持指定数量扩容、缩容等其他类型活动并发。默认值为FALSE,表示不开启。
*/
ConcurrentScaleOutForDesiredCapacity?: boolean;
}
/**
* AttachInstances返回参数结构体
*/
export interface AttachInstancesResponse {
/**
* 伸缩活动ID
*/
ActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAutoScalingGroupLastActivities返回参数结构体
*/
export interface DescribeAutoScalingGroupLastActivitiesResponse {
/**
* 符合条件的伸缩活动信息集合。说明:伸缩组伸缩活动不存在的则不返回,如传50个伸缩组ID,返回45条数据,说明其中有5个伸缩组伸缩活动不存在。
*/
ActivitySet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAccountLimits请求参数结构体
*/
export type DescribeAccountLimitsRequest = null;
/**
* ScaleInInstances返回参数结构体
*/
export interface ScaleInInstancesResponse {
/**
* 伸缩活动ID。
*/
ActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CancelInstanceRefresh请求参数结构体
*/
export interface CancelInstanceRefreshRequest {
/**
* 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。
通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 刷新活动ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ,取返回信息中的 RefreshActivityId 获取实例刷新活动ID。
*/
RefreshActivityId: string;
}
/**
* DetachLoadBalancers返回参数结构体
*/
export interface DetachLoadBalancersResponse {
/**
* 伸缩活动ID
*/
ActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 告警触发策略。
*/
export interface ScalingPolicy {
/**
* 伸缩组ID。
*/
AutoScalingGroupId?: string;
/**
* 告警触发策略ID。
*/
AutoScalingPolicyId?: string;
/**
* 告警触发策略类型。取值:
- SIMPLE:简单策略
- TARGET_TRACKING:目标追踪策略
*/
ScalingPolicyType?: string;
/**
* 告警触发策略名称。
*/
ScalingPolicyName?: string;
/**
* 告警触发后,期望实例数修改方式,仅适用于简单策略。取值范围:
CHANGE_IN_CAPACITY:增加或减少若干期望实例数EXACT_CAPACITY:调整至指定期望实例数 PERCENT_CHANGE_IN_CAPACITY:按百分比调整期望实例数
*/
AdjustmentType?: string;
/**
* 告警触发后,期望实例数的调整值,仅适用于简单策略。
*/
AdjustmentValue?: number;
/**
* 冷却时间,单位为秒,仅适用于简单策略。取值范围 [0,3600],默认冷却时间300秒。
*/
Cooldown?: number;
/**
* 简单告警触发策略告警监控指标,仅适用于简单策略。
*/
MetricAlarm?: MetricAlarm;
/**
* 预定义监控项,仅适用于目标追踪策略。取值范围:
ASG_AVG_CPU_UTILIZATION:平均CPU使用率ASG_AVG_LAN_TRAFFIC_OUT:平均内网出带宽ASG_AVG_LAN_TRAFFIC_IN:平均内网入带宽ASG_AVG_WAN_TRAFFIC_OUT:平均外网出带宽ASG_AVG_WAN_TRAFFIC_IN:平均外网出带宽
注意:此字段可能返回 null,表示取不到有效值。
*/
PredefinedMetricType?: string;
/**
* 目标值,仅适用于目标追踪策略。
ASG_AVG_CPU_UTILIZATION:[1, 100),单位:%ASG_AVG_LAN_TRAFFIC_OUT:>0,单位:MbpsASG_AVG_LAN_TRAFFIC_IN:>0,单位:MbpsASG_AVG_WAN_TRAFFIC_OUT:>0,单位:MbpsASG_AVG_WAN_TRAFFIC_IN:>0,单位:Mbps
注意:此字段可能返回 null,表示取不到有效值。
*/
TargetValue?: number;
/**
* 实例预热时间,单位为秒,仅适用于目标追踪策略。取值范围为0-3600。
注意:此字段可能返回 null,表示取不到有效值。
*/
EstimatedInstanceWarmup?: number;
/**
* 是否禁用缩容,仅适用于目标追踪策略。取值范围:
true:目标追踪策略仅触发扩容false:目标追踪策略触发扩容和缩容
注意:此字段可能返回 null,表示取不到有效值。
*/
DisableScaleIn?: boolean;
/**
* 告警监控指标列表,仅适用于目标追踪策略。
注意:此字段可能返回 null,表示取不到有效值。
*/
MetricAlarms?: Array;
/**
* 通知组ID,即为用户组ID集合。
*/
NotificationUserGroupIds?: Array;
}
/**
* DescribeAutoScalingGroupLastActivities请求参数结构体
*/
export interface DescribeAutoScalingGroupLastActivitiesRequest {
/**
* 伸缩组ID列表。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupIds: Array;
/**
* 查询时排除取消类型活动。默认值为 false,表示不排除取消类型活动。
*/
ExcludeCancelledActivity?: boolean;
}
/**
* 云服务器主机名(HostName)的相关设置
*/
export interface HostNameSettings {
/**
* 云服务器的主机名。
点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。
不支持 Windows 实例。
其他类型(Linux 等)实例:字符长度为[2, 42],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。不允许为纯数字。
注意:此字段可能返回 null,表示取不到有效值。
*/
HostName: string;
/**
* 云服务器主机名的风格,取值范围包括 ORIGINAL 和 UNIQUE,默认为 ORIGINAL。
ORIGINAL,AS 直接将入参中所填的 HostName 传递给 CVM,CVM 可能会对 HostName 追加序列号,伸缩组中实例的 HostName 会出现冲突的情况。
UNIQUE,入参所填的 HostName 相当于主机名前缀,AS 和 CVM 会对其进行拓展,伸缩组中实例的 HostName 可以保证唯一。
注意:此字段可能返回 null,表示取不到有效值。
*/
HostNameStyle?: string;
/**
* 云服务器的主机名后缀。
点号(.)和短横线(-)不能作为 HostNameSuffix 的尾字符,不能连续使用。
不支持 Windows 实例。
其他类型(Linux 等)实例:字符长度为[1, 39],且与 HostName 的长度和不能超过 41,允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。
注意:此字段可能返回 null,表示取不到有效值。
*/
HostNameSuffix?: string;
/**
* 云服务器的主机名分隔符。默认的分隔符是点号(.),可选短横线(-)或空字符串。
分隔符用于拼接主机名,递增序号,后缀。假设主机名为 testGpu4090 ,递增序号为 0007,后缀为 server:
- 分隔符为英文点号(.),最终拼接为 testGpu4090.007.server
- 分隔符为短横线(-),最终拼接为 testGpu4090-007-server
- 分隔符为空字符串,最终拼接为 testGpu4090007server
*/
HostNameDelimiter?: string;
}
/**
* ModifyLoadBalancers返回参数结构体
*/
export interface ModifyLoadBalancersResponse {
/**
* 伸缩活动ID
*/
ActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateNotificationConfiguration请求参数结构体
*/
export interface CreateNotificationConfigurationRequest {
/**
* 伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 通知类型,即为需要订阅的通知类型集合,取值范围如下:
SCALE_OUT_SUCCESSFUL:扩容成功
SCALE_OUT_FAILED:扩容失败
SCALE_IN_SUCCESSFUL:缩容成功
SCALE_IN_FAILED:缩容失败
REPLACE_UNHEALTHY_INSTANCE_SUCCESSFUL:替换不健康子机成功
REPLACE_UNHEALTHY_INSTANCE_FAILED:替换不健康子机失败
*/
NotificationTypes: Array;
/**
* 通知组ID,即为用户组ID集合,用户组ID可以通过[ListGroups](https://cloud.tencent.com/document/product/598/34589)查询。该参数仅在 TargetType 为 USER_GROUP 时生效。
*/
NotificationUserGroupIds?: Array;
/**
* 通知接收端类型,取值如下:
USER_GROUP:用户组
TDMQ_CMQ_TOPIC:TDMQ CMQ 主题
TDMQ_CMQ_QUEUE:TDMQ CMQ 队列
CMQ_QUEUE:CMQ 队列,[CMQ已下线](https://cloud.tencent.com/document/product/1496/83970),目前仅推荐使用 TDMQ CMQ。
CMQ_TOPIC:CMQ 主题,[CMQ已下线](https://cloud.tencent.com/document/product/1496/83970),目前仅推荐使用 TDMQ CMQ。
默认值为:`USER_GROUP`。
*/
TargetType?: string;
/**
* TDMQ CMQ 队列名,如 TargetType 取值为 `TDMQ_CMQ_QUEUE` ,该字段必填。
*/
QueueName?: string;
/**
* TDMQ CMQ 主题名,如 TargetType 取值为 `TDMQ_CMQ_TOPIC` ,该字段必填。
*/
TopicName?: string;
}
/**
* DescribeScheduledActions返回参数结构体
*/
export interface DescribeScheduledActionsResponse {
/**
* 符合条件的定时任务数量。
*/
TotalCount?: number;
/**
* 定时任务详细信息列表。
*/
ScheduledActionSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyNotificationConfiguration请求参数结构体
*/
export interface ModifyNotificationConfigurationRequest {
/**
* 待修改的通知ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeNotificationConfigurations](https://cloud.tencent.com/document/api/377/33183) ,取返回信息中的 AutoScalingNotificationId 获取通知ID。
*/
AutoScalingNotificationId: string;
/**
* 通知类型,即为需要订阅的通知类型集合,取值范围如下:
SCALE_OUT_SUCCESSFUL:扩容成功
SCALE_OUT_FAILED:扩容失败
SCALE_IN_SUCCESSFUL:缩容成功
SCALE_IN_FAILED:缩容失败
REPLACE_UNHEALTHY_INSTANCE_SUCCESSFUL:替换不健康子机成功
REPLACE_UNHEALTHY_INSTANCE_FAILED:替换不健康子机失败
*/
NotificationTypes?: Array;
/**
* 通知组ID,即为用户组ID集合,用户组ID可以通过[ListGroups](https://cloud.tencent.com/document/product/598/34589)查询。该参数仅在 `TargetType ` 为 `USER_GROUP ` 时生效。
*/
NotificationUserGroupIds?: Array;
/**
* TDMQ CMQ 队列名。[原CMQ已下线](https://cloud.tencent.com/document/product/1496/83970),目前仅推荐使用 TDMQ CMQ。该参数仅在 `TargetType ` 为 `TDMQ_CMQ_QUEUE ` 时生效。
*/
QueueName?: string;
/**
* TDMQ CMQ 主题名。[原CMQ已下线](https://cloud.tencent.com/document/product/1496/83970),目前仅推荐使用 TDMQ CMQ。该参数仅在 `TargetType ` 为 `TDMQ_CMQ_TOPIC ` 时生效。
*/
TopicName?: string;
}
/**
* DeleteLifecycleHook请求参数结构体
*/
export interface DeleteLifecycleHookRequest {
/**
* 生命周期挂钩ID。可以通过调用接口 [DescribeLifecycleHooks](https://cloud.tencent.com/document/api/377/34452) ,取返回信息中的 LifecycleHookId 获取生命周期挂钩ID。
*/
LifecycleHookId: string;
}
/**
* ModifyLoadBalancerTargetAttributes返回参数结构体
*/
export interface ModifyLoadBalancerTargetAttributesResponse {
/**
* 伸缩活动ID
*/
ActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAutoScalingGroup返回参数结构体
*/
export interface ModifyAutoScalingGroupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ExitStandby返回参数结构体
*/
export interface ExitStandbyResponse {
/**
* 伸缩活动ID。
*/
ActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 执行命令结果。
*/
export interface InvocationResult {
/**
* 实例ID。
*/
InstanceId?: string;
/**
* 执行活动ID。
*/
InvocationId?: string;
/**
* 执行任务ID。
*/
InvocationTaskId?: string;
/**
* 命令ID。
*/
CommandId?: string;
/**
* 执行任务状态。
*/
TaskStatus?: string;
/**
* 执行异常信息。
*/
ErrorMessage?: string;
}
/**
* ModifyScalingPolicy请求参数结构体
*/
export interface ModifyScalingPolicyRequest {
/**
* 告警策略ID。可通过登录 控制台 或调用接口 DescribeScalingPolicies ,取返回信息中的 AutoScalingPolicyId 获取告警策略ID。
*/
AutoScalingPolicyId: string;
/**
* 告警策略名称,在您账号中必须唯一。名称长度不能超过60,名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点。
*/
ScalingPolicyName?: string;
/**
* 告警触发后,期望实例数修改方式,仅适用于简单策略。取值范围:
CHANGE_IN_CAPACITY:增加或减少若干期望实例数EXACT_CAPACITY:调整至指定期望实例数 PERCENT_CHANGE_IN_CAPACITY:按百分比调整期望实例数
*/
AdjustmentType?: string;
/**
* 告警触发后,期望实例数的调整值,仅适用于简单策略。
当 AdjustmentType 为 CHANGE_IN_CAPACITY 时,AdjustmentValue 为正数表示告警触发后增加实例,为负数表示告警触发后减少实例 当 AdjustmentType 为 EXACT_CAPACITY 时,AdjustmentValue 的值即为告警触发后新的期望实例数,需要大于或等于0 当 AdjustmentType 为 PERCENT_CHANGE_IN_CAPACITY 时,AdjusmentValue 为正数表示告警触发后按百分比增加实例,为负数表示告警触发后按百分比减少实例,单位是:%。
*/
AdjustmentValue?: number;
/**
* 冷却时间,仅适用于简单策略,单位为秒。
*/
Cooldown?: number;
/**
* 告警监控指标,仅适用于简单策略。
*/
MetricAlarm?: MetricAlarm;
/**
* 预定义监控项,仅适用于目标追踪策略。取值范围:
ASG_AVG_CPU_UTILIZATION:平均CPU使用率ASG_AVG_LAN_TRAFFIC_OUT:平均内网出带宽ASG_AVG_LAN_TRAFFIC_IN:平均内网入带宽ASG_AVG_WAN_TRAFFIC_OUT:平均外网出带宽ASG_AVG_WAN_TRAFFIC_IN:平均外网出带宽当前外网出入带宽属于 CLB 类指标,其他指标属于 CVM 类指标。修改指标名称时不允许跨类别修改。枚举值:- ASG_AVG_CPU_UTILIZATION: 平均CPU使用率
*/
PredefinedMetricType?: string;
/**
* 目标值,仅适用于目标追踪策略。
ASG_AVG_CPU_UTILIZATION:[1, 100),单位:%ASG_AVG_LAN_TRAFFIC_OUT:>0,单位:MbpsASG_AVG_LAN_TRAFFIC_IN:>0,单位:MbpsASG_AVG_WAN_TRAFFIC_OUT:>0,单位:MbpsASG_AVG_WAN_TRAFFIC_IN:>0,单位:Mbps
*/
TargetValue?: number;
/**
* 实例预热时间,单位为秒,仅适用于目标追踪策略。取值范围为0-3600。
*/
EstimatedInstanceWarmup?: number;
/**
* 是否禁用缩容,仅适用于目标追踪策略。取值范围:
true:目标追踪策略仅触发扩容false:目标追踪策略触发扩容和缩容
*/
DisableScaleIn?: boolean;
/**
* 此参数已不再生效,请使用创建通知。通知组ID,即为用户组ID集合。
*/
NotificationUserGroupIds?: Array;
}
/**
* CVM竞价请求相关选项
*/
export interface InstanceMarketOptionsRequest {
/**
* 竞价相关选项
*/
SpotOptions: SpotMarketOptions;
/**
* 市场选项类型,当前只支持取值:spot
*/
MarketType?: string;
}
/**
* 实例刷新批次信息,包含该批次的刷新状态、实例、起止时间等信息。
*/
export interface RefreshBatch {
/**
* 刷新批次序号。例如,2 表示当前批次实例会在第二批次进行实例刷新。
*/
RefreshBatchNum?: number;
/**
* 刷新批次状态。取值如下:WAITING:待刷新INIT:初始化中RUNNING:刷新中FAILED: 刷新失败PARTIALLY_SUCCESSFUL:批次部分成功CANCELLED:已取消SUCCESSFUL:刷新成功
*/
RefreshBatchStatus?: string;
/**
* 刷新批次关联实例列表。
*/
RefreshBatchRelatedInstanceSet?: Array;
/**
* 刷新批次开始时间。
注意:此字段可能返回 null,表示取不到有效值。
*/
StartTime?: string;
/**
* 刷新批次结束时间。
注意:此字段可能返回 null,表示取不到有效值。
*/
EndTime?: string;
}
/**
* EnterStandby返回参数结构体
*/
export interface EnterStandbyResponse {
/**
* 伸缩活动ID。
*/
ActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpgradeLifecycleHook返回参数结构体
*/
export interface UpgradeLifecycleHookResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例标签。通过指定该参数,可以为扩容的实例绑定标签。
*/
export interface InstanceTag {
/**
* 标签键
*/
Key: string;
/**
* 标签值
*/
Value: string;
}
/**
* ModifyLifecycleHook返回参数结构体
*/
export interface ModifyLifecycleHookResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 远程命令执行对象。
*/
export interface LifecycleCommand {
/**
* 远程命令ID。若选择执行命令,则此项必填。
*/
CommandId: string;
/**
* 自定义参数。字段类型为 json encoded string。如:{"varA": "222"}。
key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。
如果未提供该参数取值,将使用 Command 的 DefaultParameters 进行替换。
自定义参数最多20个。自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。
*/
Parameters?: string;
}
/**
* DescribeAutoScalingAdvices返回参数结构体
*/
export interface DescribeAutoScalingAdvicesResponse {
/**
* 伸缩组配置建议集合。
*/
AutoScalingAdviceSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAutoScalingGroup请求参数结构体
*/
export interface CreateAutoScalingGroupRequest {
/**
* 伸缩组名称,在您账号中必须唯一。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超55个字节。
*/
AutoScalingGroupName: string;
/**
* 启动配置ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/config) 或调用接口 [DescribeLaunchConfigurations](https://cloud.tencent.com/document/api/377/20445) ,取返回信息中的 LaunchConfigurationId 获取启动配置ID。
*/
LaunchConfigurationId: string;
/**
* 最大实例数,取值范围为 [0,2000],同时需满足 MaxSize >= DesiredCapacity >= MinSize 。
*/
MaxSize: number;
/**
* 最小实例数,取值范围为 [0,2000],同时需满足 MaxSize >= DesiredCapacity >= MinSize 。
*/
MinSize: number;
/**
* 私有网络ID。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc)查询;也可以调用接口 [DescribeVpc](https://cloud.tencent.com/document/api/215/15778) ,从接口返回中的VpcId字段获取。
*/
VpcId: string;
/**
* 默认冷却时间,单位秒,默认值为300。取值范围为 [0,3600]。
*/
DefaultCooldown?: number;
/**
* 期望实例数,取值范围 [0,2000],默认值等于当前 MinSize,同时需满足 MaxSize >= DesiredCapacity >= MinSize 。
*/
DesiredCapacity?: number;
/**
* 传统负载均衡器ID列表,目前长度上限为20,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
*/
LoadBalancerIds?: Array;
/**
* 伸缩组内实例所属项目ID。默认值为0,表示使用默认项目。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。
*/
ProjectId?: number;
/**
* 负载均衡器列表,目前长度上限为100,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个
*/
ForwardLoadBalancers?: Array;
/**
* 子网ID列表,VPC场景下必须指定子网。多个子网以填写顺序为优先级,依次进行尝试,直至可以成功创建实例。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet)查询;也可以调用接口 [DescribeSubnets](https://cloud.tencent.com/document/product/215/15784) ,从接口返回中的SubnetId字段获取。
*/
SubnetIds?: Array;
/**
* 销毁策略,目前长度上限为1。取值包括 OLDEST_INSTANCE 和 NEWEST_INSTANCE,默认取值为 OLDEST_INSTANCE。
OLDEST_INSTANCE 优先销毁伸缩组中最旧的实例。
NEWEST_INSTANCE,优先销毁伸缩组中最新的实例。
*/
TerminationPolicies?: Array;
/**
* 可用区列表,基础网络场景下必须指定可用区。多个可用区以填写顺序为优先级,依次进行尝试,直至可以成功创建实例。
*/
Zones?: Array;
/**
* 重试策略,取值包括 IMMEDIATE_RETRY、 INCREMENTAL_INTERVALS、NO_RETRY,默认取值为 IMMEDIATE_RETRY。部分成功的伸缩活动判定为一次失败活动。
IMMEDIATE_RETRY,立即重试,在较短时间内快速重试,连续失败超过一定次数(5次)后不再重试。
INCREMENTAL_INTERVALS,间隔递增重试,随着连续失败次数的增加,重试间隔逐渐增大。前 10 次重试间隔与立即重试模式相同,后续逐步递增至 10 分钟、30 分钟、60 分钟、一天。
NO_RETRY,不进行重试,直到再次收到用户调用或者告警信息后才会重试。
*/
RetryPolicy?: string;
/**
* 可用区校验策略,取值包括 ALL 和 ANY,默认取值为ANY。
ALL,所有可用区(Zone)或子网(SubnetId)都可用则通过校验,否则校验报错。
ANY,存在任何一个可用区(Zone)或子网(SubnetId)可用则通过校验,否则校验报错。
可用区或子网不可用的常见原因包括该可用区CVM实例类型售罄、该可用区CBS云盘售罄、该可用区配额不足、该子网IP不足等。
如果 Zones/SubnetIds 中可用区或者子网不存在,则无论 ZonesCheckPolicy 采用何种取值,都会校验报错。
*/
ZonesCheckPolicy?: string;
/**
* 标签描述列表。通过指定该参数可以支持绑定标签到伸缩组。同时绑定标签到相应的资源实例。每个伸缩组最多支持30个标签。可通过调用接口 [GetTags](https://cloud.tencent.com/document/product/651/72275) ,根据回参获取已有的标签键值对信息。
*/
Tags?: Array;
/**
* 服务设置,包括云监控不健康替换等服务设置。
*/
ServiceSettings?: ServiceSettings;
/**
* 实例具有IPv6地址数量的配置,取值包括0、1。默认值为 0,表示实例不分配 IPv6 地址。需使用支持 IPv6 的私有网络,需在子网中开启 IPv6 CIDR,其他使用限制可参考 [IPv6使用限制](https://cloud.tencent.com/document/product/1142/38369)。
*/
Ipv6AddressCount?: number;
/**
* 多可用区/子网策略,取值包括 PRIORITY 和 EQUALITY,默认为 PRIORITY。
PRIORITY,按照可用区/子网列表的顺序,作为优先级来尝试创建实例,如果优先级最高的可用区/子网可以创建成功,则总在该可用区/子网创建。
EQUALITY:扩容出的实例会打散到多个可用区/子网,保证扩容后的各个可用区/子网实例数相对均衡。
与本策略相关的注意点:
当伸缩组为基础网络时,本策略适用于多可用区;当伸缩组为VPC网络时,本策略适用于多子网,此时不再考虑可用区因素,例如四个子网ABCD,其中ABC处于可用区1,D处于可用区2,此时考虑子网ABCD进行排序,而不考虑可用区1、2。
本策略适用于多可用区/子网,不适用于启动配置的多机型。多机型按照优先级策略进行选择。
按照 PRIORITY 策略创建实例时,先保证多机型的策略,后保证多可用区/子网的策略。例如多机型A、B,多子网1、2、3,会按照A1、A2、A3、B1、B2、B3 进行尝试,如果A1售罄,会尝试A2(而非B1)。
*/
MultiZoneSubnetPolicy?: string;
/**
* 伸缩组实例健康检查类型,取值如下:
CVM:根据实例网络状态判断实例是否处于不健康状态,不健康的网络状态即发生实例 PING 不可达事件,详细判断标准可参考[实例健康检查](https://cloud.tencent.com/document/product/377/8553)
CLB:根据 CLB 的健康检查状态判断实例是否处于不健康状态,CLB健康检查原理可参考[健康检查](https://cloud.tencent.com/document/product/214/6097)
如果选择了`CLB`类型,伸缩组将同时检查实例网络状态与CLB健康检查状态,如果出现实例网络状态不健康,实例将被标记为 UNHEALTHY 状态;如果出现 CLB 健康检查状态异常,实例将被标记为CLB_UNHEALTHY 状态,如果两个异常状态同时出现,实例`HealthStatus`字段将返回 UNHEALTHY|CLB_UNHEALTHY。默认值:CLB
*/
HealthCheckType?: string;
/**
* CLB健康检查宽限期,当扩容的实例进入`IN_SERVICE`后,在宽限期时间范围内将不会被标记为不健康`CLB_UNHEALTHY`。
默认值:0。取值范围[0, 7200],单位:秒。
*/
LoadBalancerHealthCheckGracePeriod?: number;
/**
* 实例分配策略,取值包括 LAUNCH_CONFIGURATION 和 SPOT_MIXED,默认取 LAUNCH_CONFIGURATION。
LAUNCH_CONFIGURATION,代表传统的按照启动配置模式。
SPOT_MIXED,代表竞价混合模式。目前仅支持启动配置为按量计费模式时使用混合模式,混合模式下,伸缩组将根据设定扩容按量或竞价机型。使用混合模式时,关联的启动配置的计费类型不可被修改。
*/
InstanceAllocationPolicy?: string;
/**
* 竞价混合模式下,各计费类型实例的分配策略。
仅当 InstanceAllocationPolicy 取 SPOT_MIXED 时可用。
*/
SpotMixedAllocationPolicy?: SpotMixedAllocationPolicy;
/**
* 容量重平衡功能,仅对伸缩组内的竞价实例有效。取值范围:
TRUE,开启该功能,当伸缩组内的竞价实例即将被竞价实例服务自动回收前,AS 主动发起竞价实例销毁流程,如果有配置过缩容 hook,则销毁前 hook 会生效。销毁流程启动后,AS 会异步开启一个扩容活动,用于补齐期望实例数。
FALSE,不开启该功能,则 AS 等待竞价实例被销毁后才会去扩容补齐伸缩组期望实例数。
默认取 FALSE。
*/
CapacityRebalance?: boolean;
/**
* 实例名称序号相关设置。若不指定该参数,则默认不开启。开启后为伸缩组内自动创建的实例名称添加递增的数字序号。
*/
InstanceNameIndexSettings?: InstanceNameIndexSettings;
/**
* 实例主机名序号相关设置。若不指定该参数,则默认不开启。开启后为伸缩组内自动创建的实例主机名添加递增的数字序号。
*/
HostNameIndexSettings?: HostNameIndexSettings;
/**
* 匹配期望数并发扩容功能,不能在InstanceAllocationPolicy为竞价混合模式时设置,也不能在ScalingMode为扩容优先开机模式时设置。目前仅支持两个匹配期望数扩容活动并发进行,不支持指定数量扩容、缩容等其他类型活动并发。默认值为FALSE,表示不开启。
*/
ConcurrentScaleOutForDesiredCapacity?: boolean;
}
/**
* DeleteScheduledAction返回参数结构体
*/
export interface DeleteScheduledActionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpgradeLaunchConfiguration请求参数结构体
*/
export interface UpgradeLaunchConfigurationRequest {
/**
* 启动配置ID。
*/
LaunchConfigurationId: string;
/**
* 指定有效的镜像ID,格式形如img-8toqc6s3。镜像类型分为四种:
公共镜像自定义镜像共享镜像服务市场镜像
可通过以下方式获取可用的镜像ID:
公共镜像、自定义镜像、共享镜像的镜像ID可通过登录控制台查询;服务镜像市场的镜像ID可通过云市场查询。通过调用接口 DescribeImages ,取返回信息中的ImageId字段。
*/
ImageId: string;
/**
* 实例机型列表,不同实例机型指定了不同的资源规格,最多支持5种实例机型。
*/
InstanceTypes: Array;
/**
* 启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
*/
LaunchConfigurationName: string;
/**
* 实例数据盘配置信息。若不指定该参数,则默认不购买数据盘,最多支持指定11块数据盘。
*/
DataDisks?: Array;
/**
* 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。
*/
EnhancedService?: EnhancedService;
/**
* 实例计费类型,CVM默认值按照POSTPAID_BY_HOUR处理。
POSTPAID_BY_HOUR:按小时后付费
SPOTPAID:竞价付费
PREPAID:预付费,即包年包月
*/
InstanceChargeType?: string;
/**
* 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。
*/
InstanceMarketOptions?: InstanceMarketOptionsRequest;
/**
* 实例类型校验策略,取值包括 ALL 和 ANY,默认取值为ANY。
ALL,所有实例类型(InstanceType)都可用则通过校验,否则校验报错。
ANY,存在任何一个实例类型(InstanceType)可用则通过校验,否则校验报错。实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。如果 InstanceTypes 中一款机型不存在或者已下线,则无论 InstanceTypesCheckPolicy 采用何种取值,都会校验报错。
*/
InstanceTypesCheckPolicy?: string;
/**
* 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
*/
InternetAccessible?: InternetAccessible;
/**
* 该参数已失效,请勿使用。升级启动配置接口无法修改或覆盖 LoginSettings 参数,升级后 LoginSettings 不会发生变化。
*/
LoginSettings?: LoginSettings;
/**
* 实例所属项目ID。不填为默认项目。
*/
ProjectId?: number;
/**
* 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId字段来获取。若不指定该参数,则默认不绑定安全组。
*/
SecurityGroupIds?: Array;
/**
* 实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
*/
SystemDisk?: SystemDisk;
/**
* 经过 Base64 编码后的自定义数据,最大长度不超过16KB。
*/
UserData?: string;
/**
* 标签列表。通过指定该参数,可以为扩容的实例绑定标签。最多支持指定10个标签。
*/
InstanceTags?: Array;
/**
* CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。
*/
CamRoleName?: string;
/**
* 云服务器主机名(HostName)的相关设置。
*/
HostNameSettings?: HostNameSettings;
/**
* 云服务器实例名(InstanceName)的相关设置。
*/
InstanceNameSettings?: InstanceNameSettings;
/**
* 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
*/
InstanceChargePrepaid?: InstanceChargePrepaid;
/**
* 云盘类型选择策略,取值范围:
ORIGINAL:使用设置的云盘类型
AUTOMATIC:自动选择当前可用的云盘类型
*/
DiskTypePolicy?: string;
/**
* IPv6公网带宽相关信息设置。若新建实例包含IPv6地址,该参数可为新建实例的IPv6地址分配公网带宽。关联启动配置的伸缩组Ipv6AddressCount参数为0时,该参数不会生效。
*/
IPv6InternetAccessible?: IPv6InternetAccessible;
}
/**
* DescribeAutoScalingActivities返回参数结构体
*/
export interface DescribeAutoScalingActivitiesResponse {
/**
* 符合条件的伸缩活动数量。
*/
TotalCount?: number;
/**
* 符合条件的伸缩活动信息集合。
*/
ActivitySet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeNotificationConfigurations返回参数结构体
*/
export interface DescribeNotificationConfigurationsResponse {
/**
* 符合条件的通知数量。
*/
TotalCount?: number;
/**
* 弹性伸缩事件通知详细信息列表。
*/
AutoScalingNotificationSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 启动配置的数据盘配置信息。若不指定该参数,则默认不购买数据盘,当前仅支持购买的时候指定一个数据盘。
*/
export interface DataDisk {
/**
* 数据盘类型。数据盘类型限制详见[云硬盘类型](https://cloud.tencent.com/document/product/362/2353)。取值范围:
LOCAL_BASIC:本地硬盘
LOCAL_SSD:本地SSD硬盘
CLOUD_BASIC:普通云硬盘
CLOUD_PREMIUM:高性能云硬盘
CLOUD_SSD:SSD云硬盘
CLOUD_HSSD:增强型SSD云硬盘
CLOUD_TSSD:极速型SSD云硬盘
CLOUD_BSSD:通用型SSD云硬盘
默认取值与系统盘类型(SystemDisk.DiskType)保持一致。
*/
DiskType?: string;
/**
* 数据盘大小,单位:GB。不同数据盘类型取值范围不同,具体限制详见:[CVM实例配置](https://cloud.tencent.com/document/product/213/2177)。默认值为0,表示不购买数据盘。更多限制详见[产品文档](https://cloud.tencent.com/document/product/362/5145)。
*/
DiskSize?: number;
/**
* 数据盘快照 ID,可通过 [DescribeSnapshots](https://cloud.tencent.com/document/product/362/15647) 接口获取该参数。
注意:此字段可能返回 null,表示取不到有效值。
*/
SnapshotId?: string;
/**
* 数据盘是否随子机销毁。取值范围:
TRUE:子机销毁时,销毁数据盘,只支持按小时后付费云盘
FALSE:子机销毁时,保留数据盘
注意:此字段可能返回 null,表示取不到有效值。
*/
DeleteWithInstance?: boolean;
/**
* 数据盘是否加密。取值范围:
TRUE:加密
FALSE:不加密
注意:此字段可能返回 null,表示取不到有效值。
*/
Encrypt?: boolean;
/**
* 云硬盘性能,单位:MB/s。使用此参数可给云硬盘购买额外的性能,功能介绍和类型限制详见:[增强型 SSD 云硬盘额外性能说明](https://cloud.tencent.com/document/product/362/51896#.E5.A2.9E.E5.BC.BA.E5.9E.8B-ssd-.E4.BA.91.E7.A1.AC.E7.9B.98.E9.A2.9D.E5.A4.96.E6.80.A7.E8.83.BD)。
当前仅支持极速型云盘(CLOUD_TSSD)和增强型SSD云硬盘(CLOUD_HSSD)且 需容量 > 460GB。
注意:此字段可能返回 null,表示取不到有效值。
*/
ThroughputPerformance?: number;
/**
* 突发性能。是否开启突发性能,默认取值为 false。当前该参数仅支持极速型云盘(CLOUD_TSSD)和增强型SSD云硬盘(CLOUD_HSSD)且需容量 > 460GB。
注:内测中,需提单申请后使用。
注意:此字段可能返回 null,表示取不到有效值。
*/
BurstPerformance?: boolean;
}
/**
* RollbackInstanceRefresh返回参数结构体
*/
export interface RollbackInstanceRefreshResponse {
/**
* 刷新活动 ID。
*/
RefreshActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteScalingPolicy请求参数结构体
*/
export interface DeleteScalingPolicyRequest {
/**
* 待删除的告警策略ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeScalingPolicies](https://cloud.tencent.com/document/api/377/33178) ,取返回信息中的 AutoScalingPolicyId 获取告警策略ID。
*/
AutoScalingPolicyId: string;
}
/**
* 描述了实例登录相关配置与信息。
*/
export interface LoginSettings {
/**
* 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:
- Linux实例密码必须8到30位,至少包括四项(小写字母、大写字母、数字和特殊符号)中的两项。
- Windows实例密码必须12到30位,至少包括包括四项(小写字母、大写字母、数字和特殊符号)中的三项。
- 若不指定该参数,则由系统随机生成密码,并通过站内信方式通知到用户。
特殊符号的取值范围: [( ) ` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]
*/
Password?: string;
/**
* 密钥ID列表。关联密钥后,就可以通过对应的私钥来访问实例;KeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取,密钥与密码不能同时指定,同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。
*/
KeyIds?: Array;
/**
* 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围:
TRUE:表示保持镜像的登录设置
FALSE:表示不保持镜像的登录设置默认取值:FALSE。
*/
KeepImageLogin?: boolean;
}
/**
* CreateAutoScalingGroupFromInstance返回参数结构体
*/
export interface CreateAutoScalingGroupFromInstanceResponse {
/**
* 伸缩组ID
*/
AutoScalingGroupId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DetachInstances请求参数结构体
*/
export interface DetachInstancesRequest {
/**
* 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。
通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* CVM实例ID列表。可以通过以下方式获取可用的实例ID:
通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。
通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。
*/
InstanceIds: Array;
}
/**
* 实例信息
*/
export interface Instance {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 伸缩组ID
*/
AutoScalingGroupId?: string;
/**
* 启动配置ID
*/
LaunchConfigurationId?: string;
/**
* 启动配置名称
*/
LaunchConfigurationName?: string;
/**
* 生命周期状态,取值如下:
IN_SERVICE:运行中
CREATING:创建中
CREATION_FAILED:创建失败
TERMINATING:中止中
TERMINATION_FAILED:中止失败
ATTACHING:绑定中
ATTACH_FAILED:绑定失败
DETACHING:解绑中
DETACH_FAILED:解绑失败
ATTACHING_LB:绑定LB中
DETACHING_LB:解绑LB中
MODIFYING_LB:修改LB中
STARTING:开机中
START_FAILED:开机失败
STOPPING:关机中
STOP_FAILED:关机失败
STOPPED:已关机
IN_LAUNCHING_HOOK:扩容生命周期挂钩中
IN_TERMINATING_HOOK:缩容生命周期挂钩中
*/
LifeCycleState?: string;
/**
* 健康状态,取值范围如下:
HEALTHY:实例处于健康状态
UNHEALTHY:实例 ping 不可达
CLB_UNHEALTHY:CLB 监听的实例端口不健康
*/
HealthStatus?: string;
/**
* 是否加入缩容保护
*/
ProtectedFromScaleIn?: boolean;
/**
* 可用区
*/
Zone?: string;
/**
* 创建类型,取值包括AUTO_CREATION, MANUAL_ATTACHING。
*/
CreationType?: string;
/**
* 实例加入时间,按照ISO8601标准表示,并且使用UTC时间。
*/
AddTime?: string;
/**
* 实例类型
*/
InstanceType?: string;
/**
* 版本号
*/
VersionNumber?: number;
/**
* 伸缩组名称
*/
AutoScalingGroupName?: string;
/**
* 预热状态,取值如下:
WAITING_ENTER_WARMUP:等待进入预热
NO_NEED_WARMUP:无需预热
IN_WARMUP:预热中
AFTER_WARMUP:完成预热
*/
WarmupStatus?: string;
/**
* 置放群组id,仅支持指定一个。
*/
DisasterRecoverGroupIds?: Array;
}
/**
* DescribeAutoScalingInstances返回参数结构体
*/
export interface DescribeAutoScalingInstancesResponse {
/**
* 实例详细信息列表。
*/
AutoScalingInstanceSet?: Array;
/**
* 符合条件的实例数量。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 描述了实例的增强服务启用情况与其设置,如云安全,云监控,自动化助手等实例 Agent。
*/
export interface EnhancedService {
/**
* 开启云安全服务。若不指定该参数,则默认开启云安全服务。
*/
SecurityService?: RunSecurityServiceEnabled;
/**
* 开启云监控服务。若不指定该参数,则默认开启云监控服务。
*/
MonitorService?: RunMonitorServiceEnabled;
/**
* 该参数已废弃,查询时会返回空值,请勿使用。
* @deprecated
*/
AutomationService?: Array;
/**
* 开启自动化助手服务。若不指定该参数,则默认逻辑与CVM保持一致。注意:此字段可能返回 null,表示取不到有效值。
*/
AutomationToolsService?: RunAutomationServiceEnabled;
}
/**
* 描述了 “自动化助手” 服务相关的信息
*/
export interface RunAutomationServiceEnabled {
/**
* 是否开启[自动化助手](https://cloud.tencent.com/document/product/1340)服务。取值范围:
TRUE:表示开启自动化助手服务
FALSE:表示不开启自动化助手服务
注意:此字段可能返回 null,表示取不到有效值。
*/
Enabled?: boolean;
}
/**
* DeleteLaunchConfiguration返回参数结构体
*/
export interface DeleteLaunchConfigurationResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 描述了启动配置创建实例的IPv6地址公网可访问性,声明了IPv6地址公网使用计费模式,最大带宽等
*/
export interface IPv6InternetAccessible {
/**
* 网络计费模式。取值包括TRAFFIC_POSTPAID_BY_HOUR、BANDWIDTH_PACKAGE,默认取值为TRAFFIC_POSTPAID_BY_HOUR。查看当前账户类型可参考[账户类型说明](https://cloud.tencent.com/document/product/1199/49090#judge)。
IPv6对标准账户类型支持TRAFFIC_POSTPAID_BY_HOUR。
IPv6对传统账户类型支持BANDWIDTH_PACKAGE。
注意:此字段可能返回 null,表示取不到有效值。
*/
InternetChargeType?: string;
/**
* 公网出带宽上限,单位:Mbps。
默认值:0,此时不为IPv6分配公网带宽。不同机型、可用区、计费模式的带宽上限范围不一致,具体限制详见[公网带宽上限](https://cloud.tencent.com/document/product/213/12523)。
注意:此字段可能返回 null,表示取不到有效值。
*/
InternetMaxBandwidthOut?: number;
/**
* 带宽包ID。可通过[DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。
注意:此字段可能返回 null,表示取不到有效值。
*/
BandwidthPackageId?: string;
}
/**
* DescribeScheduledActions请求参数结构体
*/
export interface DescribeScheduledActionsRequest {
/**
* 按照一个或者多个定时任务ID查询。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 获取定时任务 ID。每次请求的实例的上限为100。参数不支持同时指定ScheduledActionIds和Filters。
*/
ScheduledActionIds?: Array;
/**
* 过滤条件。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 获取定时任务 ID,定时任务名称,伸缩组 ID。
scheduled-action-id - String - 是否必填:否 -(过滤条件)按照定时任务ID过滤。
scheduled-action-name - String - 是否必填:否 - (过滤条件) 按照定时任务名称过滤。
auto-scaling-group-id - String - 是否必填:否 - (过滤条件) 按照伸缩组ID过滤。
*/
Filters?: Array;
/**
* 偏移量,默认为0。关于Offset的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Limit?: number;
}
/**
* 描述了 “云安全” 服务相关的信息
*/
export interface RunSecurityServiceEnabled {
/**
* 是否开启[云安全](https://cloud.tencent.com/document/product/296)服务。取值范围:
TRUE:表示开启云安全服务
FALSE:表示不开启云安全服务
默认取值:TRUE。
*/
Enabled?: boolean;
}
/**
* 刷新批次关联实例,包含单个实例的刷新活动状态、对应伸缩活动等信息。
*/
export interface RefreshBatchRelatedInstance {
/**
* 实例 ID。
*/
InstanceId?: string;
/**
* 刷新实例状态。如果在刷新时实例被移出或销毁,状态会更新为 NOT_FOUND。取值如下:WAITING:待刷新INIT:初始化中RUNNING:刷新中FAILED:刷新失败CANCELLED:已取消SUCCESSFUL:刷新成功NOT_FOUND:实例不存在
*/
InstanceStatus?: string;
/**
* 实例刷新中最近一次伸缩活动 ID,可通过 DescribeAutoScalingActivities 接口查询。
需注意伸缩活动与实例刷新活动不同,一次实例刷新活动可能包括多次伸缩活动。
*/
LastActivityId?: string;
/**
* 实例刷新状态信息。
*/
InstanceStatusMessage?: string;
}
/**
* DeleteScheduledAction请求参数结构体
*/
export interface DeleteScheduledActionRequest {
/**
* 待删除的定时任务ID。可以通过调用接口 [DescribeScheduledActions](https://cloud.tencent.com/document/api/377/20450) ,取返回信息中的 ScheduledActionId 获取定时任务ID。
*/
ScheduledActionId: string;
}
/**
* DescribeAutoScalingActivities请求参数结构体
*/
export interface DescribeAutoScalingActivitiesRequest {
/**
* 按照一个或者多个伸缩活动ID查询。伸缩活动ID形如:`asa-5l2ejpfo`。每次请求的上限为100。参数不支持同时指定`ActivityIds`和`Filters`。
*/
ActivityIds?: Array;
/**
* 过滤条件。过滤字段取值范围如下:
- auto-scaling-group-id
- 按照【伸缩组ID】进行过滤。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
- 类型:String
- 必选:否
- 示例值: asg-kiju7yt5
- activity-status-code
- 按照【伸缩活动状态】进行过滤
- 类型:String
- 必选:否
- 可选项:
- INIT:初始化中
- RUNNING:运行中
- SUCCESSFUL:活动成功
- PARTIALLY_SUCCESSFUL:活动部分成功
- FAILED:活动失败
- CANCELLED:活动取消
- activity-type
- 按照【伸缩活动类型】进行过滤
- 类型:String
- 必选:否
- 可选项:
- SCALE_OUT:扩容活动
- SCALE_IN:缩容活动
- ATTACH_INSTANCES:添加实例
- REMOVE_INSTANCES:销毁实例
- DETACH_INSTANCES:移出实例
- TERMINATE_INSTANCES_UNEXPECTEDLY:实例在CVM控制台被销毁
- REPLACE_UNHEALTHY_INSTANCE:替换不健康实例
- START_INSTANCES:开启实例
- STOP_INSTANCES:关闭实例
- INVOKE_COMMAND:执行命令
- activity-id
- 按照【伸缩活动ID】进行过滤。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 获取伸缩活动ID。
- 类型:String
- 必选:否
- 示例值: asa-hy6tr4ed
每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。参数不支持同时指定`ActivityIds`和`Filters`。
*/
Filters?: Array;
/**
* 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Limit?: number;
/**
* 偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Offset?: number;
/**
* 伸缩活动最早的开始时间,如果指定了ActivityIds,此参数将被忽略。取值为`UTC`时间,按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ssZ`。注意:当前仅保存近两年的伸缩活动。
*/
StartTime?: string;
/**
* 伸缩活动最晚的结束时间,如果指定了ActivityIds,此参数将被忽略。取值为`UTC`时间,按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ssZ`。
*/
EndTime?: string;
}
/**
* ModifyDesiredCapacity请求参数结构体
*/
export interface ModifyDesiredCapacityRequest {
/**
* 伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 期望实例数,取值范围 [0,2000],同时需满足 MaxSize >= DesiredCapacity >= MinSize 。
*/
DesiredCapacity: number;
/**
* 最小实例数,取值范围为 [0,2000],同时需满足 MaxSize >= DesiredCapacity >= MinSize 。
*/
MinSize?: number;
/**
* 最大实例数,取值范围为 [0,2000],同时需满足 MaxSize >= DesiredCapacity >= MinSize 。
*/
MaxSize?: number;
}
/**
* CreateScheduledAction返回参数结构体
*/
export interface CreateScheduledActionResponse {
/**
* 定时任务ID
*/
ScheduledActionId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* StartInstanceRefresh返回参数结构体
*/
export interface StartInstanceRefreshResponse {
/**
* 刷新活动 ID。
*/
RefreshActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateLifecycleHook请求参数结构体
*/
export interface CreateLifecycleHookRequest {
/**
* 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。
通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 生命周期挂钩名称。名称仅支持中文、英文、数字、下划线(_)、短横线(-)、小数点(.),最大长度不能超128个字节。
*/
LifecycleHookName: string;
/**
* 进行生命周期挂钩的场景,取值范围如下:
INSTANCE_LAUNCHING: 扩容生命周期挂钩
INSTANCE_TERMINATING: 缩容生命周期挂钩
*/
LifecycleTransition: string;
/**
* 定义伸缩组在生命周期挂钩超时或 LifecycleCommand 执行失败时应采取的操作,取值范围如下:
CONTINUE: 默认值,表示继续执行扩缩容活动
ABANDON: 针对扩容挂钩,挂钩超时或 LifecycleCommand 执行失败的 CVM 实例会直接释放或移出;而针对缩容挂钩,会继续执行缩容活动。
*/
DefaultResult?: string;
/**
* 生命周期挂钩超时之前可以经过的最长时间(以秒为单位),范围从30到7200秒,默认值为300秒
*/
HeartbeatTimeout?: number;
/**
* 弹性伸缩向通知目标发送的附加信息,配置通知时使用,默认值为空字符串,最长不超过 1024 字符。NotificationMetadata 和 LifecycleCommand参数互斥,二者不可同时指定。
*/
NotificationMetadata?: string;
/**
* 通知目标。NotificationTarget和LifecycleCommand参数互斥,二者不可同时指定。
*/
NotificationTarget?: NotificationTarget;
/**
* 进行生命周期挂钩的场景类型,取值范围包括 NORMAL 和 EXTENSION,默认值为 NORMAL。
说明:设置为EXTENSION值,在 [AttachInstances](https://cloud.tencent.com/document/api/377/20441)、[DetachInstances](https://cloud.tencent.com/document/api/377/20436)、[RemoveInstaces](https://cloud.tencent.com/document/api/377/20431)、[StopAutoScalingInstances](https://cloud.tencent.com/document/api/377/40286)、[StartAutoScalingInstances](https://cloud.tencent.com/document/api/377/40287)、[StartInstanceRefresh](https://cloud.tencent.com/document/api/377/99172) 接口时会触发生命周期挂钩操作,值为NORMAL则不会在这些接口中触发生命周期挂钩。
*/
LifecycleTransitionType?: string;
/**
* 远程命令执行对象。通知相关参数(NotificationTarget、NotificationMetadata)与该参数互斥,二者不可同时指定。
*/
LifecycleCommand?: LifecycleCommand;
}
/**
* 描述定时任务的信息
*/
export interface ScheduledAction {
/**
* 定时任务ID。
*/
ScheduledActionId?: string;
/**
* 定时任务名称。
*/
ScheduledActionName?: string;
/**
* 定时任务所在伸缩组ID。
*/
AutoScalingGroupId?: string;
/**
* 定时任务的开始时间。取值为`北京时间`(UTC+8),按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ss+08:00`。
*/
StartTime?: string;
/**
* 定时任务的重复方式。定时任务中的[Recurrence参数限制](https://cloud.tencent.com/document/product/377/88119)为5个字段,由空格分开,结构为:分,小时,日期,月份,星期。
*/
Recurrence?: string;
/**
* 定时任务的结束时间。取值为`北京时间`(UTC+8),按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ss+08:00`。
*/
EndTime?: string;
/**
* 定时任务设置的最大实例数。
*/
MaxSize?: number;
/**
* 定时任务设置的期望实例数。
*/
DesiredCapacity?: number;
/**
* 定时任务设置的最小实例数。
*/
MinSize?: number;
/**
* 定时任务的创建时间。取值为标准`UTC`时间,按照`ISO8601`标准,格式:`YYYY-MM-DDThh:mm:ssZ`。
*/
CreatedTime?: string;
/**
* 定时任务的执行类型。取值范围:
CRONTAB:代表定时任务为重复执行。
ONCE:代表定时任务为单次执行。
*/
ScheduledType?: string;
/**
* 停用期望数更新。表示定时任务触发时期望实例数正常更新。
该值为 True 时,定时任务触发时不会主动修改期望实例数,但可能会因最大最小值机制修改期望实例数。
以下案例的前提都是停用期望数更新为 True:
- 定时任务触发时,原期望数为 5,定时任务将最小值改为 10,最大值改为 20,期望数改为 15,由于停用期望数更新,15不生效,但原期望数 5 小于最小值 10,最终新期望数为 10。
- 定时任务触发时,原期望数为 25,定时任务将最小值改为 10,最大值改为 20,期望数改为 15,由于停用期望数更新,15不生效,但原期望数 25 大于最大值 20,最终新期望数为 20。
- 定时任务触发时,原期望数为 13,定时任务将最小值改为 10,最大值改为 20,期望数改为 15,由于停用期望数更新,15不生效,期望数保持为 13 。
*/
DisableUpdateDesiredCapacity?: boolean;
}
/**
* ModifyLifecycleHook请求参数结构体
*/
export interface ModifyLifecycleHookRequest {
/**
* 生命周期挂钩ID。可以通过调用接口 [DescribeLifecycleHooks](https://cloud.tencent.com/document/api/377/34452) ,取返回信息中的 LifecycleHookId 获取生命周期挂钩ID。
*/
LifecycleHookId: string;
/**
* 生命周期挂钩名称。名称仅支持中文、英文、数字、下划线(_)、短横线(-)、小数点(.),最大长度不能超128。
*/
LifecycleHookName?: string;
/**
* 进入生命周期挂钩场景,取值范围如下:
* INSTANCE_LAUNCHING: 扩容生命周期挂钩
* INSTANCE_TERMINATING: 缩容生命周期挂钩
*/
LifecycleTransition?: string;
/**
* 定义伸缩组在生命周期挂钩超时或 LifecycleCommand 执行失败时应采取的操作,取值范围如下:
* CONTINUE: 默认值,表示继续执行扩缩容活动
* ABANDON: 针对扩容挂钩,挂钩超时或 LifecycleCommand 执行失败的 CVM 实例会直接释放或移出;而针对缩容挂钩,会继续执行缩容活动。
*/
DefaultResult?: string;
/**
* 生命周期挂钩超时之前可以经过的最长时间(以秒为单位),范围从 30 到 7200 秒。
*/
HeartbeatTimeout?: number;
/**
* 弹性伸缩向通知目标发送的附加信息。NotificationMetadata 与 LifecycleCommand互斥,二者不可同时指定。
*/
NotificationMetadata?: string;
/**
* 进行生命周期挂钩的场景类型,取值范围包括`NORMAL`和 `EXTENSION`。说明:设置为`EXTENSION`值,在AttachInstances、DetachInstances、RemoveInstances 接口时会触发生命周期挂钩操作,值为`NORMAL`则不会在这些接口中触发生命周期挂钩。
*/
LifecycleTransitionType?: string;
/**
* 通知目标信息。NotificationTarget 与 LifecycleCommand互斥,二者不可同时指定。
*/
NotificationTarget?: NotificationTarget;
/**
* 远程命令执行对象。通知参数 NotificationMetadata、NotificationTarget 与 LifecycleCommand互斥,不可同时指定。
*/
LifecycleCommand?: LifecycleCommand;
}
/**
* UpgradeLifecycleHook请求参数结构体
*/
export interface UpgradeLifecycleHookRequest {
/**
* 生命周期挂钩ID。可以通过调用接口 DescribeLifecycleHooks ,取返回信息中的 LifecycleHookId 获取生命周期挂钩ID。
*/
LifecycleHookId: string;
/**
* 生命周期挂钩名称。名称仅支持中文、英文、数字、下划线(_)、短横线(-)、小数点(.),最大长度不能超128个字符。
*/
LifecycleHookName: string;
/**
* 进行生命周期挂钩的场景,取值范围如下: INSTANCE_LAUNCHING: 扩容生命周期挂钩 INSTANCE_TERMINATING: 缩容生命周期挂钩
*/
LifecycleTransition: string;
/**
* 定义伸缩组在生命周期挂钩超时或 LifecycleCommand 执行失败时应采取的操作,取值范围是如下: CONTINUE: 默认值,表示继续执行扩缩容活动 ABANDON: 针对扩容挂钩,挂钩超时或 LifecycleCommand 执行失败的 CVM 实例会直接释放或移出;而针对缩容挂钩,会继续执行缩容活动。
*/
DefaultResult?: string;
/**
* 生命周期挂钩超时之前可以经过的最长时间(以秒为单位),范围从30到7200秒,默认值为300秒
*/
HeartbeatTimeout?: number;
/**
* 弹性伸缩向通知目标发送的附加信息,配置通知时使用,默认值为空字符串。NotificationMetadata 和 LifecycleCommand参数互斥,二者不可同时指定。
*/
NotificationMetadata?: string;
/**
* 通知目标。NotificationTarget和LifecycleCommand参数互斥,二者不可同时指定。
*/
NotificationTarget?: NotificationTarget;
/**
* 进行生命周期挂钩的场景类型,取值范围包括NORMAL 和 EXTENSION。说明:设置为EXTENSION值,在AttachInstances、DetachInstances、RemoveInstaces接口时会触发生命周期挂钩操作,值为NORMAL则不会在这些接口中触发生命周期挂钩。
*/
LifecycleTransitionType?: string;
/**
* 远程命令执行对象。通知参数 NotificationMetadata、NotificationTarget 与 LifecycleCommand 互斥,不可同时指定。
*/
LifecycleCommand?: LifecycleCommand;
}
/**
* CompleteLifecycleAction返回参数结构体
*/
export interface CompleteLifecycleActionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ScaleOutInstances返回参数结构体
*/
export interface ScaleOutInstancesResponse {
/**
* 伸缩活动ID。
*/
ActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例刷新设置。
*/
export interface RefreshSettings {
/**
* 滚动更新设置参数。RefreshMode 为滚动更新该参数必须填写。
*/
RollingUpdateSettings: RollingUpdateSettings;
/**
* 实例后端服务健康状态检查,默认为 FALSE。仅针对绑定应用型负载均衡器的伸缩组生效,开启该检查后,如刷新后实例未通过检查,负载均衡器端口权重始终为 0,且标记为刷新失败。取值范围如下:TRUE:开启检查FALSE:不开启检查
*/
CheckInstanceTargetHealth?: boolean;
/**
* 实例后端服务健康状态检查的超时时间,单位为秒,取值范围[60,7200],默认时间1800秒。仅在CheckInstanceTargetHealth参数开启后生效,若实例健康检查超时,则标记为刷新失败。
*/
CheckInstanceTargetHealthTimeout?: number;
}
/**
* >描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等
> * 若存在多个`Filter`时,`Filter`间的关系为逻辑与(`AND`)关系。
> * 若同一个`Filter`存在多个`Values`,同一`Filter`下`Values`间的关系为逻辑或(`OR`)关系。
>
> 以[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)接口的`Filter`为例。若我们需要查询可用区(`zone`)为广州一区 ***并且*** 实例计费模式(`instance-charge-type`)为包年包月 ***或者*** 按量计费的实例时,可如下实现:
```
Filters.0.Name=zone
&Filters.0.Values.0=ap-guangzhou-1
&Filters.1.Name=instance-charge-type
&Filters.1.Values.0=PREPAID
&Filters.1.Values.1=POSTPAID_BY_HOUR
```
*/
export interface Filter {
/**
* 需要过滤的字段。
*/
Name: string;
/**
* 字段的过滤值。
*/
Values: Array;
}
/**
* DescribeLifecycleHooks请求参数结构体
*/
export interface DescribeLifecycleHooksRequest {
/**
* 按照一个或者多个生命周期挂钩ID查询。生命周期挂钩ID形如:`ash-8azjzxcl`。每次请求的上限为100。参数不支持同时指定`LifecycleHookIds`和`Filters`。
*/
LifecycleHookIds?: Array;
/**
* 过滤条件。
lifecycle-hook-id - String - 是否必填:否 -(过滤条件)按照生命周期挂钩ID过滤。
lifecycle-hook-name - String - 是否必填:否 -(过滤条件)按照生命周期挂钩名称过滤。
auto-scaling-group-id - String - 是否必填:否 -(过滤条件)按照伸缩组ID过滤。
每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。参数不支持同时指定`LifecycleHookIds `和`Filters`。
*/
Filters?: Array;
/**
* 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Limit?: number;
/**
* 偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Offset?: number;
}
/**
* 服务设置
*/
export interface ServiceSettings {
/**
* 开启监控不健康替换服务。若开启则对于云监控标记为不健康的实例,弹性伸缩服务会进行替换。若不指定该参数,则默认为 False。
*/
ReplaceMonitorUnhealthy?: boolean;
/**
* 取值范围:
CLASSIC_SCALING:经典方式,使用创建、销毁实例来实现扩缩容;
WAKE_UP_STOPPED_SCALING:扩容优先开机。扩容时优先对已关机的实例执行开机操作,若开机后实例数仍低于期望实例数,则创建实例,缩容仍采用销毁实例的方式。用户可以使用StopAutoScalingInstances接口来关闭伸缩组内的实例。监控告警触发的扩容仍将创建实例
默认取值:CLASSIC_SCALING
*/
ScalingMode?: string;
/**
* 开启负载均衡不健康替换服务。若开启则对于负载均衡健康检查判断不健康的实例,弹性伸缩服务会进行替换。若不指定该参数,则默认为 False。
*/
ReplaceLoadBalancerUnhealthy?: boolean;
/**
* 不健康替换服务的替换模式。取值范围:
RECREATE:重建实例替代原有不健康实例;
RESET:对原有不健康实例进行重装系统操作,可保持数据盘、内网IP、实例id等信息不发生变化,实例登录设置、主机名、增强服务和 UserData 与当前启动配置保持一致。
默认取值:RECREATE
*/
ReplaceMode?: string;
/**
* 自动更新实例标签。默认取值为 False,配置后如伸缩组标签发生更新,会同步更新(同步更新仅支持新增、修改标签,暂不支持删除标签)伸缩组内运行中状态实例的标签,同步更新非立即生效,存在一定延迟。
*/
AutoUpdateInstanceTags?: boolean;
/**
* 期望实例数同步最大最小值。默认值为 False。该参数仅对修改伸缩组接口未传入期望数的场景生效。
True: 修改最大值或最小值时,如与当前期望数存在冲突,则同步调整期望数。例如修改时传入最小值 2,当前期望数为 1,则同步调整期望数为 2。
False: 修改最大值或最小值时,如与当前期望数存在冲突,报错提示不允许修改。
*/
DesiredCapacitySyncWithMaxMinSize?: boolean;
/**
* 优先缩容不健康实例。若开启,缩容时会优先选择不健康实例。默认值为 False。
*/
PriorityScaleInUnhealthy?: boolean;
}
/**
* CreateAutoScalingGroup返回参数结构体
*/
export interface CreateAutoScalingGroupResponse {
/**
* 伸缩组ID
*/
AutoScalingGroupId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 负载均衡器目标属性
*/
export interface TargetAttribute {
/**
* 端口。取值范围为 [1,65535]。作为入参时,该参数必填。
*/
Port: number;
/**
* 权重。取值范围为 [0,100]。作为入参时,该参数必填。
*/
Weight: number;
}
/**
* ModifyNotificationConfiguration返回参数结构体
*/
export interface ModifyNotificationConfigurationResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 描述了实例登录相关配置与信息,出于安全性考虑,不会描述敏感信息。
*/
export interface LimitedLoginSettings {
/**
* 密钥ID列表。
*/
KeyIds?: Array;
}
/**
* DescribeLifecycleHooks返回参数结构体
*/
export interface DescribeLifecycleHooksResponse {
/**
* 生命周期挂钩数组
*/
LifecycleHookSet?: Array;
/**
* 总体数量
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateScalingPolicy请求参数结构体
*/
export interface CreateScalingPolicyRequest {
/**
* 伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 告警策略名称,在您账号中必须唯一。名称长度不能超过60,名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点。
*/
ScalingPolicyName: string;
/**
* 告警触发策略类型,默认类型为SIMPLE。取值范围:
SIMPLE:简单策略
TARGET_TRACKING:目标追踪策略
*/
ScalingPolicyType?: string;
/**
* 告警触发后,期望实例数修改方式,仅适用于简单策略,在简单策略场景下必填。取值范围:
CHANGE_IN_CAPACITY:增加或减少若干期望实例数
EXACT_CAPACITY:调整至指定期望实例数
PERCENT_CHANGE_IN_CAPACITY:按百分比调整期望实例数
*/
AdjustmentType?: string;
/**
* 告警触发后,期望实例数的调整值,仅适用于简单策略,在简单策略场景下必填。
当 AdjustmentType 为 CHANGE_IN_CAPACITY 时,AdjustmentValue 为正数表示告警触发后增加实例,为负数表示告警触发后减少实例
当 AdjustmentType 为 EXACT_CAPACITY 时,AdjustmentValue 的值即为告警触发后新的期望实例数,需要大于或等于0
当 AdjustmentType 为 PERCENT_CHANGE_IN_CAPACITY 时,AdjusmentValue 为正数表示告警触发后按百分比增加实例,为负数表示告警触发后按百分比减少实例,单位是:%。
*/
AdjustmentValue?: number;
/**
* 冷却时间,单位为秒,仅适用于简单策略。默认冷却时间300秒。
*/
Cooldown?: number;
/**
* 告警监控指标,仅适用于简单策略,在简单策略场景下必填。
*/
MetricAlarm?: MetricAlarm;
/**
* 预定义监控项,仅适用于目标追踪策略,在目标追踪策略场景下必填。取值范围:
ASG_AVG_CPU_UTILIZATION:平均CPU使用率
ASG_AVG_LAN_TRAFFIC_OUT:平均内网出带宽
ASG_AVG_LAN_TRAFFIC_IN:平均内网入带宽
ASG_AVG_WAN_TRAFFIC_OUT:平均外网出带宽
ASG_AVG_WAN_TRAFFIC_IN:平均外网入带宽
*/
PredefinedMetricType?: string;
/**
* 目标值,仅适用于目标追踪策略,在目标追踪策略场景下必填。
ASG_AVG_CPU_UTILIZATION:[1, 100),单位:%
ASG_AVG_LAN_TRAFFIC_OUT:>0,单位:Mbps
ASG_AVG_LAN_TRAFFIC_IN:>0,单位:Mbps
ASG_AVG_WAN_TRAFFIC_OUT:>0,单位:Mbps
ASG_AVG_WAN_TRAFFIC_IN:>0,单位:Mbps
*/
TargetValue?: number;
/**
* 实例预热时间,单位为秒,仅适用于目标追踪策略。取值范围为0-3600,默认预热时间300秒。
*/
EstimatedInstanceWarmup?: number;
/**
* 是否禁用缩容,仅适用于目标追踪策略,默认值为 false。取值范围:
true:目标追踪策略仅触发扩容
false:目标追踪策略触发扩容和缩容
*/
DisableScaleIn?: boolean;
/**
* 此参数已不再生效,请使用[创建通知](https://cloud.tencent.com/document/api/377/33185)。
通知组ID,即为用户组ID集合。
*/
NotificationUserGroupIds?: Array;
}
/**
* ResumeInstanceRefresh请求参数结构体
*/
export interface ResumeInstanceRefreshRequest {
/**
* 伸缩组ID。可通过如下方式获取:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。
通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 刷新活动ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ,取返回信息中的 RefreshActivityId 获取实例刷新活动ID。
*/
RefreshActivityId: string;
/**
* 当前批次刷新失败实例的恢复方式,如不存在失败实例,该参数无效。默认值为RETRY,取值范围如下:RETRY: 重试当前批次刷新失败实例CONTINUE: 跳过当前批次刷新失败实例
*/
ResumeMode?: string;
}
/**
* DescribeAutoScalingAdvices请求参数结构体
*/
export interface DescribeAutoScalingAdvicesRequest {
/**
* 待查询的伸缩组列表,上限100。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupIds: Array;
}
/**
* DeleteNotificationConfiguration请求参数结构体
*/
export interface DeleteNotificationConfigurationRequest {
/**
* 待删除的通知ID,目前为必填参数。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeNotificationConfigurations](https://cloud.tencent.com/document/api/377/33183) ,取返回信息中的 AutoScalingNotificationId 获取通知ID。
*/
AutoScalingNotificationId?: string;
}
/**
* DescribeLaunchConfigurations请求参数结构体
*/
export interface DescribeLaunchConfigurationsRequest {
/**
* 按照一个或者多个启动配置ID查询。启动配置ID形如:`asc-ouy1ax38`。每次请求的上限为100。参数不支持同时指定`LaunchConfigurationIds`和`Filters`
*/
LaunchConfigurationIds?: Array;
/**
* 过滤条件。
launch-configuration-id - String - 是否必填:否 -(过滤条件)按照启动配置ID过滤。
launch-configuration-name - String - 是否必填:否 -(过滤条件)按照启动配置名称过滤。
vague-launch-configuration-name - String - 是否必填:否 -(过滤条件)按照启动配置名称模糊搜索。
tag-key - String - 是否必填:否 -(过滤条件)按照标签键进行过滤。
tag-value - String - 是否必填:否 -(过滤条件)按照标签值进行过滤。
tag:tag-key - String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例3
每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。参数不支持同时指定`LaunchConfigurationIds`和`Filters`。
*/
Filters?: Array;
/**
* 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Limit?: number;
/**
* 偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Offset?: number;
}
/**
* 通知目标
*/
export interface NotificationTarget {
/**
* 目标类型,取值范围包括`CMQ_QUEUE`、`CMQ_TOPIC`、`TDMQ_CMQ_QUEUE`、`TDMQ_CMQ_TOPIC`。
CMQ_QUEUE,指腾讯云消息队列-队列模型,对应产品已下线,[建议切换](https://cloud.tencent.com/document/product/1496/83970) TDMQ_CMQ_QUEUE 使用。
CMQ_TOPIC,指腾讯云消息队列-主题模型,对应产品已下线,[建议切换](https://cloud.tencent.com/document/product/1496/83970) TDMQ_CMQ_TOPIC 使用。
TDMQ_CMQ_QUEUE,指腾讯云 TDMQ 消息队列-队列模型。
TDMQ_CMQ_TOPIC,指腾讯云 TDMQ 消息队列-主题模型。
*/
TargetType: string;
/**
* 队列名称,如果`TargetType`取值为`CMQ_QUEUE` 或 `TDMQ_CMQ_QUEUE`,则本字段必填。
*/
QueueName?: string;
/**
* 主题名称,如果`TargetType`取值为`CMQ_TOPIC` 或 `TDMQ_CMQ_TOPIC`,则本字段必填。
*/
TopicName?: string;
}
/**
* ModifyLoadBalancerTargetAttributes请求参数结构体
*/
export interface ModifyLoadBalancerTargetAttributesRequest {
/**
* 伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 需修改目标规则属性的负载均衡器列表,列表长度上限为100。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
*/
ForwardLoadBalancers: Array;
}
/**
* RollbackInstanceRefresh请求参数结构体
*/
export interface RollbackInstanceRefreshRequest {
/**
* 伸缩组ID。可以通过以下方式获取可用的伸缩组ID:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。
通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 刷新设置。
*/
RefreshSettings: RefreshSettings;
/**
* 原始刷新活动 ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ,取返回信息中的 OriginRefreshActivityId 获取原始刷新活动ID。
*/
OriginRefreshActivityId: string;
/**
* 刷新模式,目前仅支持滚动更新,默认值为 ROLLING_UPDATE_RESET。
*/
RefreshMode?: string;
}
/**
* StartInstanceRefresh请求参数结构体
*/
export interface StartInstanceRefreshRequest {
/**
* 伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 刷新设置。
*/
RefreshSettings: RefreshSettings;
/**
* 刷新模式。默认值为 ROLLING_UPDATE_RESET,取值范围:
ROLLING_UPDATE_RESET:重装系统进行滚动更新
ROLLING_UPDATE_REPLACE:新建实例替换进行滚动更新,该模式暂不支持回滚接口
*/
RefreshMode?: string;
}
/**
* DeleteAutoScalingGroup返回参数结构体
*/
export interface DeleteAutoScalingGroupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 生命周期挂钩动作的执行结果信息。
*/
export interface LifecycleActionResultInfo {
/**
* 生命周期挂钩标识。
*/
LifecycleHookId: string;
/**
* 实例标识。
*/
InstanceId: string;
/**
* 执行活动ID。可通过TAT的[查询执行活动](https://cloud.tencent.com/document/api/1340/52679)API查询具体的执行结果。
*/
InvocationId: string;
/**
* 命令调用的结果,表示执行TAT命令是否成功。
SUCCESSFUL 命令调用成功,不代表命令执行成功,执行的具体情况可根据InvocationId进行查询
FAILED 命令调用失败
NONE
*/
InvokeCommandResult: string;
/**
* 通知的结果,表示通知CMQ/TDMQ是否成功。
SUCCESSFUL 通知成功
FAILED 通知失败
NONE
*/
NotificationResult: string;
/**
* 生命周期挂钩动作的执行结果,取值包括 CONTINUE、ABANDON。
*/
LifecycleActionResult: string;
/**
* 结果的原因。
HEARTBEAT_TIMEOUT 由于心跳超时,结果根据DefaultResult设置。
NOTIFICATION_FAILURE 由于发送通知失败,结果根据DefaultResult设置。
CALL_INTERFACE 调用了接口CompleteLifecycleAction设置结果。
ANOTHER_ACTION_ABANDON 另一个生命周期操作的结果已设置为“ABANDON”。
COMMAND_CALL_FAILURE 由于命令调用失败,结果根据DefaultResult设置。
COMMAND_EXEC_FINISH 命令执行完成。
COMMAND_EXEC_FAILURE 由于命令执行失败,结果根据DefaultResult设置。
COMMAND_EXEC_RESULT_CHECK_FAILURE 由于命令结果检查失败,结果根据DefaultResult设置。
*/
ResultReason: string;
}
/**
* 伸缩组简明信息。
*/
export interface AutoScalingGroupAbstract {
/**
* 伸缩组ID。
*/
AutoScalingGroupId?: string;
/**
* 伸缩组名称。
*/
AutoScalingGroupName?: string;
}
/**
* EnableAutoScalingGroup请求参数结构体
*/
export interface EnableAutoScalingGroupRequest {
/**
* 伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
}
/**
* StopInstanceRefresh请求参数结构体
*/
export interface StopInstanceRefreshRequest {
/**
* 伸缩组ID。可以通过以下方式获取可用的伸缩组ID:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。
通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 刷新活动ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ,取返回信息中的 RefreshActivityId 获取实例刷新活动ID。
*/
RefreshActivityId: string;
}
/**
* 弹性伸缩告警指标
*/
export interface MetricAlarm {
/**
* 比较运算符,可选值:
GREATER_THAN:大于GREATER_THAN_OR_EQUAL_TO:大于或等于LESS_THAN:小于 LESS_THAN_OR_EQUAL_TO:小于或等于 EQUAL_TO:等于 NOT_EQUAL_TO:不等于
*/
ComparisonOperator: string;
/**
* 指标名称,可选字段如下:
CPU_UTILIZATION:CPU利用率MEM_UTILIZATION:内存利用率LAN_TRAFFIC_OUT:内网出带宽LAN_TRAFFIC_IN:内网入带宽WAN_TRAFFIC_OUT:外网出带宽WAN_TRAFFIC_IN:外网入带宽TCP_CURR_ESTAB:TCP连接数当前外网出入带宽属于 CLB 类指标,其他指标属于 CVM 类指标。修改指标名称时不允许跨类别修改。
*/
MetricName: string;
/**
* 告警阈值:
CPU_UTILIZATION:[1, 100],单位:%MEM_UTILIZATION:[1, 100],单位:%LAN_TRAFFIC_OUT:>0,单位:Mbps LAN_TRAFFIC_IN:>0,单位:MbpsWAN_TRAFFIC_OUT:>0,单位:MbpsWAN_TRAFFIC_IN:>0,单位:MbpsTCP_CURR_ESTAB:>0, 单位:Count
*/
Threshold: number;
/**
* 时间周期,单位:秒,取值枚举值为60、300。
*/
Period: number;
/**
* 重复次数。取值范围 [1, 10]
*/
ContinuousTime: number;
/**
* 统计类型,可选字段如下:
AVERAGE:平均值MAXIMUM:最大值MINIMUM:最小值
默认取值:AVERAGE
*/
Statistic?: string;
/**
* 精确告警阈值,本参数不作为入参输入,仅用作查询接口出参:
CPU_UTILIZATION:(0, 100],单位:%MEM_UTILIZATION:(0, 100],单位:%LAN_TRAFFIC_OUT:>0,单位:Mbps LAN_TRAFFIC_IN:>0,单位:MbpsWAN_TRAFFIC_OUT:>0,单位:MbpsWAN_TRAFFIC_IN:>0,单位:MbpsTCP_CURR_ESTAB:>0, 单位:Count
*/
PreciseThreshold?: number;
}
/**
* 实例刷新活动。
*/
export interface RefreshActivity {
/**
* 伸缩组 ID。
*/
AutoScalingGroupId?: string;
/**
* 刷新活动 ID。
*/
RefreshActivityId?: string;
/**
* 原始刷新活动ID,仅在回滚刷新活动中存在。
*/
OriginRefreshActivityId?: string;
/**
* 刷新批次信息列表。
*/
RefreshBatchSet?: Array;
/**
* 刷新模式。取值范围如下:
ROLLING_UPDATE_RESET:重装系统进行滚动更新
ROLLING_UPDATE_REPLACE:新建实例替换进行滚动更新,该模式暂不支持回滚接口
*/
RefreshMode?: string;
/**
* 实例更新设置参数。
*/
RefreshSettings?: RefreshSettings;
/**
* 刷新活动类型。取值如下:
NORMAL:正常刷新活动
ROLLBACK:回滚刷新活动
*/
ActivityType?: string;
/**
* 刷新活动状态。取值如下:
INIT:初始化中
RUNNING:运行中
SUCCESSFUL:活动成功
FAILED_PAUSE:因刷新批次失败暂停
AUTO_PAUSE:因暂停策略自动暂停
MANUAL_PAUSE:手动暂停
CANCELLED:活动取消
FAILED:活动失败
*/
Status?: string;
/**
* 当前刷新批次序号。例如,2 表示当前活动正在刷新第二批次的实例。
*/
CurrentRefreshBatchNum?: number;
/**
* 刷新活动开始时间,为标准 `UTC` 时间,格式形如 `YYYY-MM-DDTHH:mm:ssZ`。
注意:此字段可能返回 null,表示取不到有效值。
*/
StartTime?: string;
/**
* 刷新活动结束时间,为标准 `UTC` 时间,格式形如 `YYYY-MM-DDTHH:mm:ssZ`。
注意:此字段可能返回 null,表示取不到有效值。
*/
EndTime?: string;
/**
* 刷新活动创建时间,为标准 `UTC` 时间,格式形如 `YYYY-MM-DDTHH:mm:ssZ`。
*/
CreatedTime?: string;
}
/**
* DescribeNotificationConfigurations请求参数结构体
*/
export interface DescribeNotificationConfigurationsRequest {
/**
* 按照一个或者多个通知ID查询,列表长度上限为100。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 获取通知ID。参数不支持同时指定`AutoScalingNotificationIds`和`Filters`。
*/
AutoScalingNotificationIds?: Array;
/**
* 过滤条件。
auto-scaling-notification-id - String - 是否必填:否 -(过滤条件)按照通知ID过滤。
auto-scaling-group-id - String - 是否必填:否 -(过滤条件)按照伸缩组ID过滤。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。参数不支持同时指定`AutoScalingNotificationIds`和`Filters`。
*/
Filters?: Array;
/**
* 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Limit?: number;
/**
* 偏移量,默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Offset?: number;
}
/**
* ScaleInInstances请求参数结构体
*/
export interface ScaleInInstancesRequest {
/**
* 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。
通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 希望缩容的实例数量。该参数的静态取值范围是 [1,2000],同时该参数不得大于期望数与最小值的差值。例如伸缩组期望数为 100,最小值为 20,此时可取值范围为 [1,80]。
*/
ScaleInNumber: number;
}
/**
* 生命周期挂钩
*/
export interface LifecycleHook {
/**
* 生命周期挂钩ID
*/
LifecycleHookId?: string;
/**
* 生命周期挂钩名称
*/
LifecycleHookName?: string;
/**
* 伸缩组ID
*/
AutoScalingGroupId?: string;
/**
* 定义伸缩组在生命周期挂钩超时或 LifecycleCommand 执行失败时应采取的操作,取值范围如下:
- CONTINUE: 默认值,表示继续执行扩缩容活动
- ABANDON: 针对扩容挂钩,挂钩超时或 LifecycleCommand 执行失败的 CVM 实例会直接释放或移出;而针对缩容挂钩,会继续执行缩容活动
*/
DefaultResult?: string;
/**
* 生命周期挂钩超时等待时间(以秒为单位),范围从 30 到 7200 秒。
*/
HeartbeatTimeout?: number;
/**
* 生命周期挂钩场景,取值范围如下:
- INSTANCE_LAUNCHING: 扩容生命周期挂钩
- INSTANCE_TERMINATING: 缩容生命周期挂钩
*/
LifecycleTransition?: string;
/**
* 通知目标的附加信息
*/
NotificationMetadata?: string;
/**
* 创建时间,采用 UTC 标准计时
*/
CreatedTime?: string;
/**
* 通知目标
*/
NotificationTarget?: NotificationTarget;
/**
* 进行生命周期挂钩的场景类型,取值范围包括 NORMAL 和 EXTENSION,默认值为 NORMAL。
说明:设置为EXTENSION值,在AttachInstances、DetachInstances、RemoveInstances 接口时会触发生命周期挂钩操作,值为NORMAL则不会在这些接口中触发生命周期挂钩。
*/
LifecycleTransitionType?: string;
/**
* 远程命令执行对象
*/
LifecycleCommand?: LifecycleCommand;
}
/**
* 应用型负载均衡器
*/
export interface ForwardLoadBalancer {
/**
* 负载均衡器ID。作为入参时,该参数必填。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
*/
LoadBalancerId: string;
/**
* 负载均衡监听器 ID。作为入参时,该参数必填。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
*/
ListenerId: string;
/**
* 目标规则属性列表。作为入参时,该参数必填。
*/
TargetAttributes: Array;
/**
* 转发规则ID,注意:针对七层监听器此参数必填。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。
*/
LocationId?: string;
/**
* 负载均衡实例所属地域,默认取AS服务所在地域。格式与公共参数Region相同,如:"ap-guangzhou"。
*/
Region?: string;
}
/**
* ClearLaunchConfigurationAttributes请求参数结构体
*/
export interface ClearLaunchConfigurationAttributesRequest {
/**
* 启动配置ID。可通过如下方式获取:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/config) 查询启动配置ID。
通过调用接口 [DescribeLaunchConfigurations](https://cloud.tencent.com/document/api/377/20445) ,取返回信息中的 LaunchConfigurationId 获取启动配置ID。
*/
LaunchConfigurationId: string;
/**
* 是否清空数据盘信息,非必填,默认为 false。
填 true 代表清空“数据盘”信息,清空后基于此新创建的云主机将不含有任何数据盘。
*/
ClearDataDisks?: boolean;
/**
* 是否清空云服务器主机名相关设置信息,非必填,默认为 false。
填 true 代表清空主机名设置信息,清空后基于此新创建的云主机将不设置主机名。
*/
ClearHostNameSettings?: boolean;
/**
* 是否清空云服务器实例名相关设置信息,非必填,默认为 false。
填 true 代表清空主机名设置信息,清空后基于此新创建的云主机将按照“as-{{ 伸缩组AutoScalingGroupName }}”进行设置。
*/
ClearInstanceNameSettings?: boolean;
/**
* 是否清空置放群组信息,非必填,默认为 false。
填 true 代表清空置放群组信息,清空后基于此新创建的云主机将不指定任何置放群组。
*/
ClearDisasterRecoverGroupIds?: boolean;
/**
* 是否清空实例标签列表,非必填,默认为 false。
填 true 代表清空实例标签列表,清空后基于此新创建的云主机将不会绑定列表中的标签。
*/
ClearInstanceTags?: boolean;
/**
* 是否清空 MetaData,非必填,默认为 false。填 true 代表清空 MetaData,清空后基于此新创建的云主机将不会关联自定义的 Metadata。
*/
ClearMetadata?: boolean;
}
/**
* 实例名称序号相关设置。
*/
export interface InstanceNameIndexSettings {
/**
* 是否开启实例创建序号,默认不开启。取值范围:
TRUE:表示开启实例创建序号; FALSE:表示不开启实例创建序号
注意:此字段可能返回 null,表示取不到有效值。
*/
Enabled?: boolean;
/**
* 初始序号。取值范围与 IndexLength 参数有关:- IndexLength 为 0 时,取值范围为 [0, 99999999]。- IndexLength 为 [1, 8] 时,取值范围为 [0, 10^IndexLength-1],最大值即为指定位数的最大数字。初始序号默认值如下:- 首次启用递增序号:初始序号默认值为 0 ( 展示位数与 IndexLength 有关,例如 IndexLength 为 4,展示值为 0000)- 非首次开启递增序号:顺延之前的递增序号,例如上次使用递增至序号 069,则新的初始序号默认值为 070。注意:修改初始序号可能会造成伸缩组内序号重复。
注意:此字段可能返回 null,表示取不到有效值。
*/
BeginIndex?: number;
/**
* 递增序号长度,默认为0,表示不指定序号长度。 取值范围:0-8,最大为整数8。 - 长度设置为3,序号展示形式为:000、001、002 ... 010、011 ... 100 ... 999,序号上限为999- 长度设置为0,序号展示形式为:0、1、2 ... 10、11 ... 100 ... 1000 ...10000 ... 99999999,序号上限为99999999注意:递增序号持续超出上限会导致扩容失败,请不要设置过小的递增序号长度。
*/
IndexLength?: number;
}
/**
* DeleteAutoScalingGroup请求参数结构体
*/
export interface DeleteAutoScalingGroupRequest {
/**
* 伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
}
/**
* 伸缩组配置建议。
*/
export interface AutoScalingAdvice {
/**
* 伸缩组ID。
*/
AutoScalingGroupId?: string;
/**
* 伸缩组警告级别。取值范围:
NORMAL:正常
WARNING:警告级别
CRITICAL:严重级别
*/
Level?: string;
/**
* 伸缩组配置建议集合。
*/
Advices?: Array;
}
/**
* StartAutoScalingInstances请求参数结构体
*/
export interface StartAutoScalingInstancesRequest {
/**
* 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。
通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 待开启的CVM实例ID列表。可以通过以下方式获取可用的实例ID:
通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。
通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。
*/
InstanceIds: Array;
}
/**
* AttachInstances请求参数结构体
*/
export interface AttachInstancesRequest {
/**
* 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。
通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* CVM实例ID列表。可以通过以下方式获取可用的实例ID:
通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。
通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。
*/
InstanceIds: Array;
}
/**
* StopInstanceRefresh返回参数结构体
*/
export interface StopInstanceRefreshResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AttachLoadBalancers请求参数结构体
*/
export interface AttachLoadBalancersRequest {
/**
* 伸缩组ID。可通过登录 控制台 或调用接口 DescribeAutoScalingGroups ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 传统型负载均衡器ID列表,每个伸缩组绑定传统型负载均衡器数量上限为20,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个。可以通过 DescribeLoadBalancers 接口获取。
*/
LoadBalancerIds?: Array;
/**
* 负载均衡器列表,每个伸缩组绑定应用型负载均衡器数量上限为100,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个。可以通过 DescribeLoadBalancers 接口获取。
*/
ForwardLoadBalancers?: Array;
}
/**
* 竞价混合模式下,各计费类型实例的分配策略。包括按量计费实例和竞价计费实例。
*/
export interface SpotMixedAllocationPolicy {
/**
* 混合模式下,基础容量的大小,基础容量部分固定为按量计费实例。默认值 0,最大不可超过伸缩组的最大实例数。
注意:此字段可能返回 null,表示取不到有效值。
*/
BaseCapacity?: number;
/**
* 超出基础容量部分,按量计费实例所占的比例。取值范围 [0, 100],0 代表超出基础容量的部分仅生产竞价实例,100 代表仅生产按量实例,默认值为 70。按百分比计算按量实例数时,向上取整。
比如,总期望实例数取 3,基础容量取 1,超基础部分按量百分比取 1,则最终按量 2 台(1 台来自基础容量,1 台按百分比向上取整得到),竞价 1台。
注意:此字段可能返回 null,表示取不到有效值。
*/
OnDemandPercentageAboveBaseCapacity?: number;
/**
* 混合模式下,竞价实例的分配策略。取值包括 COST_OPTIMIZED 和 CAPACITY_OPTIMIZED,默认取 COST_OPTIMIZED。
COST_OPTIMIZED,成本优化策略。对于启动配置内的所有机型,按照各机型在各可用区的每核单价由小到大依次尝试。优先尝试购买每核单价最便宜的,如果购买失败则尝试购买次便宜的,以此类推。
CAPACITY_OPTIMIZED,容量优化策略。对于启动配置内的所有机型,按照各机型在各可用区的库存情况由大到小依次尝试。优先尝试购买剩余库存最大的机型,这样可尽量降低竞价实例被动回收的发生概率。
注意:此字段可能返回 null,表示取不到有效值。
*/
SpotAllocationStrategy?: string;
/**
* 按量实例替补功能。取值范围:
TRUE,开启该功能,当所有竞价机型因库存不足等原因全部购买失败后,尝试购买按量实例。
FALSE,不开启该功能,伸缩组在需要扩容竞价实例时仅尝试所配置的竞价机型。
默认取值: TRUE。
注意:此字段可能返回 null,表示取不到有效值。
*/
CompensateWithBaseInstance?: boolean;
}
/**
* 实例主机名称序号相关设置。
*/
export interface HostNameIndexSettings {
/**
* 是否开启实例主机名创建序号,默认不开启。取值范围:
TRUE:表示开启实例主机名创建序号FALSE:表示不开启实例主机名创建序号
*/
Enabled?: boolean;
/**
* 初始序号。取值范围与 IndexLength 参数有关:- IndexLength 为 0 时,取值范围为 [0, 99999999]。- IndexLength 为 [1, 8] 时,取值范围为 [0, 10^IndexLength-1],最大值即为指定位数的最大数字。初始序号默认值如下:- 首次启用递增序号:初始序号默认值为 0 ( 展示位数与 IndexLength 有关,例如 IndexLength 为 4,展示值为 0000)- 非首次开启递增序号:顺延之前的递增序号,例如上次使用递增至序号 069,则新的初始序号默认值为 070。注意:修改初始序号可能会造成伸缩组内序号重复。
*/
BeginIndex?: number;
/**
* 递增序号长度,默认为0,表示不指定序号长度。 取值范围:0-8,最大为整数8。 - 长度设置为3,序号展示形式为:000、001、002 ... 010、011 ... 100 ... 999,序号上限为999- 长度设置为0,序号展示形式为:0、1、2 ... 10、11 ... 100 ... 1000 ...10000 ... 99999999,序号上限为99999999注意:递增序号持续超出上限会导致扩容失败,请不要设置过小的递增序号长度。
*/
IndexLength?: number;
}
/**
* ResumeInstanceRefresh返回参数结构体
*/
export interface ResumeInstanceRefreshResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeScalingPolicies返回参数结构体
*/
export interface DescribeScalingPoliciesResponse {
/**
* 弹性伸缩告警触发策略详细信息列表。
*/
ScalingPolicySet?: Array;
/**
* 符合条件的通知数量。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 符合条件的伸缩活动相关信息。
*/
export interface Activity {
/**
* 伸缩组ID。
*/
AutoScalingGroupId?: string;
/**
* 伸缩活动ID。
*/
ActivityId?: string;
/**
* 伸缩活动类型。取值如下:
SCALE_OUT:扩容活动
SCALE_IN:缩容活动
ATTACH_INSTANCES:添加实例
REMOVE_INSTANCES:销毁实例
DETACH_INSTANCES:移出实例
TERMINATE_INSTANCES_UNEXPECTEDLY:实例在CVM控制台被销毁
REPLACE_UNHEALTHY_INSTANCE:替换不健康实例
START_INSTANCES:开启实例
STOP_INSTANCES:关闭实例
INVOKE_COMMAND:执行命令
*/
ActivityType?: string;
/**
* 伸缩活动状态。取值如下
INIT:初始化中
RUNNING:运行中
SUCCESSFUL:活动成功
PARTIALLY_SUCCESSFUL:活动部分成功
FAILED:活动失败
CANCELLED:活动取消
*/
StatusCode?: string;
/**
* 伸缩活动状态描述。
*/
StatusMessage?: string;
/**
* 伸缩活动起因。
*/
Cause?: string;
/**
* 伸缩活动描述。
*/
Description?: string;
/**
* 伸缩活动开始时间,为 `UTC` 标准时间。
*/
StartTime?: string;
/**
* 伸缩活动结束时间,为 `UTC` 标准时间。
*/
EndTime?: string;
/**
* 伸缩活动创建时间,为 `UTC` 标准时间。
*/
CreatedTime?: string;
/**
* 该参数已废弃,请勿使用。
* @deprecated
*/
ActivityRelatedInstanceSet?: Array;
/**
* 伸缩活动状态简要描述。
*/
StatusMessageSimplified?: string;
/**
* 伸缩活动中生命周期挂钩的执行结果。
*/
LifecycleActionResultSet?: Array;
/**
* 伸缩活动状态详细描述。
*/
DetailedStatusMessageSet?: Array;
/**
* 执行命令结果。
*/
InvocationResultSet?: Array;
/**
* 伸缩活动相关实例信息集合。
*/
RelatedInstanceSet?: Array;
}
/**
* ModifyDesiredCapacity返回参数结构体
*/
export interface ModifyDesiredCapacityResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* StopAutoScalingInstances请求参数结构体
*/
export interface StopAutoScalingInstancesRequest {
/**
* 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:
通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。
通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ,取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 待关闭的CVM实例ID列表。可以通过以下方式获取可用的实例ID:
通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。
通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。
*/
InstanceIds: Array;
/**
* 关闭的实例是否收费,取值为:
KEEP_CHARGING:关机继续收费
STOP_CHARGING:关机停止收费
默认为 KEEP_CHARGING
*/
StoppedMode?: string;
}
/**
* 描述了 “可观测平台(原名云监控)” 服务相关的信息。
*/
export interface RunMonitorServiceEnabled {
/**
* 是否开启[可观测平台(原名云监控)](https://cloud.tencent.com/document/product/248)服务。取值范围:
TRUE:表示开启云监控服务
FALSE:表示不开启云监控服务
默认取值:TRUE。
*/
Enabled?: boolean;
}
/**
* 自定义 Metadata 的一组键值对信息
*/
export interface MetadataItem {
/**
* 自定义 MetaData 键
*/
Key: string;
/**
* 自定义 MetaData 值
*/
Value: string;
}
/**
* CancelInstanceRefresh返回参数结构体
*/
export interface CancelInstanceRefreshResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 与本次伸缩活动相关的实例信息。
*/
export interface ActivtyRelatedInstance {
/**
* 实例ID。
*/
InstanceId?: string;
/**
* 实例在伸缩活动中的状态。取值如下:
INIT:初始化中RUNNING:实例操作中SUCCESSFUL:活动成功FAILED:活动失败
*/
InstanceStatus?: string;
}
/**
* CreateAutoScalingGroupFromInstance请求参数结构体
*/
export interface CreateAutoScalingGroupFromInstanceRequest {
/**
* 伸缩组名称,在您账号中必须唯一。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超55个字节。
*/
AutoScalingGroupName: string;
/**
* 实例ID。可通过登录[控制台](https://console.cloud.tencent.com/cvm/index)或调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的 `InstanceId` 获取实例ID。
*/
InstanceId: string;
/**
* 最小实例数,取值范围为 [0,2000],同时需满足 MaxSize >= DesiredCapacity >= MinSize 。
*/
MinSize: number;
/**
* 最大实例数,取值范围为 [0,2000],同时需满足 MaxSize >= DesiredCapacity >= MinSize 。
*/
MaxSize: number;
/**
* 期望实例数,取值范围 [0,2000],默认值等于当前 MinSize,同时需满足 MaxSize >= DesiredCapacity >= MinSize 。
*/
DesiredCapacity?: number;
/**
* 是否继承实例标签,默认值为False
*/
InheritInstanceTag?: boolean;
}
/**
* 描述了启动配置创建实例的公网可访问性,声明了实例的公网使用计费模式,最大带宽等
*/
export interface InternetAccessible {
/**
* 网络计费类型。取值范围:BANDWIDTH_PREPAID:预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费BANDWIDTH_PACKAGE:带宽包用户默认取值:TRAFFIC_POSTPAID_BY_HOUR。
注意:此字段可能返回 null,表示取不到有效值。
*/
InternetChargeType?: string;
/**
* 公网出带宽上限,单位:Mbps。默认值:0Mbps。不同机型带宽上限范围不一致,具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/509)。
注意:此字段可能返回 null,表示取不到有效值。
*/
InternetMaxBandwidthOut?: number;
/**
* 是否分配公网IP。取值范围:TRUE:表示分配公网IPFALSE:表示不分配公网IP当公网带宽大于0Mbps时,可自由选择开通与否,默认开通公网IP;当公网带宽为0,则不允许分配公网IP。
注意:此字段可能返回 null,表示取不到有效值。
*/
PublicIpAssigned?: boolean;
/**
* 带宽包ID。可通过[DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。
注意:此字段可能返回 null,表示取不到有效值。
*/
BandwidthPackageId?: string;
/**
* 线路类型。各种线路类型及支持地区详情可参考:[EIP 的 IP 地址类型](https://cloud.tencent.com/document/product/1199/41646)。默认值:BGP。
BGP:常规 BGP 线路
已开通静态单线IP白名单的用户,可选值:
CMCC:中国移动
CTCC:中国电信
CUCC:中国联通
注意:仅部分地域支持静态单线IP。
*/
InternetServiceProvider?: string;
/**
* 公网 IP 类型。
WanIP:普通公网IP。
HighQualityEIP:精品 IP。仅新加坡和中国香港支持精品IP。
AntiDDoSEIP:高防 IP。仅部分地域支持高防IP,详情可见[弹性公网IP产品概述](https://cloud.tencent.com/document/product/1199/41646) 。
如需为资源分配弹性公网IPv4地址,请指定弹性公网IPv4地址类型。如只使用WanIP,不需要设置此字段。
精品IP 高防IP功能仅部分地区灰度开放,如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)
*/
IPv4AddressType?: string;
/**
* 高防包唯一ID,申请高防IP时,该字段必传。
*/
AntiDDoSPackageId?: string;
/**
* 实例销毁时是否一并销毁绑定的弹性IP。
取值范围:
TRUE:表示保留EIP
FALSE:表示不保留
请注意,当IPv4AddressType字段指定EIP类型时,默认不保留EIP。WanIP不受此字段影响始终随实例销毁。
变更配置此字段,已绑定伸缩组会立刻生效。
*/
IsKeepEIP?: boolean;
}
/**
* EnableAutoScalingGroup返回参数结构体
*/
export interface EnableAutoScalingGroupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpgradeLaunchConfiguration返回参数结构体
*/
export interface UpgradeLaunchConfigurationResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 描述了实例的计费模式
*/
export interface InstanceChargePrepaid {
/**
* 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。
*/
Period: number;
/**
* 自动续费标识。取值范围:NOTIFY_AND_AUTO_RENEW:通知过期且自动续费NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。
*/
RenewFlag?: string;
}
/**
* DeleteLifecycleHook返回参数结构体
*/
export interface DeleteLifecycleHookResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ExecuteScalingPolicy请求参数结构体
*/
export interface ExecuteScalingPolicyRequest {
/**
* 告警伸缩策略ID,不支持目标追踪策略。可通过 DescribeScalingPolicies 接口返回的 ScalingPolicyType 参数获取告警策略类型。
*/
AutoScalingPolicyId: string;
/**
* 是否检查伸缩组活动处于冷却时间内,默认值为false
*/
HonorCooldown?: boolean;
/**
* 执行伸缩策略的触发来源,取值包括 API 和 CLOUD_MONITOR,默认值为 API。CLOUD_MONITOR 专门供云监控触发调用。
*/
TriggerSource?: string;
}