tencentcloud-sdk-nodejs
Version:
1,994 lines (1,986 loc) • 158 kB
TypeScript
/**
* DisableAutoScalingGroup返回参数结构体
*/
export interface DisableAutoScalingGroupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyLaunchConfigurationAttributes请求参数结构体
*/
export interface ModifyLaunchConfigurationAttributesRequest {
/**
* 启动配置ID
*/
LaunchConfigurationId: string;
/**
* 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-8toqc6s3`。镜像类型分为四种:<br/><li>公共镜像</li><li>自定义镜像</li><li>共享镜像</li><li>服务市场镜像</li><br/>可通过以下方式获取可用的镜像ID:<br/><li>`公共镜像`、`自定义镜像`、`共享镜像`的镜像ID可通过登录[控制台](https://console.cloud.tencent.com/cvm/image?rid=1&imageType=PUBLIC_IMAGE)查询;`服务镜像市场`的镜像ID可通过[云市场](https://market.cloud.tencent.com/list)查询。</li><li>通过调用接口 [DescribeImages](https://cloud.tencent.com/document/api/213/15715) ,取返回信息中的`ImageId`字段。</li>
*/
ImageId?: string;
/**
* 实例类型列表,不同实例机型指定了不同的资源规格,最多支持10种实例机型。
InstanceType 指定单一实例类型,通过设置 InstanceTypes可以指定多实例类型,并使原有的InstanceType失效。
*/
InstanceTypes?: Array<string>;
/**
* 实例类型校验策略,在实际修改 InstanceTypes 时发挥作用,取值包括 ALL 和 ANY,默认取值为ANY。
<li> ALL,所有实例类型(InstanceType)都可用则通过校验,否则校验报错。</li>
<li> ANY,存在任何一个实例类型(InstanceType)可用则通过校验,否则校验报错。</li>
实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。
如果 InstanceTypes 中一款机型不存在或者已下线,则无论 InstanceTypesCheckPolicy 采用何种取值,都会校验报错。
*/
InstanceTypesCheckPolicy?: string;
/**
* 启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
*/
LaunchConfigurationName?: string;
/**
* 经过 Base64 编码后的自定义数据,最大长度不超过16KB。如果要清空UserData,则指定其为空字符串。
*/
UserData?: string;
/**
* 实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的`SecurityGroupId`字段来获取。
若指定该参数,请至少提供一个安全组,列表顺序有先后。
*/
SecurityGroupIds?: Array<string>;
/**
* 公网带宽相关信息设置。
当公网出带宽上限为0Mbps时,不支持修改为开通分配公网IP;相应的,当前为开通分配公网IP时,修改的公网出带宽上限值必须大于0Mbps。
*/
InternetAccessible?: InternetAccessible;
/**
* 实例计费类型。具体取值范围如下:
<li>POSTPAID_BY_HOUR:按小时后付费</li>
<li>SPOTPAID:竞价付费</li>
<li>PREPAID:预付费,即包年包月</li>
<li>CDCPAID:专用集群付费</li>
*/
InstanceChargeType?: string;
/**
* 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。
若修改实例的付费模式为预付费,则该参数必传;从预付费修改为其他付费模式时,本字段原信息会自动丢弃。
当新增该字段时,必须传递购买实例的时长,其它未传递字段会设置为默认值。
当修改本字段时,当前付费模式必须为预付费。
*/
InstanceChargePrepaid?: InstanceChargePrepaid;
/**
* 实例的市场相关选项,如竞价实例相关参数。
若修改实例的付费模式为竞价付费,则该参数必传;从竞价付费修改为其他付费模式时,本字段原信息会自动丢弃。
当新增该字段时,必须传递竞价相关选项下的竞价出价,其它未传递字段会设置为默认值。
当修改本字段时,当前付费模式必须为竞价付费。
*/
InstanceMarketOptions?: InstanceMarketOptionsRequest;
/**
* 云盘类型选择策略,取值范围:
<li>ORIGINAL:使用设置的云盘类型。</li>
<li>AUTOMATIC:自动选择当前可用的云盘类型。</li>
*/
DiskTypePolicy?: string;
/**
* 实例系统盘配置信息。
*/
SystemDisk?: SystemDisk;
/**
* 实例数据盘配置信息。
最多支持指定11块数据盘。采取整体修改,因此请提供修改后的全部值。
数据盘类型默认与系统盘类型保持一致。
*/
DataDisks?: Array<DataDisk>;
/**
* 云服务器主机名(HostName)的相关设置。
不支持windows实例设置主机名。
新增该属性时,必须传递云服务器的主机名,其它未传递字段会设置为默认值。
*/
HostNameSettings?: HostNameSettings;
/**
* 云服务器(InstanceName)实例名的相关设置。
如果用户在启动配置中设置此字段,则伸缩组创建出的实例 InstanceName 参照此字段进行设置,并传递给 CVM;如果用户未在启动配置中设置此字段,则伸缩组创建出的实例 InstanceName 按照“as-{{ 伸缩组AutoScalingGroupName }}”进行设置,并传递给 CVM。
新增该属性时,必须传递云服务器的实例名称,其它未传递字段会设置为默认值。
*/
InstanceNameSettings?: InstanceNameSettings;
/**
* 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。
*/
EnhancedService?: EnhancedService;
/**
* CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。
*/
CamRoleName?: string;
/**
* 高性能计算集群ID。<br>
注意:此字段默认为空。
*/
HpcClusterId?: string;
/**
* IPv6公网带宽相关信息设置。若新建实例包含IPv6地址,该参数可为新建实例的IPv6地址分配公网带宽。关联启动配置的伸缩组Ipv6AddressCount参数为0时,该参数不会生效。
*/
IPv6InternetAccessible?: IPv6InternetAccessible;
/**
* 置放群组id,仅支持指定一个。
*/
DisasterRecoverGroupIds?: Array<string>;
/**
* 实例登录设置,包括密码、密钥或保持镜像的原始登录设置。<br>请注意,指定新的登录设置会覆盖原有登录设置。例如,如果您之前使用密码登录,使用该参数将登录设置修改为密钥,则原有密码被清除。
*/
LoginSettings?: LoginSettings;
/**
* 实例标签列表。通过指定该参数,可以为扩容的实例绑定标签。最多支持指定10个标签。
该参数会覆盖原有的实例标签列表,如需新增标签,需将新标签和原有标签一并传入。
*/
InstanceTags?: Array<InstanceTag>;
/**
* 镜像族名称。
*/
ImageFamily?: string;
/**
* 本地专用集群ID。
*/
DedicatedClusterId?: string;
/**
* 自定义metadata。
*/
Metadata?: Metadata;
}
/**
* DisableAutoScalingGroup请求参数结构体
*/
export interface DisableAutoScalingGroupRequest {
/**
* 伸缩组ID
*/
AutoScalingGroupId: string;
}
/**
* DescribeRefreshActivities返回参数结构体
*/
export interface DescribeRefreshActivitiesResponse {
/**
* 符合条件的刷新活动数量。
*/
TotalCount?: number;
/**
* 符合条件的刷新活动信息集合。
*/
RefreshActivitySet?: Array<RefreshActivity>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAutoScalingGroup请求参数结构体
*/
export interface ModifyAutoScalingGroupRequest {
/**
* 伸缩组ID
*/
AutoScalingGroupId: string;
/**
* 伸缩组名称,在您账号中必须唯一。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超55个字节。
*/
AutoScalingGroupName?: string;
/**
* 默认冷却时间,单位秒,默认值为300
*/
DefaultCooldown?: number;
/**
* 期望实例数,大小介于最小实例数和最大实例数之间
*/
DesiredCapacity?: number;
/**
* 启动配置ID
*/
LaunchConfigurationId?: string;
/**
* 最大实例数,取值范围为0-2000。
*/
MaxSize?: number;
/**
* 最小实例数,取值范围为0-2000。
*/
MinSize?: number;
/**
* 项目ID
*/
ProjectId?: number;
/**
* 子网ID列表
*/
SubnetIds?: Array<string>;
/**
* 销毁策略,目前长度上限为1。取值包括 OLDEST_INSTANCE 和 NEWEST_INSTANCE。
<li> OLDEST_INSTANCE 优先销毁伸缩组中最旧的实例。</li>
<li> NEWEST_INSTANCE,优先销毁伸缩组中最新的实例。</li>
*/
TerminationPolicies?: Array<string>;
/**
* VPC ID,基础网络则填空字符串。修改为具体VPC ID时,需指定相应的SubnetIds;修改为基础网络时,需指定相应的Zones。
*/
VpcId?: string;
/**
* 可用区列表
*/
Zones?: Array<string>;
/**
* 重试策略,取值包括 IMMEDIATE_RETRY、 INCREMENTAL_INTERVALS、NO_RETRY,默认取值为 IMMEDIATE_RETRY。部分成功的伸缩活动判定为一次失败活动。
<li>IMMEDIATE_RETRY,立即重试,在较短时间内快速重试,连续失败超过一定次数(5次)后不再重试。</li>
<li>INCREMENTAL_INTERVALS,间隔递增重试,随着连续失败次数的增加,重试间隔逐渐增大,重试间隔从秒级到1天不等。</li>
<li> NO_RETRY,不进行重试,直到再次收到用户调用或者告警信息后才会重试。</li>
*/
RetryPolicy?: string;
/**
* 可用区校验策略,取值包括 ALL 和 ANY,默认取值为ANY。在伸缩组实际变更资源相关字段时(启动配置、可用区、子网)发挥作用。
<li> ALL,所有可用区(Zone)或子网(SubnetId)都可用则通过校验,否则校验报错。</li>
<li> ANY,存在任何一个可用区(Zone)或子网(SubnetId)可用则通过校验,否则校验报错。</li>
可用区或子网不可用的常见原因包括该可用区CVM实例类型售罄、该可用区CBS云盘售罄、该可用区配额不足、该子网IP不足等。
如果 Zones/SubnetIds 中可用区或者子网不存在,则无论 ZonesCheckPolicy 采用何种取值,都会校验报错。
*/
ZonesCheckPolicy?: string;
/**
* 服务设置,包括云监控不健康替换等服务设置。
*/
ServiceSettings?: ServiceSettings;
/**
* 实例具有IPv6地址数量的配置,取值包括0、1。
*/
Ipv6AddressCount?: number;
/**
* 多可用区/子网策略,取值包括 PRIORITY 和 EQUALITY,默认为 PRIORITY。
<li> PRIORITY,按照可用区/子网列表的顺序,作为优先级来尝试创建实例,如果优先级最高的可用区/子网可以创建成功,则总在该可用区/子网创建。</li>
<li> EQUALITY:扩容出的实例会打散到多个可用区/子网,保证扩容后的各个可用区/子网实例数相对均衡。</li>
与本策略相关的注意点:
<li> 当伸缩组为基础网络时,本策略适用于多可用区;当伸缩组为VPC网络时,本策略适用于多子网,此时不再考虑可用区因素,例如四个子网ABCD,其中ABC处于可用区1,D处于可用区2,此时考虑子网ABCD进行排序,而不考虑可用区1、2。</li>
<li> 本策略适用于多可用区/子网,不适用于启动配置的多机型。多机型按照优先级策略进行选择。</li>
<li> 按照 PRIORITY 策略创建实例时,先保证多机型的策略,后保证多可用区/子网的策略。例如多机型A、B,多子网1、2、3,会按照A1、A2、A3、B1、B2、B3 进行尝试,如果A1售罄,会尝试A2(而非B1)。</li>
*/
MultiZoneSubnetPolicy?: string;
/**
* 伸缩组实例健康检查类型,取值如下:
<li>CVM:根据实例网络状态判断实例是否处于不健康状态,不健康的网络状态即发生实例 PING 不可达事件,详细判断标准可参考[实例健康检查](https://cloud.tencent.com/document/product/377/8553)</li>
<li>CLB:根据 CLB 的健康检查状态判断实例是否处于不健康状态,CLB健康检查原理可参考[健康检查](https://cloud.tencent.com/document/product/214/6097)</li>
*/
HealthCheckType?: string;
/**
* CLB健康检查宽限期。
*/
LoadBalancerHealthCheckGracePeriod?: number;
/**
* 实例分配策略,取值包括 LAUNCH_CONFIGURATION 和 SPOT_MIXED。
<li> LAUNCH_CONFIGURATION,代表传统的按照启动配置模式。</li>
<li> SPOT_MIXED,代表竞价混合模式。目前仅支持启动配置为按量计费模式时使用混合模式,混合模式下,伸缩组将根据设定扩容按量或竞价机型。使用混合模式时,关联的启动配置的计费类型不可被修改。</li>
*/
InstanceAllocationPolicy?: string;
/**
* 竞价混合模式下,各计费类型实例的分配策略。
仅当 InstanceAllocationPolicy 取 SPOT_MIXED 时可用。
*/
SpotMixedAllocationPolicy?: SpotMixedAllocationPolicy;
/**
* 容量重平衡功能,仅对伸缩组内的竞价实例有效。取值范围:
<li> TRUE,开启该功能,当伸缩组内的竞价实例即将被竞价实例服务自动回收前,AS 主动发起竞价实例销毁流程,如果有配置过缩容 hook,则销毁前 hook 会生效。销毁流程启动后,AS 会异步开启一个扩容活动,用于补齐期望实例数。</li>
<li> FALSE,不开启该功能,则 AS 等待竞价实例被销毁后才会去扩容补齐伸缩组期望实例数。</li>
*/
CapacityRebalance?: boolean;
/**
* 实例名称序号相关设置。开启后为伸缩组内自动创建的实例名称添加递增的数字序号。
*/
InstanceNameIndexSettings?: InstanceNameIndexSettings;
}
/**
* ScaleOutInstances请求参数结构体
*/
export interface ScaleOutInstancesRequest {
/**
* 伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 希望扩容的实例数量。
*/
ScaleOutNumber: number;
}
/**
* 弹性伸缩事件通知
*/
export interface AutoScalingNotification {
/**
* 伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 用户组ID列表。
*/
NotificationUserGroupIds: Array<string>;
/**
* 通知事件列表。
*/
NotificationTypes: Array<string>;
/**
* 事件通知ID。
*/
AutoScalingNotificationId: string;
/**
* 通知接收端类型。
*/
TargetType: string;
/**
* CMQ 队列名。
*/
QueueName: string;
/**
* CMQ 主题名。
*/
TopicName: string;
}
/**
* ModifyScheduledAction请求参数结构体
*/
export interface ModifyScheduledActionRequest {
/**
* 待修改的定时任务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`。<br>此参数与`Recurrence`需要同时指定,到达结束时间之后,定时任务将不再生效。
*/
EndTime?: string;
/**
* 定时任务的重复方式。为标准 Cron 格式<br>此参数与`EndTime`需要同时指定。
*/
Recurrence?: string;
}
/**
* DescribeAutoScalingGroups请求参数结构体
*/
export interface DescribeAutoScalingGroupsRequest {
/**
* 按照一个或者多个伸缩组ID查询。伸缩组ID形如:`asg-nkdwoui0`。每次请求的上限为100。参数不支持同时指定`AutoScalingGroupIds`和`Filters`。
*/
AutoScalingGroupIds?: Array<string>;
/**
* 过滤条件。
<li> auto-scaling-group-id - String - 是否必填:否 -(过滤条件)按照伸缩组ID过滤。</li>
<li> auto-scaling-group-name - String - 是否必填:否 -(过滤条件)按照伸缩组名称过滤。</li>
<li> vague-auto-scaling-group-name - String - 是否必填:否 -(过滤条件)按照伸缩组名称模糊搜索。</li>
<li> launch-configuration-id - String - 是否必填:否 -(过滤条件)按照启动配置ID过滤。</li>
<li> tag-key - String - 是否必填:否 -(过滤条件)按照标签键进行过滤。</li>
<li> tag-value - String - 是否必填:否 -(过滤条件)按照标签值进行过滤。</li>
<li> tag:tag-key - String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例2</li>
每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。参数不支持同时指定`AutoScalingGroupIds`和`Filters`。
*/
Filters?: Array<Filter>;
/**
* 返回数量,默认为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<DataDisk>;
/**
* 实例登录设置。
*/
LoginSettings?: LimitedLoginSettings;
/**
* 公网带宽相关信息设置。
*/
InternetAccessible?: InternetAccessible;
/**
* 实例所属安全组。
*/
SecurityGroupIds?: Array<string>;
/**
* 启动配置关联的伸缩组。
*/
AutoScalingGroupAbstractSet?: Array<AutoScalingGroupAbstract>;
/**
* 自定义数据。
注意:此字段可能返回 null,表示取不到有效值。
*/
UserData?: string;
/**
* 启动配置创建时间。
*/
CreatedTime?: string;
/**
* 实例的增强服务启用情况与其设置。
*/
EnhancedService?: EnhancedService;
/**
* 镜像ID。
*/
ImageId?: string;
/**
* 启动配置当前状态。取值范围:<li>NORMAL:正常</li><li>IMAGE_ABNORMAL:启动配置镜像异常</li><li>CBS_SNAP_ABNORMAL:启动配置数据盘快照异常</li><li>SECURITY_GROUP_ABNORMAL:启动配置安全组异常</li>
*/
LaunchConfigurationStatus?: string;
/**
* 实例计费类型,CVM默认值按照POSTPAID_BY_HOUR处理。<li>POSTPAID_BY_HOUR:按小时后付费</li><li>SPOTPAID:竞价付费</li>
*/
InstanceChargeType?: string;
/**
* 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceMarketOptions?: InstanceMarketOptionsRequest;
/**
* 实例机型列表。
*/
InstanceTypes?: Array<string>;
/**
* 实例标签列表。扩容出来的实例会自动带上标签,最多支持10个标签。
*/
InstanceTags?: Array<InstanceTag>;
/**
* 标签列表。
*/
Tags?: Array<Tag>;
/**
* 版本号。
*/
VersionNumber?: number;
/**
* 更新时间。
*/
UpdatedTime?: string;
/**
* CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。
*/
CamRoleName?: string;
/**
* 上次操作时,InstanceTypesCheckPolicy 取值。
*/
LastOperationInstanceTypesCheckPolicy?: string;
/**
* 云服务器主机名(HostName)的相关设置。
*/
HostNameSettings?: HostNameSettings;
/**
* 云服务器实例名(InstanceName)的相关设置。
*/
InstanceNameSettings?: InstanceNameSettings;
/**
* 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
*/
InstanceChargePrepaid?: InstanceChargePrepaid;
/**
* 云盘类型选择策略。取值范围:<li>ORIGINAL:使用设置的云盘类型</li><li>AUTOMATIC:自动选择当前可用区下可用的云盘类型</li>
*/
DiskTypePolicy?: string;
/**
* 高性能计算集群ID。<br>
注意:此字段默认为空。
*/
HpcClusterId?: string;
/**
* IPv6公网带宽相关信息设置。
*/
IPv6InternetAccessible?: IPv6InternetAccessible;
/**
* 置放群组id,仅支持指定一个。
*/
DisasterRecoverGroupIds?: Array<string>;
/**
* 镜像族名称。
*/
ImageFamily?: string;
/**
* 本地专用集群 ID。
*/
DedicatedClusterId?: string;
}
/**
* 自定义 Metadata
*/
export interface Metadata {
/**
* 自定义 Metadata 键值对列表
*/
Items?: Array<MetadataItem>;
}
/**
* 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;
/**
* 伸缩建议警告级别。取值范围:
<li>WARNING:警告级别</li>
<li>CRITICAL:严重级别</li>
*/
Level?: string;
}
/**
* EnterStandby请求参数结构体
*/
export interface EnterStandbyRequest {
/**
* 伸缩组 ID。
*/
AutoScalingGroupId: string;
/**
* 运行中状态实例列表,不支持传入非运行中状态实例。
*/
InstanceIds: Array<string>;
}
/**
* 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<AutoScalingGroup>;
/**
* 符合条件的伸缩组数量。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateScheduledAction请求参数结构体
*/
export interface CreateScheduledActionRequest {
/**
* 伸缩组ID
*/
AutoScalingGroupId: 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`。<br><br>此参数与`Recurrence`需要同时指定,到达结束时间之后,定时任务将不再生效。
*/
EndTime?: string;
/**
* 定时任务的重复方式。为标准 Cron 格式<br><br>此参数与`EndTime`需要同时指定。
*/
Recurrence?: string;
}
/**
* ExitStandby请求参数结构体
*/
export interface ExitStandbyRequest {
/**
* 伸缩组 ID。
*/
AutoScalingGroupId: string;
/**
* 备用中状态 CVM 实例列表。
*/
InstanceIds: Array<string>;
}
/**
* 启动配置的系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
*/
export interface SystemDisk {
/**
* 系统盘类型。系统盘类型限制详见[云硬盘类型](https://cloud.tencent.com/document/product/362/2353)。取值范围
<li>LOCAL_BASIC:本地硬盘</li>
<li>LOCAL_SSD:本地SSD硬盘</li>
<li>CLOUD_BASIC:普通云硬盘</li>
<li>CLOUD_PREMIUM:高性能云硬盘</li>
<li>CLOUD_SSD:SSD云硬盘</li>
<li>默认取值:CLOUD_PREMIUM。</li>
*/
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<string>;
/**
* 过滤条件。
<li> auto-scaling-policy-id - String - 是否必填:否 -(过滤条件)按照告警策略ID过滤。</li>
<li> auto-scaling-group-id - String - 是否必填:否 -(过滤条件)按照伸缩组ID过滤。</li>
<li> scaling-policy-name - String - 是否必填:否 -(过滤条件)按照告警策略名称过滤。</li>
<li> scaling-policy-type - String - 是否必填:否 -(过滤条件)按照告警策略类型过滤,取值范围为SIMPLE,TARGET_TRACKING。</li>
每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。参数不支持同时指定`AutoScalingPolicyIds`和`Filters`。
*/
Filters?: Array<Filter>;
/**
* 返回数量,默认为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。
假设后缀名称为 suffix,原实例名为 test.0,最终实例名为 test.0.suffix。
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceNameSuffix?: 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;
}
/**
* 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
*/
LifecycleHookId: string;
/**
* 生命周期动作的结果,取值范围为“CONTINUE”或“ABANDON”
*/
LifecycleActionResult: string;
/**
* 实例ID,“InstanceId”和“LifecycleActionToken”必须填充其中一个
*/
InstanceId?: string;
/**
* “InstanceId”和“LifecycleActionToken”必须填充其中一个
*/
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<string>;
/**
* 过滤条件。
<li> auto-scaling-group-id - String - 是否必填:否 -(过滤条件)按照伸缩组ID过滤。</li>
<li> refresh-activity-status-code - String - 是否必填:否 -(过滤条件)按照刷新活动状态过滤。(INIT:初始化中 | RUNNING:运行中 | SUCCESSFUL:活动成功 | FAILED_PAUSE:失败暂停 | AUTO_PAUSE:自动暂停 | MANUAL_PAUSE:手动暂停 | CANCELLED:活动取消 | FAILED:活动失败)</li>
<li> refresh-activity-type - String - 是否必填:否 -(过滤条件)按照刷新活动类型过滤。(NORMAL:正常刷新活动 | ROLLBACK:回滚刷新活动)</li>
<li> refresh-activity-id - String - 是否必填:否 -(过滤条件)按照刷新活动ID过滤。</li>
<li> 每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定RefreshActivityIds和Filters。</li>
*/
Filters?: Array<Filter>;
/**
* 返回数量,默认为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<LaunchConfiguration>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RemoveInstances请求参数结构体
*/
export interface RemoveInstancesRequest {
/**
* 伸缩组ID
*/
AutoScalingGroupId: string;
/**
* CVM实例ID列表
*/
InstanceIds: Array<string>;
}
/**
* 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
*/
AutoScalingGroupId: string;
/**
* 传统负载均衡器ID列表,列表长度上限为20,LoadBalancerIds 和 ForwardLoadBalancerIdentifications 二者同时最多只能指定一个
*/
LoadBalancerIds?: Array<string>;
/**
* 应用型负载均衡器标识信息列表,列表长度上限为100,LoadBalancerIds 和 ForwardLoadBalancerIdentifications二者同时最多只能指定一个
*/
ForwardLoadBalancerIdentifications?: Array<ForwardLoadBalancerIdentification>;
}
/**
* DescribeAutoScalingInstances请求参数结构体
*/
export interface DescribeAutoScalingInstancesRequest {
/**
* 待查询云服务器(CVM)的实例ID。每次请求的上限为100。参数不支持同时指定InstanceIds和Filters。
*/
InstanceIds?: Array<string>;
/**
* 过滤条件。
<li> instance-id - String - 是否必填:否 -(过滤条件)按照实例ID过滤。</li>
<li> auto-scaling-group-id - String - 是否必填:否 -(过滤条件)按照伸缩组ID过滤。</li>
每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为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
*/
AutoScalingGroupId: string;
/**
* 传统负载均衡器ID列表,目前长度上限为20,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个
*/
LoadBalancerIds?: Array<string>;
/**
* 应用型负载均衡器列表,目前长度上限为100,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个
*/
ForwardLoadBalancers?: Array<ForwardLoadBalancer>;
/**
* 负载均衡器校验策略,取值包括 ALL 和 DIFF,默认取值为 ALL。
<li> ALL,所有负载均衡器都合法则通过校验,否则校验报错。</li>
<li> DIFF,仅校验负载均衡器参数中实际变化的部分,如果合法则通过校验,否则校验报错。</li>
*/
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。
*/
LaunchConfigurationId: string;
}
/**
* SetInstancesProtection请求参数结构体
*/
export interface SetInstancesProtectionRequest {
/**
* 伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 实例ID。
*/
InstanceIds: Array<string>;
/**
* 实例是否需要设置保护。
*/
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,取值范围如下:
<li>FIRST_BATCH_PAUSE:第一批次更新完成后暂停</li>
<li>BATCH_INTERVAL_PAUSE:批次间暂停</li>
<li>AUTOMATIC:不暂停</li>
*/
BatchPause?: string;
/**
* 最大额外数量。设置该参数后,在滚动更新开始前根据启动配置创建一批按量计费的额外实例,滚动更新完成后销毁额外实例。
该参数用于保证滚动更新过程中可用实例的数量,最大额外数量不能超过滚动更新单个批次的刷新实例数。回滚流程暂不支持该参数。
*/
MaxSurge?: number;
/**
* 失败处理策略。默认值为 AUTO_PAUSE,取值范围如下:
<li>AUTO_PAUSE:刷新失败后暂停</li>
<li>AUTO_ROLLBACK:刷新失败后回滚。回滚时每批次回滚一台实例,CheckInstanceTargetHealth 参数值与原刷新活动一致。MaxSurge参数引入的扩缩容流程失败无需回滚,会用取消动作代替回滚</li>
<li>AUTO_CANCEL:刷新失败后取消</li>
*/
FailProcess?: string;
}
/**
* ModifyLaunchConfigurationAttributes返回参数结构体
*/
export interface ModifyLaunchConfigurationAttributesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateLaunchConfiguration请求参数结构体
*/
export interface CreateLaunchConfigurationRequest {
/**
* 启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。
*/
LaunchConfigurationName: string;
/**
* 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-8toqc6s3`。镜像Id与镜像族名称,二者必填一个且只能填写一个。镜像类型分为四种:<br/><li>公共镜像</li><li>自定义镜像</li><li>共享镜像</li><li>服务市场镜像</li><br/>可通过以下方式获取可用的镜像ID:<br/><li>`公共镜像`、`自定义镜像`、`共享镜像`的镜像ID可通过登录[控制台](https://console.cloud.tencent.com/cvm/image?rid=1&imageType=PUBLIC_IMAGE)查询;`服务镜像市场`的镜像ID可通过[云市场](https://market.cloud.tencent.com/list)查询。</li><li>通过调用接口 [DescribeImages](https://cloud.tencent.com/document/api/213/15715) ,取返回信息中的`ImageId`字段。</li>
*/
ImageId?: string;
/**
* 启动配置所属项目ID。不填为默认项目。
注意:伸缩组内实例所属项目ID取伸缩组项目ID,与这里取值无关。
*/
ProjectId?: number;
/**
* 实例机型。不同实例机型指定了不同的资源规格,具体取值可通过调用接口 [DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749) 来获得最新的规格表或参见[实例类型](https://cloud.tencent.com/document/product/213/11518)描述。
`InstanceType`和`InstanceTypes`参数互斥,二者必填一个且只能填写一个。
*/
InstanceType?: string;
/**
* 实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
*/
SystemDisk?: SystemDisk;
/**
* 实例数据盘配置信息。若不指定该参数,则默认不购买数据盘,最多支持指定11块数据盘。
*/
DataDisks?: Array<DataDisk>;
/**
* 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
*/
InternetAccessible?: InternetAccessible;
/**
* 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。
*/
LoginSettings?: LoginSettings;
/**
* 实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的`SecurityGroupId`字段来获取。若不指定该参数,则默认不绑定安全组。
*/
SecurityGroupIds?: Array<string>;
/**
* 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。
*/
EnhancedService?: EnhancedService;
/**
* 经过 Base64 编码后的自定义数据,最大长度不超过16KB。
*/
UserData?: string;
/**
* 实例计费类型,CVM默认值按照POSTPAID_BY_HOUR处理。
<li>POSTPAID_BY_HOUR:按小时后付费</li>
<li>SPOTPAID:竞价付费</li>
<li>PREPAID:预付费,即包年包月</li>
<li>CDCPAID:专用集群付费</li>
*/
InstanceChargeType?: string;
/**
* 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。
*/
InstanceMarketOptions?: InstanceMarketOptionsRequest;
/**
* 实例机型列表,不同实例机型指定了不同的资源规格,最多支持10种实例机型。
`InstanceType`和`InstanceTypes`参数互斥,二者必填一个且只能填写一个。
*/
InstanceTypes?: Array<string>;
/**
* CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。
*/
CamRoleName?: string;
/**
* 实例类型校验策略,取值包括 ALL 和 ANY,默认取值为ANY。
<li> ALL,所有实例类型(InstanceType)都可用则通过校验,否则校验报错。</li>
<li> ANY,存在任何一个实例类型(InstanceType)可用则通过校验,否则校验报错。</li>
实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。
如果 InstanceTypes 中一款机型不存在或者已下线,则无论 InstanceTypesCheckPolicy 采用何种取值,都会校验报错。
*/
InstanceTypesCheckPolicy?: string;
/**
* 标签列表。通过指定该参数,可以为扩容的实例绑定标签。最多支持指定10个标签。
*/
InstanceTags?: Array<InstanceTag>;
/**
* 标签描述列表。通过指定该参数可以支持绑定标签到启动配置。每个启动配置最多支持30个标签。
*/
Tags?: Array<Tag>;
/**
* 云服务器主机名(HostName)的相关设置。
*/
HostNameSettings?: HostNameSettings;
/**
* 云服务器实例名(InstanceName)的相关设置。
如果用户在启动配置中设置此字段,则伸缩组创建出的实例 InstanceName 参照此字段进行设置,并传递给 CVM;如果用户未在启动配置中设置此字段,则伸缩组创建出的实例 InstanceName 按照“as-{{ 伸缩组AutoScalingGroupName }}”进行设置,并传递给 CVM。
*/
InstanceNameSettings?: InstanceNameSettings;
/**
* 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
*/
InstanceChargePrepaid?: InstanceChargePrepaid;
/**
* 云盘类型选择策略,默认取值 ORIGINAL,取值范围:
<li>ORIGINAL:使用设置的云盘类型</li>
<li>AUTOMATIC:自动选择当前可用的云盘类型</li>
*/
DiskTypePolicy?: string;
/**
* 高性能计算集群ID。<br>
注意:此字段默认为空。
*/
HpcClusterId?: string;
/**
* IPv6公网带宽相关信息设置。若新建实例包含IPv6地址,该参数可为新建实例的IPv6地址分配公网带宽。关联启动配置的伸缩组Ipv6AddressCount参数为0时,该参数不会生效。
*/
IPv6InternetAccessible?: IPv6InternetAccessible;
/**
* 置放群组id,仅支持指定一个。
*/
DisasterRecoverGroupIds?: Array<string>;
/**
* 镜像族名称。镜像Id与镜像族名称,二者必填一个且只能填写一个。
*/
ImageFamily?: string;
/**
* 本地专用集群ID。
*/
DedicatedClusterId?: string;
/**
* 自定义metadata。
*/
Metadata?: Metadata;
}
/**
* 伸缩组
*/
export interface AutoScalingGroup {
/**
* 伸缩组ID
*/
AutoScalingGroupId?: string;
/**
* 伸缩组名称
*/
AutoScalingGroupName?: string;
/**
* 伸缩组当前状态。取值范围:
<li>NORMAL:正常</li>
<li>CVM_ABNORMAL:启动配置异常</li>
<li>LB_ABNORMAL:负载均衡器异常</li>
<li>LB_LISTENER_ABNORMAL:负载均衡器监听器异常</li>
<li>LB_LOCATION_ABNORMAL:负载均衡器监听器转发配置异常</li>
<li>VPC_ABNORMAL:VPC网络异常</li>
<li>SUBNET_ABNORMAL:VPC子网异常</li>
<li>INSUFFICIENT_BALANCE:余额不足</li>
<li>LB_BACKEND_REGION_NOT_MATCH:CLB实例后端地域与AS服务所在地域不匹配</li>
<li>LB_BACKEND_VPC_NOT_MATCH:CLB实例VPC与伸缩组VPC不匹配</li>
*/
AutoScalingGroupStatus?: string;
/**
* 创建时间,采用UTC标准计时
*/
CreatedTime?: string;
/**
* 默认冷却时间,单位秒
*/
DefaultCooldown?: number;
/**
* 期望实例数
*/
DesiredCapacity?: number;
/**
* 启用状态,取值包括`ENABLED`和`DISABLED`
*/
EnabledStatus?: string;
/**
* 应用型负载均衡器列表
*/
ForwardLoadBalancerSet?: Array<ForwardLoadBalancer>;
/**
* 实例数量
*/
InstanceCount?: number;
/**
* 状态为`IN_SERVICE`实例的数量
*/
InServiceInstanceCount?: number;
/**
* 启动配置ID
*/
LaunchConfigurationId?: string;
/**
* 启动配置名称
*/
LaunchConfigurationName?: string;
/**
* 传统型负载均衡器ID列表
*/
LoadBalancerIdSet?: Array<string>;
/**
* 最大实例数
*/
MaxSize?: number;
/**
* 最小实例数
*/
MinSize?: number;
/**
* 项目ID
*/
ProjectId?: number;
/**
* 子网ID列表
*/
SubnetIdSet?: Array<string>;
/**
* 销毁策略
*/
TerminationPolicySet?: Array<string>;
/**
* VPC标识
*/
VpcId?: string;
/**
* 可用区列表
*/
ZoneSet?: Array<string>;
/**
* 重试策略
*/
RetryPolicy?: string;
/**
* 伸缩组是否处于伸缩活动中,`IN_ACTIVITY`表示处于伸缩活动中,`NOT_IN_ACTIVITY`表示不处于伸缩活动中。
*/
InActivityStatus?: string;
/**
* 伸缩组标签列表
*/
Tags?: Array<Tag>;
/**
* 服务设置
*/
ServiceSettings?: ServiceSettings;
/**
* 实例具有IPv6地址数量的配置
*/
Ipv6AddressCount?: number;
/**
* 多可用区/子网策略。
<li> PRIORITY,按照可用区/子网列表的顺序,作为优先级来尝试创建实例,如果优先级最高的可用区/子网可以创建成功,则总在该可用区/子网创建。</li>
<li> EQUALITY:每次选择当前实例数最少的可用区/子网进行扩容,使得每个可用区/子网都有机会发生扩容,多次扩容出的实例会打散到多个可用区/子网。</li>
*/
MultiZoneSubnetPolicy?: string;
/**
* 伸缩组实例健康检查类型,取值如下:
<li>CVM:根据实例网络状态判断实例是否处于不健康状态,不健康的网络状态即发生实例 PING 不可达事件,详细判断标准可参考[实例健康检查](https://cloud.tencent.com/document/product/377/8553)</li>
<li>CLB:根据 CLB 的健康检查状态判断实例是否处于不健康状态,CLB健康检查原理可参考[健康检查](https://cloud.tencent.com/document/product/214/6097)</li>
*/
HealthCheckType?: string;
/**
* CLB健康检查宽限期
*/
LoadBalancerHealthCheckGracePeriod?: number;
/**
* 实例分配策略,取值包括 LAUNCH_CONFIGURATION 和 SPOT_MIXED。
<li> LAUNCH_CONFIGURATION,代表传统的按照启动配置模式。</li>
<li> SPOT_MIXED,代表竞价混合模式。目前仅支持启动配置为按量计费模式时使用混合模式,混合模式下,伸缩组将根据设定扩容按量或竞价机型。使用混合模式时,关联的启动配置的计费类型不可被修改。</li>
*/
InstanceAllocationPolicy?: string;
/**
* 竞价混合模式下,各计费类型实例的分配策略。
仅当 InstanceAllocationPolicy 取 SPOT_MIXED 时才会返回有效值。
*/
SpotMixedAllocationPolicy?: SpotMixedAllocationPolicy;
/**
* 容量重平衡功能,仅对伸缩组内的竞价实例有效。取值范围:
<li> TRUE,开启该功能,当伸缩组内的竞价实例即将被竞价实例服务自动回收前,AS 主动发起竞价实例销毁流程,如果有配置过缩容 hook,则销毁前 hook 会生效。销毁流程启动后,AS 会异步开启一个扩容活动,用于补齐期望实例数。</li>
<li> FALSE,不开启该功能,则 AS 等待竞价实例被销毁后才会去扩容补齐伸缩组期望实例数。</li>
*/
CapacityRebalance?: boolean;
/**
* 实例名称序号相关设置。
*/
InstanceNameIndexSettings?: InstanceNameIndexSettings;
}
/**
* AttachInstances返回参数结构体
*/
export interface AttachInstancesResponse {
/**
* 伸缩活动ID
*/
ActivityId: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAutoScalingGroupLastActivities返回参数结构体
*/
export interface DescribeAutoScalingGroupLastActivitiesResponse {
/**
* 符合条件的伸缩活动信息集合。说明:伸缩组伸缩活动不存在的则不返回,如传50个伸缩组ID,返回45条数据,说明其中有5个伸缩组伸缩活动不存在。
*/
ActivitySet?: Array<Activity>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAccountLimits请求参数结构体
*/
export declare type DescribeAccountLimitsRequest = null;
/**
* ScaleInInstances返回参数结构体
*/
export interface ScaleInInstancesResponse {
/**
* 伸缩活动ID。
*/
ActivityId: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CancelInstanceRefresh请求参数结构体
*/
export interface CancelInstanceRefreshRequest {
/**
* 伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 刷新活动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;
/**
* 告警触发后,期望实例数修改方式,仅适用于简单策略。取值范围:<br><li>CHANGE_IN_CAPACITY:增加或减少若干期望实例数</li><li>EXACT_CAPACITY:调整至指定期望实例数</li> <li>PERCENT_CHANGE_IN_CAPACITY:按百分比调整期望实例数</li>
*/
AdjustmentType?: string;
/**
* 告警触发后,期望实例数的调整值,仅适用于简单策略。
*/
AdjustmentValue?: number;
/**
* 冷却时间,仅适用于简单策略。
*/
Cooldown?: number;
/**
* 简单告警触发策略告警监控指标,仅适用于简单策略。
*/
MetricAlarm?: MetricAlarm;
/**
* 预定义监控项,仅适用于目标追踪策略。取值范围:<br><li>ASG_AVG_CPU_UTILIZATION:平均CPU使用率</li><li>ASG_AVG_LAN_TRAFFIC_OUT:平均内网出带宽</li><li>ASG_AVG_LAN_TRAFFIC_IN:平均内网入带宽</li><li>ASG_AVG_WAN_TRAFFIC_OUT:平均外网出带宽</li><li>ASG_AVG_WAN_TRAFFIC_IN:平均外网出带宽</li>
注意:此字段可能返回 null,表示取不到有效值。
*/
PredefinedMetricType?: string;
/**
* 目标值,仅适用于目标追踪策略。<br><li>ASG_AVG_CPU_UTILIZATION:[1, 100),单位:%</li><li>ASG_AVG_LAN_TRAFFIC_OUT:>0,单位:Mbps</li><li>ASG_AVG_LAN_TRAFFIC_IN:>0,单位:Mbps</li><li>ASG_AVG_WAN_TRAFFIC_OUT:>0,单位:Mbps</li><li>ASG_AVG_WAN_TRAFFIC_IN:>0,单位:Mbps</li>
注意:此字段可能返回 null,表示取不到有效值。
*/
TargetValue?: number;
/**
* 实例预热时间,单位为秒,仅适用于目标追踪策略。取值范围为0-3600。
注意:此字段可能返回 null,表示取不到有效值。
*/
EstimatedInstanceWarmup?: number;
/**
* 是否禁用缩容,仅适用于目标追踪策略。取值范围:<br><li>true:目标追踪策略仅触发扩容</li><li>false:目标追踪策略触发扩容和缩容</li>
注意:此字段可能返回 null,表示取不到有效值。
*/
DisableScaleIn?: boolean;
/**
* 告警监控指标列表,仅适用于目标追踪策略。
注意:此字段可能返回 null,表示取不到有效值。
*/
MetricAlarms?: Array<MetricAlarm>;
/**
* 通知组ID,即为用户组ID集合。
*/
NotificationUserGroupIds?: Array<string>;
}
/**
* DescribeAutoScalingGroupLastActivities请求参数结构体
*/
export interface DescribeAutoScalingGroupLastActivitiesRequest {
/**
* 伸缩组ID列表
*/
AutoScalingGroupIds: Array<string>;
}
/**
* 云服务器主机名(HostName)的相关设置
*/
export interface HostNameSettings {
/**
* 云服务器的主机名。
<li> 点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。</li>
<li> 不支持 Windows 实例。</li>
<li> 其他类型(Linux 等)实例:字符长度为[2, 40],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。不允许为纯数字。</li>
注意:此字段可能返回 null,表示取不到有效值。
*/
HostName: string;
/**
* 云服务器主机名的风格,取值范围包括 ORIGINAL 和 UNIQUE,默认为 ORIGINAL。
<li> ORIGINAL,AS 直接将入参中所填的 HostName 传递给 CVM,CVM 可能会对 HostName 追加序列号,伸缩组中实例的 HostName 会出现冲突的情况。</li>
<li> UNIQUE,入参所填的 HostName 相当于主机名前缀,AS 和 CVM 会对其进行拓展,伸缩组中实例的 HostName 可以保证唯一。</li>
注意:此字段可能返回 null,表示取不到有效值。
*/
HostNameStyle?: string;
/**
* 云服务器的主机名后缀。
<li> 点号(.)和短横线(-)不能作为 HostNameSuffix 的首尾字符,不能连续使用。</li>
<li> 不支持 Windows 实例。</li>
<li>其他类型(Linux 等)实例:字符长度为[1, 37],且与 HostName 的长度和不能超过 39,允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。</li>
假设后缀名称为 suffix,原主机名为 test.0,最终主机名为 test.0.suffix。
注意:此字段可能返回 null,表示取不到有效值。
*/
HostNameSuffix?: string;
}
/**
* ModifyLoadBalancers返回参数结构体
*/
export interface ModifyLoadBalancersResponse {
/**
* 伸缩活动ID
*/
ActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateNotificationConfiguration请求参数结构体
*/
export interface CreateNotificationConfigurationRequest {
/**
* 伸缩组ID。
*/
AutoScalingGroupId: string;
/**
* 通知类型,即为需要订阅的通知类型集合,取值范围如下:
<li>SCALE_OUT_SUCCESSFUL:扩容成功</li>
<li>SCALE_OUT_FAILED:扩容失败</li>
<li>SCALE_IN_SUCCESSFUL:缩容成功</li>
<li>SCALE_IN_FAILED:缩容失败</li>
<li>REPLACE_UNHEALTHY_INSTANCE_SUCCESSFUL:替换不健康子机成功</li>
<li>REPLACE_UNHEALTHY_INSTANCE_FAILED:替换不健康子机失败</li>
*/
NotificationTypes: Array<string>;
/**
* 通知组ID,即为用户组ID集合,用户组ID可以通过[ListGroups](https://cloud.tencent.com/document/product/598/34589)查询。
*/
NotificationUserGroupIds?: Array<string>;
/**
* 通知接收端类型,取值如下
<br><li>USER_GROUP:用户组
<br><li>CMQ_QUEUE:CMQ 队列
<br><li>CMQ_TOPIC:CMQ 主题
<br><li>TDMQ_CMQ_TOPIC:TDMQ CMQ 主题
<br><li>TDMQ_CMQ_QUEUE:TDMQ CMQ 队列
默认值为:`USER_GROUP`。
*/
TargetType?: string;
/**
* CMQ 队列名称,如 TargetType 取值为 `CMQ_QUEUE` 或 `TDMQ_CMQ_QUEUE` 时,该字段必填。
*/
QueueName?: string;
/**
* CMQ 主题名称,如 TargetType 取值为 `CMQ_TOPIC` 或 `TDMQ_CMQ_TOPIC` 时,该字段必填。
*/
TopicName?: string;
}
/**
* DescribeScheduledActions返回参数结构体
*/
export interface DescribeScheduledActionsResponse {
/**
* 符合条件的定时任务数量。
*/
TotalCount?: number;
/**
* 定时任务详细信息列表。
*/
ScheduledActionSet?: Array<ScheduledAction>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyNotificationConfiguration请求参数结构体
*/
export interface ModifyNotificationConfigurationRequest {
/**
* 待修改的通知ID。
*/
AutoScalingNotificationId: string;
/**
* 通知类型,即为需要订阅的通知类型集合,取值范围如下:
<li>SCALE_OUT_SUCCESSFUL:扩容成功</li>
<li>SCALE_OUT_FAILED:扩容失败</li>
<li>SCALE_IN_SUCCESSFUL:缩容成功</li>
<li>SCALE_IN_FAILED:缩容失败</li>
<li>REPLACE_UNHEALTHY_INSTANCE_SUCCESSFUL:替换不健康子机成功</li>
<li>REPLACE_UNHEALTHY_INSTANCE_FAILED:替换不健康子机失败</li>
*/
NotificationTypes?: Array<string>;
/**
* 通知组ID,即为用户组ID集合,用户组ID可以通过[ListGroups](https://cloud.tencent.com/document/product/598/34589)查询。
*/
NotificationUserGroupIds?: Array<string>;
/**
* CMQ 队列或 TDMQ CMQ 队列名。
*/
QueueName?: string;
/**
* CMQ 主题或 TDMQ CMQ 主题名。
*/
TopicName?: string;
}
/**
* DeleteLifecycleHook请求参数结构体
*/
export interface DeleteLifecycleHookRequest {
/**
* 生命周期挂钩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。
*/
AutoScalingPolicyId: string;
/**
* 告警策略名称。
*/
ScalingPolicyName?: string;
/**
* 告警触发后,期望实例数修改方式,仅适用于简单策略。取值范围:<br><li>CHANGE_IN_CAPACITY:增加或减少若干期望实例数</li><li>EXACT_CAPACITY:调整至指定期望实例数</li> <li>PERCENT_CHANGE_IN_CAPACITY:按百分比调整期望实例数</li>
*/
AdjustmentType?: string;
/**
* 告警触发后,期望实例数的调整值,仅适用于简单策略。<li>当 AdjustmentType 为 CHANGE_IN_CAPACITY 时,AdjustmentValue 为正数表示告警触发后增加实例,为负数表示告警触发后减少实例 </li> <li> 当 AdjustmentType 为 EXACT_CAPACITY 时,AdjustmentValue 的值即为告警触发后新的期望实例数,需要大于或等于0 </li> <li> 当 AdjustmentType 为 PERCENT_CHANGE_IN_CAPACITY 时,AdjusmentValue 为正数表示告警触发后按百分比增加实例,为负数表示告警触发后按百分比减少实例,单位是:%。</li>
*/
AdjustmentValue?: number;
/**
* 冷却时间,仅适用于简单策略,单位为秒。
*/
Cooldown?: number;
/**
* 告警监控指标,仅适用于简单策略。
*/
MetricAlarm?: MetricAlarm;
/**
* 预定义监控项,仅适用于目标追踪策略。取值范围:<br><li>ASG_AVG_CPU_UTILIZATION:平均CPU使用率</li><li>ASG_AVG_LAN_TRAFFIC_OUT:平均内网出带宽</li><li>ASG_AVG_LAN_TRAFFIC_IN:平均内网入带宽</li><li>ASG_AVG_WAN_TRAFFIC_OUT:平均外网出带宽</li><li>ASG_AVG_WAN_TRAFFIC_IN:平均外网出带宽</li>
*/
PredefinedMetricType?: string;
/**
* 目标值,仅适用于目标追踪策略。<br><li>ASG_AVG_CPU_UTILIZATION:[1, 100),单位:%</li><li>ASG_AVG_LAN_TRAFFIC_OUT:>0,单位:Mbps</li><li>ASG_AVG_LAN_TRAFFIC_IN:>0,单位:Mbps</li><li>ASG_AVG_WAN_TRAFFIC_OUT:>0,单位:Mbps</li><li>ASG_AVG_WAN_TRAFFIC_IN:>0,单位:Mbps</li>
*/
TargetValue?: number;
/**
* 实例预热时间,单位为秒,仅适用于目标追踪策略。取值范围为0-3600。
*/
EstimatedInstanceWarmup?: number;
/**
* 是否禁用缩容,仅适用于目标追踪策略。取值范围:<br><li>true:目标追踪策略仅触发扩容</li><li>false:目标追踪策略触发扩容和缩容</li>
*/
DisableScaleIn?: boolean;
/**
* 此参数已不再生效,请使用[创建通知](https://cloud.tencent.com/document/api/377/33185)。
通知组ID,即为用户组ID集合。
*/
NotificationUserGroupIds?: Array<string>;
}
/**
* CVM竞价请求相关选项
*/
export interface InstanceMarketOptionsRequest {
/**
* 竞价相关选项
*/
SpotOptions: SpotMarketOptions;
/**
* 市场选项类型,当前只支持取值:spot
*/
MarketType?: string;
}
/**
* 实例刷新批次信息,包含该批次的刷新状态、实例、起止时间等信息。
*/
export interface RefreshBatch {
/**
* 刷新批次序号。例如,2 表示当前批次实例会在第二批次进行实例刷新。
*/
RefreshBatchNum?: number;
/**
* 刷新批次状态。取值如下:<li>WAITING:待刷新</li><li>INIT:初始化中</li><li>RUNNING:刷新中</li><li>FAILED: 刷新失败</li><li>PARTIALLY_SUCCESSFUL:批次部分成功</li><li>CANCELLED:已取消</li><li>SUCCESSFUL:刷新成功</li>
*/
RefreshBatchStatus?: string;
/**
* 刷新批次关联实例列表。
*/
RefreshBatchRelatedInstanceSet?: Array<RefreshBatchRelatedInstance>;
/**
* 刷新批次开始时间。
注意:此字段可能返回 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;
/**
* 标签值