弹性伸缩数据结构-API 文档-文档中心-腾讯云

Activity

符合条件的伸缩活动相关信息。

被如下接口引用：DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities。

名称	类型	描述
AutoScalingGroupId	String	伸缩组ID。示例值：asg-jub6fr43
ActivityId	String	伸缩活动ID。示例值：asa-jdh6r43e
ActivityType	String	伸缩活动类型。取值如下： SCALE_OUT：扩容活动 SCALE_IN：缩容活动 ATTACH_INSTANCES：添加实例 REMOVE_INSTANCES：销毁实例 DETACH_INSTANCES：移出实例 TERMINATE_INSTANCES_UNEXPECTEDLY：实例在CVM控制台被销毁 REPLACE_UNHEALTHY_INSTANCE：替换不健康实例 START_INSTANCES：开启实例 STOP_INSTANCES：关闭实例 INVOKE_COMMAND：执行命令示例值：SCALE_OUT
StatusCode	String	伸缩活动状态。取值如下 INIT：初始化中 RUNNING：运行中 SUCCESSFUL：活动成功 PARTIALLY_SUCCESSFUL：活动部分成功 FAILED：活动失败 CANCELLED：活动取消示例值：RUNNING
StatusMessage	String	伸缩活动状态描述。示例值：Success
Cause	String	伸缩活动起因。示例值：Activity was launched in response to a difference between desired capacity and actual capacity.
Description	String	伸缩活动描述。示例值：Activity was launched in response to a difference between desired capacity and actual capacity, scale out 1 instance(s).
StartTime	Timestamp ISO8601	伸缩活动开始时间。示例值：2024-11-12T05:30:21Z
EndTime	Timestamp ISO8601	伸缩活动结束时间。示例值：2024-11-12T05:30:21Z
CreatedTime	Timestamp ISO8601	伸缩活动创建时间。示例值：2024-11-12T05:30:21Z
StatusMessageSimplified	String	伸缩活动状态简要描述。示例值：Success
LifecycleActionResultSet	Array of LifecycleActionResultInfo	伸缩活动中生命周期挂钩的执行结果。示例值：[{"NotificationResult": "NONE", "ResultReason": "HEARTBEAT_TIMEOUT", "InstanceId": "ins-1dcgn84h", "InvocationId": "", "LifecycleActionResult": "CONTINUE", "InvokeCommandResult": "NONE", "LifecycleHookId": "ash-aadtetfm"}]
DetailedStatusMessageSet	Array of DetailedStatusMessage	伸缩活动状态详细描述。示例值：[{"[{"Code": "CvmCreationFailed", "Zone": "ap-beijing-5", "InstanceId": "ins-qfcgbumb", "InstanceChargeType": "PREPAID", "SubnetId": "subnet-opywjlrx", "Message": "Failed to launch instance `ins-qfcgbumb`. Instance type: `GNV4.12XLARGE176`, Subnet: `subnet-opywjlrx`, Zone: `ap-beijing-5`, LatestOperationCode: `ResourceInsufficient`.", "InstanceType": "GNV4.12XLARGE176"}]
InvocationResultSet	Array of InvocationResult	执行命令结果。示例值：[{"InstanceId":"ins-ju6vr4d3", "InvocationId":"inv-1sgbq5c1","InvocationTaskId":"invt-6x4li1zf","CommandId":"cmd-rkk9m8rp","TaskStatus":"SUCCESS","ErrorMessage":""}]
RelatedInstanceSet	Array of RelatedInstance	伸缩活动相关实例信息集合。示例值： [{"InstanceId": "ins-qdve9yyr", "InstanceStatus": "SUCCESSFUL"}]

Advice

伸缩配置建议。

被如下接口引用：DescribeAutoScalingAdvices。

名称	类型	描述
Problem	String	问题描述。示例值：DiskSoldOut
Detail	String	问题详情。示例值：Load balancers `['lb-p4nq0x9e']` are not found.
Solution	String	建议解决方案。示例值：It is recommended to config Auto Scaling Group with valid load balancer.
Level	String	伸缩建议警告级别。取值范围： WARNING：警告级别 CRITICAL：严重级别示例值：WARNING

AutoScalingAdvice

伸缩组配置建议。

被如下接口引用：DescribeAutoScalingAdvices。

名称	类型	描述
AutoScalingGroupId	String	伸缩组ID。示例值：asg-pc2oqu2z
Level	String	伸缩组警告级别。取值范围： NORMAL：正常 WARNING：警告级别 CRITICAL：严重级别示例值：NORMAL
Advices	Array of Advice	伸缩组配置建议集合。示例值：[{"Problem": "InvalidInstanceType", "Detail": "Instance Type `SN3ne.LARGE4`(`POSTPAID_BY_HOUR`) in `ap-shanghai-5` is invalid.", "Solution": "It is recommended to replace the invalid instance type.", "Level": "WARNING"}]

AutoScalingGroup

伸缩组

被如下接口引用：DescribeAutoScalingGroups。

名称	类型	描述
AutoScalingGroupId	String	伸缩组ID 示例值：asg-30wif85u
AutoScalingGroupName	String	伸缩组名称示例值：test-asg
AutoScalingGroupStatus	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不匹配示例值：NORMAL
CreatedTime	Timestamp ISO8601	创建时间，采用UTC标准计时示例值：2021-05-31T12:38:35Z
DefaultCooldown	Integer	默认冷却时间，单位秒示例值：300
DesiredCapacity	Integer	期望实例数示例值：0
EnabledStatus	String	启用状态，取值包括`ENABLED`和`DISABLED` 示例值：ENABLED
ForwardLoadBalancerSet	Array of ForwardLoadBalancer	应用型负载均衡器列表示例值：[{"LoadBalancerId": "lb-af8li2kn", "ListenerId": "lbl-akw1lgo7", "TargetAttributes": [{"Port": 80, "Weight": 10}]}]
InstanceCount	Integer	实例数量示例值：0
InServiceInstanceCount	Integer	状态为`IN_SERVICE`实例的数量示例值：0
LaunchConfigurationId	String	启动配置ID 示例值：asc-966b7fk2
LaunchConfigurationName	String	启动配置名称示例值：test-lc
LoadBalancerIdSet	Array of String	传统型负载均衡器ID列表示例值：["lb-ij7ytg54"]
MaxSize	Integer	最大实例数示例值：10
MinSize	Integer	最小实例数示例值：0
ProjectId	Integer	项目ID 示例值：0
SubnetIdSet	Array of String	子网ID列表示例值：["subnet-rdm629r2"]
TerminationPolicySet	Array of String	销毁策略示例值：OLDEST_INSTANCE
VpcId	String	VPC标识示例值：vpc-h3cd5td5
ZoneSet	Array of String	可用区列表示例值：["ap-guangzhou-5"]
RetryPolicy	String	重试策略示例值：NO_RETRY
InActivityStatus	String	伸缩组是否处于伸缩活动中，`IN_ACTIVITY`表示处于伸缩活动中，`NOT_IN_ACTIVITY`表示不处于伸缩活动中。示例值：IN_ACTIVITY
Tags	Array of Tag	伸缩组标签列表示例值：[{"Key": "Service_B", "Value": "pss3", "ResourceType": "auto-scaling-group"}]
ServiceSettings	ServiceSettings	服务设置示例值：{"ReplaceMonitorUnhealthy": false, "ReplaceLoadBalancerUnhealthy": false, "ReplaceMode": "RECREATE", "ScalingMode": "CLASSIC_SCALING"}
Ipv6AddressCount	Integer	实例具有IPv6地址数量的配置示例值：0
MultiZoneSubnetPolicy	String	多可用区/子网策略。 PRIORITY，按照可用区/子网列表的顺序，作为优先级来尝试创建实例，如果优先级最高的可用区/子网可以创建成功，则总在该可用区/子网创建。 EQUALITY：每次选择当前实例数最少的可用区/子网进行扩容，使得每个可用区/子网都有机会发生扩容，多次扩容出的实例会打散到多个可用区/子网。示例值：PRIORITY
HealthCheckType	String	伸缩组实例健康检查类型，取值如下： CVM：根据实例网络状态判断实例是否处于不健康状态，不健康的网络状态即发生实例 PING 不可达事件，详细判断标准可参考实例健康检查 CLB：根据 CLB 的健康检查状态判断实例是否处于不健康状态，CLB健康检查原理可参考健康检查示例值：CLB
LoadBalancerHealthCheckGracePeriod	Integer	CLB健康检查宽限期示例值：300
InstanceAllocationPolicy	String	实例分配策略，取值包括 LAUNCH_CONFIGURATION 和 SPOT_MIXED。 LAUNCH_CONFIGURATION，代表传统的按照启动配置模式。 SPOT_MIXED，代表竞价混合模式。目前仅支持启动配置为按量计费模式时使用混合模式，混合模式下，伸缩组将根据设定扩容按量或竞价机型。使用混合模式时，关联的启动配置的计费类型不可被修改。示例值：LAUNCH_CONFIGURATION
SpotMixedAllocationPolicy	SpotMixedAllocationPolicy	竞价混合模式下，各计费类型实例的分配策略。仅当 InstanceAllocationPolicy 取 SPOT_MIXED 时才会返回有效值。示例值：{"BaseCapacity": 1, "CompensateWithBaseInstance": true, "OnDemandPercentageAboveBaseCapacity": 50, "SpotAllocationStrategy": "COST_OPTIMIZED"}
CapacityRebalance	Boolean	容量重平衡功能，仅对伸缩组内的竞价实例有效。取值范围： TRUE，开启该功能，当伸缩组内的竞价实例即将被竞价实例服务自动回收前，AS 主动发起竞价实例销毁流程，如果有配置过缩容 hook，则销毁前 hook 会生效。销毁流程启动后，AS 会异步开启一个扩容活动，用于补齐期望实例数。 FALSE，不开启该功能，则 AS 等待竞价实例被销毁后才会去扩容补齐伸缩组期望实例数。示例值：false
InstanceNameIndexSettings	InstanceNameIndexSettings	实例名称序号相关设置。注意：此字段可能返回 null，表示取不到有效值。示例值：{"BeginIndex": 0, "Enabled": true}

AutoScalingGroupAbstract

伸缩组简明信息。

被如下接口引用：DescribeLaunchConfigurations。

名称	类型	描述
AutoScalingGroupId	String	伸缩组ID。示例值：asg-djy6etgf
AutoScalingGroupName	String	伸缩组名称。示例值：as-group-a0

AutoScalingNotification

弹性伸缩事件通知

被如下接口引用：DescribeNotificationConfigurations。

名称	类型	描述
AutoScalingGroupId	String	伸缩组ID。示例值：asg-19kw47wk
NotificationUserGroupIds	Array of String	用户组ID列表。示例值：["12529"]
NotificationTypes	Array of String	通知事件列表。示例值：["SCALE_OUT_SUCCESSFUL"]
AutoScalingNotificationId	String	事件通知ID。示例值：asn-6r4waxc4
TargetType	String	通知接收端类型。示例值：USER_GROUP
QueueName	String	CMQ 队列名。示例值：test-queue
TopicName	String	CMQ 主题名。示例值：test-topic

DataDisk

启动配置的数据盘配置信息。若不指定该参数，则默认不购买数据盘，当前仅支持购买的时候指定一个数据盘。

被如下接口引用：CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration。

名称	类型	必选	描述
DiskType	String	否	数据盘类型。数据盘类型限制详见云硬盘类型。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘默认取值与系统盘类型（SystemDisk.DiskType）保持一致。注意：此字段可能返回 null，表示取不到有效值。示例值：CLOUD_PREMIUM
DiskSize	Integer	否	数据盘大小，单位：GB。最小调整步长为10G，不同数据盘类型取值范围不同，具体限制详见：CVM实例配置。默认值为0，表示不购买数据盘。更多限制详见产品文档。注意：此字段可能返回 null，表示取不到有效值。示例值：0
SnapshotId	String	否	数据盘快照 ID，类似 `snap-l8psqwnt`。注意：此字段可能返回 null，表示取不到有效值。示例值：snap-l8psqwnt
DeleteWithInstance	Boolean	否	数据盘是否随子机销毁。取值范围： TRUE：子机销毁时，销毁数据盘，只支持按小时后付费云盘 FALSE：子机销毁时，保留数据盘注意：此字段可能返回 null，表示取不到有效值。示例值：false
Encrypt	Boolean	否	数据盘是否加密。取值范围： TRUE：加密 FALSE：不加密注意：此字段可能返回 null，表示取不到有效值。示例值：true
ThroughputPerformance	Integer	否	云硬盘性能，单位：MB/s。使用此参数可给云硬盘购买额外的性能，功能介绍和类型限制详见：增强型 SSD 云硬盘额外性能说明。当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD）且需容量 > 460GB。注意：此字段可能返回 null，表示取不到有效值。示例值：100
BurstPerformance	Boolean	否	突发性能。是否开启突发性能，默认取值为 false。注：内测中，需提单申请后使用。注意：此字段可能返回 null，表示取不到有效值。示例值：false

DetailedStatusMessage

伸缩活动状态详细描述。

被如下接口引用：DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities。

名称	类型	描述
Code	String	错误类型。示例值：InvalidInstanceType
Zone	String	可用区信息。示例值：ap-guangzhou-2
InstanceId	String	实例ID。示例值：ins-yy23daou
InstanceChargeType	String	实例计费类型。示例值：POSTPAID_BY_HOUR
SubnetId	String	子网ID。示例值：subnet-gz7j7r3k
Message	String	错误描述。示例值：Failed to launch instance `ins-9ojy714a`. Instance type: `S2.MEDIUM2`, Subnet: `subnet-6400tdiy`, Zone: `ap-guangzhou-2`, LatestOperationCode: `ResourceInsufficient`.
InstanceType	String	实例类型。示例值：IT5.8XLARGE128

EnhancedService

描述了实例的增强服务启用情况与其设置，如云安全，云监控，自动化助手等实例 Agent。

被如下接口引用：CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration。

名称	类型	必选	描述
SecurityService	RunSecurityServiceEnabled	否	开启云安全服务。若不指定该参数，则默认开启云安全服务。示例值：{"Enabled": True}
MonitorService	RunMonitorServiceEnabled	否	开启云监控服务。若不指定该参数，则默认开启云监控服务。示例值：{"Enabled": True}
AutomationToolsService	RunAutomationServiceEnabled	否	开启自动化助手服务。若不指定该参数，则默认逻辑与CVM保持一致。注意：此字段可能返回 null，表示取不到有效值。示例值：{"Enabled": True}

Filter

描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等

若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。

若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

以DescribeInstances接口的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

被如下接口引用：DescribeAutoScalingActivities, DescribeAutoScalingGroups, DescribeAutoScalingInstances, DescribeLaunchConfigurations, DescribeLifecycleHooks, DescribeNotificationConfigurations, DescribeRefreshActivities, DescribeScalingPolicies, DescribeScheduledActions。

名称	类型	必选	描述
Name	String	是	需要过滤的字段。示例值：zone
Values	Array of String	是	字段的过滤值。示例值：ap-guangzhou-6

ForwardLoadBalancer

应用型负载均衡器

被如下接口引用：AttachLoadBalancers, CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyLoadBalancerTargetAttributes, ModifyLoadBalancers。

名称	类型	必选	描述
LoadBalancerId	String	是	负载均衡器ID 示例值：lb-fy6te4r5
ListenerId	String	是	应用型负载均衡监听器 ID 示例值：lbl-dhyt56rf
TargetAttributes	Array of TargetAttribute	是	目标规则属性列表示例值：[{"Port": 80, "Weight": 10}]
LocationId	String	否	转发规则ID，注意：针对七层监听器此参数必填示例值：loc-sj8y6tr4
Region	String	否	负载均衡实例所属地域，默认取AS服务所在地域。格式与公共参数Region相同，如："ap-guangzhou"。示例值：ap-guangzhou

ForwardLoadBalancerIdentification

应用型负载均衡器标识信息

被如下接口引用：DetachLoadBalancers。

名称	类型	必选	描述
LoadBalancerId	String	是	负载均衡器ID 示例值：lb-ceqnq5xk
ListenerId	String	是	应用型负载均衡监听器 ID 示例值：lbl-lqf523ih
LocationId	String	否	转发规则ID，注意：针对七层监听器此参数必填示例值：loc-0xbavbfi

HostNameSettings

云服务器主机名（HostName）的相关设置

被如下接口引用：CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration。

名称	类型	必选	描述
HostName	String	是	云服务器的主机名。点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。不支持 Windows 实例。其他类型（Linux 等）实例：字符长度为[2, 40]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。不允许为纯数字。注意：此字段可能返回 null，表示取不到有效值。示例值：product-as-host-0
HostNameStyle	String	否	云服务器主机名的风格，取值范围包括 ORIGINAL 和 UNIQUE，默认为 ORIGINAL。 ORIGINAL，AS 直接将入参中所填的 HostName 传递给 CVM，CVM 可能会对 HostName 追加序列号，伸缩组中实例的 HostName 会出现冲突的情况。 UNIQUE，入参所填的 HostName 相当于主机名前缀，AS 和 CVM 会对其进行拓展，伸缩组中实例的 HostName 可以保证唯一。注意：此字段可能返回 null，表示取不到有效值。示例值：ORIGINAL
HostNameSuffix	String	否	云服务器的主机名后缀。点号（.）和短横线（-）不能作为 HostNameSuffix 的首尾字符，不能连续使用。不支持 Windows 实例。其他类型（Linux 等）实例：字符长度为[1, 37]，且与 HostName 的长度和不能超过 39，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。假设后缀名称为 suffix，原主机名为 test.0，最终主机名为 test.0.suffix。注意：此字段可能返回 null，表示取不到有效值。示例值：suffix

IPv6InternetAccessible

描述了启动配置创建实例的IPv6地址公网可访问性，声明了IPv6地址公网使用计费模式，最大带宽等

被如下接口引用：CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration。

名称	类型	必选	描述
InternetChargeType	String	否	网络计费模式。取值包括TRAFFIC_POSTPAID_BY_HOUR、BANDWIDTH_PACKAGE，默认取值为TRAFFIC_POSTPAID_BY_HOUR。查看当前账户类型可参考账户类型说明。 IPv6对标准账户类型支持TRAFFIC_POSTPAID_BY_HOUR。 IPv6对传统账户类型支持BANDWIDTH_PACKAGE。注意：此字段可能返回 null，表示取不到有效值。示例值：TRAFFIC_POSTPAID_BY_HOUR
InternetMaxBandwidthOut	Integer	否	公网出带宽上限，单位：Mbps。默认值：0，此时不为IPv6分配公网带宽。不同机型、可用区、计费模式的带宽上限范围不一致，具体限制详见公网带宽上限。注意：此字段可能返回 null，表示取不到有效值。示例值：0
BandwidthPackageId	String	否	带宽包ID。可通过DescribeBandwidthPackages接口返回值中的`BandwidthPackageId`获取。注意：此字段可能返回 null，表示取不到有效值。示例值：bwp-jfio9i0p

Instance

实例信息

被如下接口引用：DescribeAutoScalingInstances。

名称	类型	描述
InstanceId	String	实例ID 示例值：ins-089dlszs
AutoScalingGroupId	String	伸缩组ID 示例值：asg-02ofd40a
LaunchConfigurationId	String	启动配置ID 示例值：asc-23yf98ie
LaunchConfigurationName	String	启动配置名称示例值：测试asc-01_2.3
LifeCycleState	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：缩容生命周期挂钩中示例值：IN_SERVICE
HealthStatus	String	健康状态，取值包括HEALTHY和UNHEALTHY 示例值：HEALTHY
ProtectedFromScaleIn	Boolean	是否加入缩容保护示例值：false
Zone	String	可用区示例值：ap-guangzhou-1
CreationType	String	创建类型，取值包括AUTO_CREATION, MANUAL_ATTACHING。示例值：AUTO_CREATION
AddTime	Timestamp ISO8601	实例加入时间示例值：2023-01-13T03:06:25Z
InstanceType	String	实例类型示例值：S3.MEDIUM2
VersionNumber	Integer	版本号示例值：1
AutoScalingGroupName	String	伸缩组名称示例值：测试asg-01_2.3
WarmupStatus	String	预热状态，取值如下： WAITING_ENTER_WARMUP：等待进入预热 NO_NEED_WARMUP：无需预热 IN_WARMUP：预热中 AFTER_WARMUP：完成预热示例值：IN_WARMUP
DisasterRecoverGroupIds	Array of String	置放群组id，仅支持指定一个。注意：此字段可能返回 null，表示取不到有效值。示例值：["ps-uf8j6y3t"]

InstanceChargePrepaid

描述了实例的计费模式

被如下接口引用：CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration。

名称	类型	必选	描述
Period	Integer	是	购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。示例值：1
RenewFlag	String	否	自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。示例值：NOTIFY_AND_MANUAL_RENEW

InstanceMarketOptionsRequest

CVM竞价请求相关选项

被如下接口引用：CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration。

名称	类型	必选	描述
SpotOptions	SpotMarketOptions	是	竞价相关选项示例值：{"SpotInstanceType": "one-time", "MaxPrice": 1000}
MarketType	String	否	市场选项类型，当前只支持取值：spot 注意：此字段可能返回 null，表示取不到有效值。示例值：spot

InstanceNameIndexSettings

实例名称序号相关设置。

被如下接口引用：CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyAutoScalingGroup。

名称	类型	必选	描述
Enabled	Boolean	否	是否开启实例创建序号，默认不开启。取值范围： TRUE：表示开启实例创建序号 FALSE：表示不开启实例创建序号注意：此字段可能返回 null，表示取不到有效值。示例值：FALSE
BeginIndex	Integer	否	初始序号，取值范围为 [0, 99999999]。当序号递增后超出取值范围时，扩容活动会失败。首次开启实例名称序号：默认值为 0。非首次开启实例名称序号：若不指定该参数，沿用历史序号。下调初始序号可能会造成伸缩组内实例名称序号重复。注意：此字段可能返回 null，表示取不到有效值。示例值：0

InstanceNameSettings

云服务器实例名称（InstanceName）的相关设置

被如下接口引用：CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration。

名称	类型	必选	描述
InstanceName	String	是	云服务器的实例名。字符长度为[2, 108]。示例值：product-as-ins-0
InstanceNameStyle	String	否	云服务器实例名的风格，取值范围包括 ORIGINAL 和 UNIQUE，默认为 ORIGINAL。 ORIGINAL，AS 直接将入参中所填的 InstanceName 传递给 CVM，CVM 可能会对 InstanceName 追加序列号，伸缩组中实例的 InstanceName 会出现冲突的情况。 UNIQUE，入参所填的 InstanceName 相当于实例名前缀，AS 和 CVM 会对其进行拓展，伸缩组中实例的 InstanceName 可以保证唯一。示例值：ORIGINAL
InstanceNameSuffix	String	否	云服务器实例名后缀。字符长度为[1,105]，且与 InstanceName 的长度和不能超过107。假设后缀名称为 suffix，原实例名为 test.0，最终实例名为 test.0.suffix。注意：此字段可能返回 null，表示取不到有效值。示例值：testsuffix

InstanceTag

实例标签。通过指定该参数，可以为扩容的实例绑定标签。

被如下接口引用：CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration。

名称	类型	必选	描述
Key	String	是	标签键示例值：as-tag-key-app0
Value	String	是	标签值示例值：as-tag-value-app0

InternetAccessible

描述了启动配置创建实例的公网可访问性，声明了实例的公网使用计费模式，最大带宽等

被如下接口引用：CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration。

名称	类型	必选	描述
InternetChargeType	String	否	网络计费类型。取值范围： BANDWIDTH_PREPAID：预付费按带宽结算 TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费 BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费 BANDWIDTH_PACKAGE：带宽包用户默认取值：TRAFFIC_POSTPAID_BY_HOUR。注意：此字段可能返回 null，表示取不到有效值。示例值：TRAFFIC_POSTPAID_BY_HOUR
InternetMaxBandwidthOut	Integer	否	公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见购买网络带宽。注意：此字段可能返回 null，表示取不到有效值。示例值：0
PublicIpAssigned	Boolean	否	是否分配公网IP。取值范围： TRUE：表示分配公网IP FALSE：表示不分配公网IP 当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。注意：此字段可能返回 null，表示取不到有效值。示例值：false
BandwidthPackageId	String	否	带宽包ID。可通过DescribeBandwidthPackages接口返回值中的`BandwidthPackageId`获取。注意：此字段可能返回 null，表示取不到有效值。示例值：bwp-dss86yt5

InvocationResult

执行命令结果。

被如下接口引用：DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities。

名称	类型	描述
InstanceId	String	实例ID。注意：此字段可能返回 null，表示取不到有效值。示例值：ins-0lizunus
InvocationId	String	执行活动ID。注意：此字段可能返回 null，表示取不到有效值。示例值：inv-0h9q6ahv
InvocationTaskId	String	执行任务ID。注意：此字段可能返回 null，表示取不到有效值。示例值：invt-4mqj9ekr
CommandId	String	命令ID。注意：此字段可能返回 null，表示取不到有效值。示例值：cmd-5l44tu7j
TaskStatus	String	执行任务状态。注意：此字段可能返回 null，表示取不到有效值。示例值：SUCCESS
ErrorMessage	String	执行异常信息。注意：此字段可能返回 null，表示取不到有效值。示例值：InvocationTaskFailed->Invocation task failed.

LaunchConfiguration

符合条件的启动配置信息的集合。

被如下接口引用：DescribeLaunchConfigurations。

名称	类型	描述
ProjectId	Integer	实例所属项目ID。示例值：0
LaunchConfigurationId	String	启动配置ID。示例值：asc-abcd0123
LaunchConfigurationName	String	启动配置名称。示例值：TestLauchConfig0_0
InstanceType	String	实例机型。示例值：SA2.MEDIUM2
SystemDisk	SystemDisk	实例系统盘配置信息。示例值：{"DiskSize": 500, "DiskType": "CLOUD_BSSD"}
DataDisks	Array of DataDisk	实例数据盘配置信息。示例值：[{"DiskSize": 200, "DiskType": "CLOUD_BSSD"}]
LoginSettings	LimitedLoginSettings	实例登录设置。示例值：{"KeyIds": ["skey-sm1dxnap"]}
InternetAccessible	InternetAccessible	公网带宽相关信息设置。示例值：{"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR", "InternetMaxBandwidthOut": 0, "PublicIpAssigned": false}
SecurityGroupIds	Array of String	实例所属安全组。示例值：["sg-brwzhm6d"]
AutoScalingGroupAbstractSet	Array of AutoScalingGroupAbstract	启动配置关联的伸缩组。示例值：[{'AutoScalingGroupId': 'asg-1dbjno4d', 'AutoScalingGroupName': 'asg-v000'}]
UserData	String	自定义数据。注意：此字段可能返回 null，表示取不到有效值。示例值：dGVzdA==
CreatedTime	Timestamp ISO8601	启动配置创建时间。示例值：2021-05-31T12:38:35Z
EnhancedService	EnhancedService	实例的增强服务启用情况与其设置。示例值：{"MonitorService": {"Enabled": true}, "SecurityService": {"Enabled": true}}
ImageId	String	镜像ID。示例值：img-abcd0123
LaunchConfigurationStatus	String	启动配置当前状态。取值范围： NORMAL：正常 IMAGE_ABNORMAL：启动配置镜像异常 CBS_SNAP_ABNORMAL：启动配置数据盘快照异常 SECURITY_GROUP_ABNORMAL：启动配置安全组异常示例值：NORMAL
InstanceChargeType	String	实例计费类型，CVM默认值按照POSTPAID_BY_HOUR处理。 POSTPAID_BY_HOUR：按小时后付费 SPOTPAID：竞价付费示例值：POSTPAID_BY_HOUR
InstanceMarketOptions	InstanceMarketOptionsRequest	实例的市场相关选项，如竞价实例相关参数，若指定实例的付费模式为竞价付费则该参数必传。注意：此字段可能返回 null，表示取不到有效值。示例值：{"SpotOptions": {"SpotInstanceType": "one-time", "MaxPrice": 1000}, "MarketType": "spot"}
InstanceTypes	Array of String	实例机型列表。示例值：["SA2.MEDIUM2"]
InstanceTags	Array of InstanceTag	实例标签列表。扩容出来的实例会自动带上标签，最多支持10个标签。示例值：[{"Key": "server-group-name", "Value": "as-tencent"}]
Tags	Array of Tag	标签列表。注意：此字段可能返回 null，表示取不到有效值。示例值：[{"Key": "CCode", "Value": "ASTENCENT", "ResourceType": "launch-configuration"}]
VersionNumber	Integer	版本号。示例值：1
UpdatedTime	Timestamp ISO8601	更新时间。示例值：2023-09-04T11:42:46Z
CamRoleName	String	CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。示例值：TestRole
LastOperationInstanceTypesCheckPolicy	String	上次操作时，InstanceTypesCheckPolicy 取值。示例值：ANY
HostNameSettings	HostNameSettings	云服务器主机名（HostName）的相关设置。示例值：{"HostNameStyle": "UNIQUE", "HostName": "as-host"}
InstanceNameSettings	InstanceNameSettings	云服务器实例名（InstanceName）的相关设置。示例值：{"InstanceName": "app-as", "InstanceNameStyle": "UNIQUE"}
InstanceChargePrepaid	InstanceChargePrepaid	预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。示例值：{"Period": 1, "RenewFlag": "NOTIFY_AND_AUTO_RENEW"}
DiskTypePolicy	String	云盘类型选择策略。取值范围： ORIGINAL：使用设置的云盘类型 AUTOMATIC：自动选择当前可用区下可用的云盘类型示例值：ORIGINAL
HpcClusterId	String	高性能计算集群ID。注意：此字段默认为空。示例值：hpc-abcd0123
IPv6InternetAccessible	IPv6InternetAccessible	IPv6公网带宽相关信息设置。示例值：{"InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR", "InternetMaxBandwidthOut": 1}
DisasterRecoverGroupIds	Array of String	置放群组id，仅支持指定一个。示例值：["ps-dy7ui89o"]
ImageFamily	String	镜像族名称。注意：此字段可能返回 null，表示取不到有效值。示例值：testfamily

LifecycleActionResultInfo

生命周期挂钩动作的执行结果信息。

被如下接口引用：DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities。

名称	类型	描述
LifecycleHookId	String	生命周期挂钩标识。示例值：ash-xxxxxxxx
InstanceId	String	实例标识。示例值：ins-xxxxxxxx
InvocationId	String	执行活动ID。可通过TAT的查询执行活动API查询具体的执行结果。示例值：inv-xxxxxxxx
InvokeCommandResult	String	命令调用的结果，表示执行TAT命令是否成功。 SUCCESSFUL 命令调用成功，不代表命令执行成功，执行的具体情况可根据InvocationId进行查询 FAILED 命令调用失败 NONE 示例值：SUCCESSFUL
NotificationResult	String	通知的结果，表示通知CMQ/TDMQ是否成功。 SUCCESSFUL 通知成功 FAILED 通知失败 NONE 示例值：null
LifecycleActionResult	String	生命周期挂钩动作的执行结果，取值包括 CONTINUE、ABANDON。示例值：CONTINUE
ResultReason	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设置。示例值：HEARTBEAT_TIMEOUT

LifecycleCommand

远程命令执行对象。

被如下接口引用：CreateLifecycleHook, DescribeLifecycleHooks, ModifyLifecycleHook, UpgradeLifecycleHook。

名称	类型	必选	描述
CommandId	String	是	远程命令ID。若选择执行命令，则此项必填。注意：此字段可能返回 null，表示取不到有效值。示例值：cmd-gt5dre32
Parameters	String	否	自定义参数。字段类型为 json encoded string。如：{"varA": "222"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。如果未提供该参数取值，将使用 Command 的 DefaultParameters 进行替换。自定义参数最多20个。自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。注意：此字段可能返回 null，表示取不到有效值。示例值：{"varA": "222"}

LifecycleHook

生命周期挂钩

被如下接口引用：DescribeLifecycleHooks。

名称	类型	描述
LifecycleHookId	String	生命周期挂钩ID 示例值：ash-ck4bkcjt
LifecycleHookName	String	生命周期挂钩名称示例值：as-hook0
AutoScalingGroupId	String	伸缩组ID 示例值：asg-lk5nn4xi
DefaultResult	String	生命周期挂钩默认结果示例值：CONTINUE
HeartbeatTimeout	Integer	生命周期挂钩等待超时时间示例值：300
LifecycleTransition	String	生命周期挂钩适用场景示例值：INSTANCE_TERMINATING
NotificationMetadata	String	通知目标的附加信息示例值：as-metadata-0
CreatedTime	Timestamp ISO8601	创建时间示例值：2024-11-11T15:29:59Z
NotificationTarget	NotificationTarget	通知目标示例值：{"QueueName": "as-pool", "TargetType": "TDMQ_CMQ_QUEUE"}
LifecycleTransitionType	String	生命周期挂钩适用场景示例值：NORMAL
LifecycleCommand	LifecycleCommand	远程命令执行对象注意：此字段可能返回 null，表示取不到有效值。示例值：{"CommandId": "cmd-am4e3hd8", "Parameters": "{123: 222}"}

LimitedLoginSettings

描述了实例登录相关配置与信息，出于安全性考虑，不会描述敏感信息。

被如下接口引用：DescribeLaunchConfigurations。

名称	类型	描述
KeyIds	Array of String	密钥ID列表。示例值：["skey-jud75er4"]

LoginSettings

描述了实例登录相关配置与信息。

被如下接口引用：CreateLaunchConfiguration, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration。

名称	类型	必选	描述
Password	String	否	实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下： Linux实例密码必须8到16位，至少包括两项[a-z，A-Z]、[0-9] 和 [( ) `~ ! @ # $ % ^ & * - + = \| { } [ ] : ; ' , . ? / ]中的特殊符号。</li><li>Windows实例密码必须12到16位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( )` ~ ! @ # $ % ^ & * - + = { } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到用户。示例值：passExam@!7862543
KeyIds	Array of String	否	密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口DescribeKeyPairs获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。示例值：["skey-ju7fy6t5"]
KeepImageLogin	Boolean	否	保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围： TRUE：表示保持镜像的登录设置 FALSE：表示不保持镜像的登录设置默认取值：FALSE。示例值：false

MetricAlarm

弹性伸缩告警指标

被如下接口引用：CreateScalingPolicy, DescribeScalingPolicies, ModifyScalingPolicy。

名称	类型	必选	描述
ComparisonOperator	String	是	比较运算符，可选值： GREATER_THAN：大于 GREATER_THAN_OR_EQUAL_TO：大于或等于 LESS_THAN：小于 LESS_THAN_OR_EQUAL_TO：小于或等于 EQUAL_TO：等于 NOT_EQUAL_TO：不等于示例值：GREATER_THAN
MetricName	String	是	指标名称，可选字段如下： CPU_UTILIZATION：CPU利用率 MEM_UTILIZATION：内存利用率 LAN_TRAFFIC_OUT：内网出带宽 LAN_TRAFFIC_IN：内网入带宽 WAN_TRAFFIC_OUT：外网出带宽 WAN_TRAFFIC_IN：外网入带宽 TCP_CURR_ESTAB：TCP连接数示例值：CPU_UTILIZATION
Threshold	Integer	是	告警阈值： CPU_UTILIZATION：[1, 100]，单位：% MEM_UTILIZATION：[1, 100]，单位：% LAN_TRAFFIC_OUT：>0，单位：Mbps LAN_TRAFFIC_IN：>0，单位：Mbps WAN_TRAFFIC_OUT：>0，单位：Mbps WAN_TRAFFIC_IN：>0，单位：Mbps TCP_CURR_ESTAB：>0, 单位：Count 示例值：10
Period	Integer	是	时间周期，单位：秒，取值枚举值为60、300。示例值：60
ContinuousTime	Integer	是	重复次数。取值范围 [1, 10] 示例值：3
Statistic	String	否	统计类型，可选字段如下： AVERAGE：平均值 MAXIMUM：最大值 MINIMUM：最小值默认取值：AVERAGE 示例值：AVERAGE
PreciseThreshold	Float	否	精确告警阈值，本参数不作为入参输入，仅用作查询接口出参： CPU_UTILIZATION：(0, 100]，单位：% MEM_UTILIZATION：(0, 100]，单位：% LAN_TRAFFIC_OUT：>0，单位：Mbps LAN_TRAFFIC_IN：>0，单位：Mbps WAN_TRAFFIC_OUT：>0，单位：Mbps WAN_TRAFFIC_IN：>0，单位：Mbps TCP_CURR_ESTAB：>0, 单位：Count 示例值：10.123

NotificationTarget

通知目标

被如下接口引用：CreateLifecycleHook, DescribeLifecycleHooks, ModifyLifecycleHook, UpgradeLifecycleHook。

名称	类型	必选	描述
TargetType	String	是	目标类型，取值范围包括`CMQ_QUEUE`、`CMQ_TOPIC`、`TDMQ_CMQ_QUEUE`、`TDMQ_CMQ_TOPIC`。 CMQ_QUEUE，指腾讯云消息队列-队列模型。 CMQ_TOPIC，指腾讯云消息队列-主题模型。 TDMQ_CMQ_QUEUE，指腾讯云 TDMQ 消息队列-队列模型。 TDMQ_CMQ_TOPIC，指腾讯云 TDMQ 消息队列-主题模型。示例值：TDMQ_CMQ_QUEUE
QueueName	String	否	队列名称，如果`TargetType`取值为`CMQ_QUEUE` 或 `TDMQ_CMQ_QUEUE`，则本字段必填。示例值：test-queue
TopicName	String	否	主题名称，如果`TargetType`取值为`CMQ_TOPIC` 或 `TDMQ_CMQ_TOPIC`，则本字段必填。示例值：test-topic

RefreshActivity

实例刷新活动。

被如下接口引用：DescribeRefreshActivities。

名称	类型	描述
AutoScalingGroupId	String	伸缩组 ID。示例值：asg-t67yhy7u
RefreshActivityId	String	刷新活动 ID。示例值：asr-v8dd7er6
OriginRefreshActivityId	String	原始刷新活动ID，仅在回滚刷新活动中存在。注意：此字段可能返回 null，表示取不到有效值。示例值：asr-v8dd7er6
RefreshBatchSet	Array of RefreshBatch	刷新批次信息列表。示例值： [{"RefreshBatchNum": 1, "EndTime": "2024-11-06T19:01:08Z", "RefreshBatchRelatedInstanceSet": [{"InstanceId": "ins-m30w46cu", "InstanceStatusMessage": "success", "LastActivityId": "asa-dayrcku8", "InstanceStatus": "SUCCESSFUL"}], "StartTime": "2024-11-06T19:00:14Z", "RefreshBatchStatus": "SUCCESSFUL"}]
RefreshMode	String	刷新模式。示例值：ROLLING_UPDATE
RefreshSettings	RefreshSettings	实例更新设置参数。示例值：{"CheckInstanceTargetHealth": true, "RollingUpdateSettings": {"BatchNumber": 1, "MaxSurge": 1, "BatchPause": "AUTOMATIC"}}
ActivityType	String	刷新活动类型。取值如下： NORMAL：正常刷新活动 ROLLBACK：回滚刷新活动示例值：NORMAL
Status	String	刷新活动状态。取值如下： INIT：初始化中 RUNNING：运行中 SUCCESSFUL：活动成功 FAILED_PAUSE：因刷新批次失败暂停 AUTO_PAUSE：因暂停策略自动暂停 MANUAL_PAUSE：手动暂停 CANCELLED：活动取消 FAILED：活动失败示例值：RUNNING
CurrentRefreshBatchNum	Integer	当前刷新批次序号。例如，2 表示当前活动正在刷新第二批次的实例。注意：此字段可能返回 null，表示取不到有效值。示例值：2
StartTime	Timestamp ISO8601	刷新活动开始时间。注意：此字段可能返回 null，表示取不到有效值。示例值：2023-09-04T11:42:46Z
EndTime	Timestamp ISO8601	刷新活动结束时间。注意：此字段可能返回 null，表示取不到有效值。示例值：2023-09-04T11:42:46Z
CreatedTime	Timestamp ISO8601	刷新活动创建时间。注意：此字段可能返回 null，表示取不到有效值。示例值：2023-09-04T11:42:46Z

RefreshBatch

实例刷新批次信息，包含该批次的刷新状态、实例、起止时间等信息。

被如下接口引用：DescribeRefreshActivities。

名称	类型	描述
RefreshBatchNum	Integer	刷新批次序号。例如，2 表示当前批次实例会在第二批次进行实例刷新。示例值：2
RefreshBatchStatus	String	刷新批次状态。取值如下： WAITING：待刷新 INIT：初始化中 RUNNING：刷新中 FAILED: 刷新失败 PARTIALLY_SUCCESSFUL：批次部分成功 CANCELLED：已取消 SUCCESSFUL：刷新成功示例值：WAITING
RefreshBatchRelatedInstanceSet	Array of RefreshBatchRelatedInstance	刷新批次关联实例列表。示例值：[{"InstanceId": "ins-m30w46cu", "InstanceStatusMessage": "success", "LastActivityId": "asa-dayrcku8", "InstanceStatus": "SUCCESSFUL"}]
StartTime	Timestamp ISO8601	刷新批次开始时间。注意：此字段可能返回 null，表示取不到有效值。示例值：2023-08-31T11:46:40Z
EndTime	Timestamp ISO8601	刷新批次结束时间。注意：此字段可能返回 null，表示取不到有效值。示例值：2023-08-31T11:46:40Z

RefreshBatchRelatedInstance

刷新批次关联实例，包含单个实例的刷新活动状态、对应伸缩活动等信息。

被如下接口引用：DescribeRefreshActivities。

名称	类型	描述
InstanceId	String	实例 ID。示例值：ins-d73gg3yt
InstanceStatus	String	刷新实例状态。如果在刷新时实例被移出或销毁，状态会更新为 NOT_FOUND。取值如下： WAITING：待刷新 INIT：初始化中 RUNNING：刷新中 FAILED：刷新失败 CANCELLED：已取消 SUCCESSFUL：刷新成功 NOT_FOUND：实例不存在示例值：WAITING
LastActivityId	String	实例刷新中最近一次伸缩活动 ID，可通过 DescribeAutoScalingActivities 接口查询。需注意伸缩活动与实例刷新活动不同，一次实例刷新活动可能包括多次伸缩活动。注意：此字段可能返回 null，表示取不到有效值。示例值：asa-7y5rey56
InstanceStatusMessage	String	实例刷新状态信息。注意：此字段可能返回 null，表示取不到有效值。示例值：success

RefreshSettings

实例刷新设置。

被如下接口引用：DescribeRefreshActivities, RollbackInstanceRefresh, StartInstanceRefresh。

名称	类型	必选	描述
RollingUpdateSettings	RollingUpdateSettings	是	滚动更新设置参数。RefreshMode 为滚动更新该参数必须填写。注意：此字段可能返回 null，表示取不到有效值。示例值：{"BatchNumber": 1, "MaxSurge": 1, "BatchPause": "AUTOMATIC"}
CheckInstanceTargetHealth	Boolean	否	实例后端服务健康状态检查，默认为 FALSE。仅针对绑定应用型负载均衡器的伸缩组生效，开启该检查后，如刷新后实例未通过检查，负载均衡器端口权重始终为 0，且标记为刷新失败。取值范围如下： TRUE：开启检查 FALSE：不开启检查示例值：TRUE

RelatedInstance

与本次伸缩活动相关的实例信息。

被如下接口引用：DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities。

名称	类型	描述
InstanceId	String	实例ID。示例值：ins-d7y6drte
InstanceStatus	String	实例在伸缩活动中的状态。取值如下： INIT：初始化中 RUNNING：实例操作中 SUCCESSFUL：活动成功 FAILED：活动失败示例值：RUNNING

RollingUpdateSettings

滚动更新设置。

被如下接口引用：DescribeRefreshActivities, RollbackInstanceRefresh, StartInstanceRefresh。

名称	类型	必选	描述
BatchNumber	Integer	是	批次数量。批次数量为大于 0 的正整数，但不能大于待刷新实例数量。示例值：1
BatchPause	String	否	批次间暂停策略。默认值为 Automatic，取值范围如下： FIRST_BATCH_PAUSE：第一批次更新完成后暂停 BATCH_INTERVAL_PAUSE：批次间暂停 AUTOMATIC：不暂停示例值：Automatic
MaxSurge	Integer	否	最大额外数量。设置该参数后，在滚动更新开始前根据启动配置创建一批按量计费的额外实例，滚动更新完成后销毁额外实例。该参数用于保证滚动更新过程中可用实例的数量，最大额外数量不能超过滚动更新单个批次的刷新实例数。回滚流程暂不支持该参数。示例值：1

RunAutomationServiceEnabled

描述了 “自动化助手” 服务相关的信息

被如下接口引用：CreateLaunchConfiguration, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration。

名称	类型	必选	描述
Enabled	Boolean	否	是否开启自动化助手服务。取值范围： TRUE：表示开启自动化助手服务 FALSE：表示不开启自动化助手服务注意：此字段可能返回 null，表示取不到有效值。示例值：True

RunMonitorServiceEnabled

描述了 “云监控” 服务相关的信息。

被如下接口引用：CreateLaunchConfiguration, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration。

名称	类型	必选	描述
Enabled	Boolean	否	是否开启云监控服务。取值范围： TRUE：表示开启云监控服务 FALSE：表示不开启云监控服务默认取值：TRUE。注意：此字段可能返回 null，表示取不到有效值。示例值：{"Enabled": true}

RunSecurityServiceEnabled

描述了 “云安全” 服务相关的信息

被如下接口引用：CreateLaunchConfiguration, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration。

名称	类型	必选	描述
Enabled	Boolean	否	是否开启云安全服务。取值范围： TRUE：表示开启云安全服务 FALSE：表示不开启云安全服务默认取值：TRUE。注意：此字段可能返回 null，表示取不到有效值。示例值：{"Enabled": true}

ScalingPolicy

告警触发策略。

被如下接口引用：DescribeScalingPolicies。

名称	类型	描述
AutoScalingGroupId	String	伸缩组ID。示例值：asg-12345678
AutoScalingPolicyId	String	告警触发策略ID。示例值：asp-12345678
ScalingPolicyType	String	告警触发策略类型。取值： - SIMPLE：简单策略 - TARGET_TRACKING：目标追踪策略示例值：SIMPLE
ScalingPolicyName	String	告警触发策略名称。示例值：test-asp
AdjustmentType	String	告警触发后，期望实例数修改方式，仅适用于简单策略。取值范围： CHANGE_IN_CAPACITY：增加或减少若干期望实例数 EXACT_CAPACITY：调整至指定期望实例数 PERCENT_CHANGE_IN_CAPACITY：按百分比调整期望实例数示例值：CHANGE_IN_CAPACITY
AdjustmentValue	Integer	告警触发后，期望实例数的调整值，仅适用于简单策略。示例值：2
Cooldown	Integer	冷却时间，仅适用于简单策略。示例值：60
MetricAlarm	MetricAlarm	简单告警触发策略告警监控指标，仅适用于简单策略。示例值：{"ComparisonOperator": "GREATER_THAN", "ContinuousTime": 1, "MetricName": "CPU_UTILIZATION", "Period": 60, "Statistic": "AVERAGE", "Threshold": 15}
PredefinedMetricType	String	预定义监控项，仅适用于目标追踪策略。取值范围： 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，表示取不到有效值。示例值：ASG_AVG_CPU_UTILIZATION
TargetValue	Integer	目标值，仅适用于目标追踪策略。 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 注意：此字段可能返回 null，表示取不到有效值。示例值：10
EstimatedInstanceWarmup	Integer	实例预热时间，单位为秒，仅适用于目标追踪策略。取值范围为0-3600。注意：此字段可能返回 null，表示取不到有效值。示例值：300
DisableScaleIn	Boolean	是否禁用缩容，仅适用于目标追踪策略。取值范围： true：目标追踪策略仅触发扩容 false：目标追踪策略触发扩容和缩容注意：此字段可能返回 null，表示取不到有效值。示例值：false
MetricAlarms	Array of MetricAlarm	告警监控指标列表，仅适用于目标追踪策略。注意：此字段可能返回 null，表示取不到有效值。示例值：{"ComparisonOperator": "GREATER_THAN", "Period": 300, "ContinuousTime": 1, "Threshold": 35, "Statistic": "AVERAGE", "PreciseThreshold": 35.0, "MetricName": "CPU_UTILIZATION"}
NotificationUserGroupIds	Array of String	通知组ID，即为用户组ID集合。示例值：["12001"]

ScheduledAction

描述定时任务的信息

被如下接口引用：DescribeScheduledActions。

名称	类型	描述
ScheduledActionId	String	定时任务ID。示例值：asst-jf898dps
ScheduledActionName	String	定时任务名称。示例值：as-sche-action-0
AutoScalingGroupId	String	定时任务所在伸缩组ID。示例值：asg-keqt9eg1
StartTime	Timestamp ISO8601	定时任务的开始时间。取值为`北京时间`（UTC+8），按照`ISO8601`标准，格式：`YYYY-MM-DDThh:mm:ss+08:00`。示例值：2022-02-22T16:00:00+08:00
Recurrence	String	定时任务的重复方式。示例值：0 23 /1 *
EndTime	Timestamp ISO8601	定时任务的结束时间。取值为`北京时间`（UTC+8），按照`ISO8601`标准，格式：`YYYY-MM-DDThh:mm:ss+08:00`。示例值：2023-02-23T16:00:00+08:00
MaxSize	Integer	定时任务设置的最大实例数。示例值：20
DesiredCapacity	Integer	定时任务设置的期望实例数。示例值：5
MinSize	Integer	定时任务设置的最小实例数。示例值：1
CreatedTime	Timestamp ISO8601	定时任务的创建时间。取值为`UTC`时间，按照`ISO8601`标准，格式：`YYYY-MM-DDThh:mm:ssZ`。示例值：2022-02-21T02:19:52Z
ScheduledType	String	定时任务的执行类型。取值范围： CRONTAB：代表定时任务为重复执行。 ONCE：代表定时任务为单次执行。示例值：CRONTAB

ServiceSettings

服务设置

被如下接口引用：CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyAutoScalingGroup。

名称	类型	必选	描述
ReplaceMonitorUnhealthy	Boolean	否	开启监控不健康替换服务。若开启则对于云监控标记为不健康的实例，弹性伸缩服务会进行替换。若不指定该参数，则默认为 False。示例值：False
ScalingMode	String	否	取值范围： CLASSIC_SCALING：经典方式，使用创建、销毁实例来实现扩缩容； WAKE_UP_STOPPED_SCALING：扩容优先开机。扩容时优先对已关机的实例执行开机操作，若开机后实例数仍低于期望实例数，则创建实例，缩容仍采用销毁实例的方式。用户可以使用StopAutoScalingInstances接口来关闭伸缩组内的实例。监控告警触发的扩容仍将创建实例默认取值：CLASSIC_SCALING 示例值：CLASSIC_SCALING
ReplaceLoadBalancerUnhealthy	Boolean	否	开启负载均衡不健康替换服务。若开启则对于负载均衡健康检查判断不健康的实例，弹性伸缩服务会进行替换。若不指定该参数，则默认为 False。示例值：False
ReplaceMode	String	否	不健康替换服务的替换模式。取值范围： RECREATE：重建实例替代原有不健康实例； RESET：对原有不健康实例进行重装系统操作，可保持数据盘、内网IP、实例id等信息不发生变化，实例登录设置、主机名、增强服务和 UserData 与当前启动配置保持一致。默认取值：RECREATE 注意：此字段可能返回 null，表示取不到有效值。示例值：RECREATE

SpotMarketOptions

竞价相关选项

被如下接口引用：CreateLaunchConfiguration, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration。

名称	类型	必选	描述
MaxPrice	String	是	竞价出价，例如“1.05” 示例值：1.05
SpotInstanceType	String	否	竞价请求类型，当前仅支持类型：one-time，默认值为one-time 注意：此字段可能返回 null，表示取不到有效值。示例值：one-time

SpotMixedAllocationPolicy

竞价混合模式下，各计费类型实例的分配策略。包括按量计费实例和竞价计费实例。

被如下接口引用：CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyAutoScalingGroup。

名称	类型	必选	描述
BaseCapacity	Integer	否	混合模式下，基础容量的大小，基础容量部分固定为按量计费实例。默认值 0，最大不可超过伸缩组的最大实例数。注意：此字段可能返回 null，表示取不到有效值。示例值：0
OnDemandPercentageAboveBaseCapacity	Integer	否	超出基础容量部分，按量计费实例所占的比例。取值范围 [0, 100]，0 代表超出基础容量的部分仅生产竞价实例，100 代表仅生产按量实例，默认值为 70。按百分比计算按量实例数时，向上取整。比如，总期望实例数取 3，基础容量取 1，超基础部分按量百分比取 1，则最终按量 2 台（1 台来自基础容量，1 台按百分比向上取整得到），竞价 1台。注意：此字段可能返回 null，表示取不到有效值。示例值：0
SpotAllocationStrategy	String	否	混合模式下，竞价实例的分配策略。取值包括 COST_OPTIMIZED 和 CAPACITY_OPTIMIZED，默认取 COST_OPTIMIZED。 COST_OPTIMIZED，成本优化策略。对于启动配置内的所有机型，按照各机型在各可用区的每核单价由小到大依次尝试。优先尝试购买每核单价最便宜的，如果购买失败则尝试购买次便宜的，以此类推。 CAPACITY_OPTIMIZED，容量优化策略。对于启动配置内的所有机型，按照各机型在各可用区的库存情况由大到小依次尝试。优先尝试购买剩余库存最大的机型，这样可尽量降低竞价实例被动回收的发生概率。注意：此字段可能返回 null，表示取不到有效值。示例值：COST_OPTIMIZED
CompensateWithBaseInstance	Boolean	否	按量实例替补功能。取值范围： TRUE，开启该功能，当所有竞价机型因库存不足等原因全部购买失败后，尝试购买按量实例。 FALSE，不开启该功能，伸缩组在需要扩容竞价实例时仅尝试所配置的竞价机型。默认取值： TRUE。注意：此字段可能返回 null，表示取不到有效值。示例值：false

SystemDisk

启动配置的系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。

被如下接口引用：CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration。

名称	类型	必选	描述
DiskType	String	否	系统盘类型。系统盘类型限制详见云硬盘类型。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_SSD：SSD云硬盘默认取值：CLOUD_PREMIUM。注意：此字段可能返回 null，表示取不到有效值。示例值：CLOUD_PREMIUM
DiskSize	Integer	否	系统盘大小，单位：GB。默认值为 50 注意：此字段可能返回 null，表示取不到有效值。示例值：50

Tag

资源类型及标签键值对

被如下接口引用：CreateAutoScalingGroup, CreateLaunchConfiguration, DescribeAutoScalingGroups, DescribeLaunchConfigurations。

名称	类型	必选	描述
Key	String	是	标签键示例值：as-group-tag0
Value	String	是	标签值示例值：app0
ResourceType	String	否	标签绑定的资源类型，当前支持类型："auto-scaling-group", "launch-configuration" 注意：此字段可能返回 null，表示取不到有效值。示例值：auto-scaling-group

TargetAttribute

负载均衡器目标属性

被如下接口引用：AttachLoadBalancers, CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyLoadBalancerTargetAttributes, ModifyLoadBalancers。

名称	类型	必选	描述
Port	Integer	是	端口示例值：80
Weight	Integer	是	权重示例值：10

数据结构

本页目录：

Activity

Advice

AutoScalingAdvice

AutoScalingGroup

AutoScalingGroupAbstract

AutoScalingNotification

DataDisk

DetailedStatusMessage

EnhancedService

Filter

ForwardLoadBalancer

ForwardLoadBalancerIdentification

HostNameSettings

IPv6InternetAccessible

Instance

InstanceChargePrepaid

InstanceMarketOptionsRequest

InstanceNameIndexSettings

InstanceNameSettings

InstanceTag

InternetAccessible

InvocationResult

LaunchConfiguration

LifecycleActionResultInfo

LifecycleCommand

LifecycleHook

LimitedLoginSettings

LoginSettings

MetricAlarm

NotificationTarget

RefreshActivity

RefreshBatch

RefreshBatchRelatedInstance

RefreshSettings

RelatedInstance

RollingUpdateSettings

RunAutomationServiceEnabled

RunMonitorServiceEnabled

RunSecurityServiceEnabled

ScalingPolicy

ScheduledAction

ServiceSettings

SpotMarketOptions

SpotMixedAllocationPolicy

SystemDisk

Tag

TargetAttribute