数据结构
最近更新时间: 2025-01-20 17:15:21
InternetAccessible
描述了启动配置创建实例的公网可访问性,声明了实例的公网使用计费模式,最大带宽等
被如下接口引用:CreateLaunchConfiguration、CreatePaiInstance、DescribeLaunchConfigurations、UpgradeLaunchConfiguration
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
InternetChargeType | 否 | 是 | String | 网络计费类型。取值范围:<br><li>BANDWIDTH_PREPAID:预付费按带宽结算<br><li>TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费<br><li>BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费<br><li>BANDWIDTH_PACKAGE:带宽包用户<br>默认取值:TRAFFIC_POSTPAID_BY_HOUR。 |
InternetMaxBandwidthOut | 否 | 是 | Uint64 | 公网出带宽上限,单位:Mbps。默认值:0Mbps。不同机型带宽上限范围不一致。 |
PublicIpAssigned | 否 | 是 | Bool | 是否分配公网IP。取值范围:<br><li>TRUE:表示分配公网IP<br><li>FALSE:表示不分配公网IP<br><br>当公网带宽大于0Mbps时,可自由选择开通与否,默认开通公网IP;当公网带宽为0,则不允许分配公网IP。 |
ActivtyRelatedInstance
与本次伸缩活动相关的实例信息。
被如下接口引用:DescribeAutoScalingActivities、DescribeAutoScalingGroupLastActivities
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
InstanceId | 是 | 否 | String | 实例ID。 |
InstanceStatus | 是 | 否 | String | 实例在伸缩活动中的状态。取值如下:<li>INIT:初始化中<li>RUNNING:实例操作中<li>SUCCESSFUL:活动成功<li>FAILED:活动失败 |
EnhancedService
描述了实例的增强服务启用情况与其设置,如云安全,云监控等实例 Agent。
被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
SecurityService | 否 | 否 | RunSecurityServiceEnabled | 开启云安全服务。若不指定该参数,则默认开启云安全服务。 |
MonitorService | 否 | 否 | RunMonitorServiceEnabled | 开启云监控服务。若不指定该参数,则默认开启云监控服务。 |
DataDisk
启动配置的数据盘配置信息。若不指定该参数,则默认不购买数据盘,当前仅支持购买的时候指定一个数据盘。
被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
DiskType | 否 | 是 | String | 数据盘类型。取值范围:<br><li>LOCAL_BASIC:本地硬盘<br><li>LOCAL_SSD:本地SSD硬盘<br><li>CLOUD_BASIC:普通云硬盘<br><li>CLOUD_PREMIUM:高性能云硬盘<br><li>CLOUD_SSD:SSD云硬盘<br><br>默认取值:LOCAL_BASIC。 |
DiskSize | 否 | 是 | Uint64 | 数据盘大小,单位:GB。最小调整步长为10G,不同数据盘类型取值范围不同。默认值为0,表示不购买数据盘。更多限制详见产品文档。 |
SnapshotId | 否 | 是 | String | 数据盘快照 ID,类似 snap-l8psqwnt 。 |
SystemDisk
启动配置的系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
DiskType | 是 | 是 | String | 系统盘类型。取值范围:<br><li>LOCAL_BASIC:本地硬盘<br><li>LOCAL_SSD:本地SSD硬盘<br><li>CLOUD_BASIC:普通云硬盘<br><li>CLOUD_PREMIUM:高性能云硬盘<br><li>CLOUD_SSD:SSD云硬盘<br><br>默认取值:LOCAL_BASIC。 |
DiskSize | 否 | 是 | Uint64 | 系统盘大小,单位:GB。默认值为 50 |
ScheduledAction
描述定时任务的信息
被如下接口引用:DescribeScheduledActions
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ScheduledActionId | 是 | 否 | String | 定时任务ID。 |
ScheduledActionName | 是 | 否 | String | 定时任务名称。 |
AutoScalingGroupId | 是 | 否 | String | 定时任务所在伸缩组ID。 |
StartTime | 是 | 否 | Datetime_iso | 定时任务的开始时间。取值为北京时间 (UTC+8),按照ISO8601 标准,格式:YYYY-MM-DDThh:mm:ss+08:00 。 |
Recurrence | 是 | 否 | String | 定时任务的重复方式。 |
EndTime | 是 | 否 | Datetime_iso | 定时任务的结束时间。取值为北京时间 (UTC+8),按照ISO8601 标准,格式:YYYY-MM-DDThh:mm:ss+08:00 。 |
MaxSize | 是 | 否 | Uint64 | 定时任务设置的最大实例数。 |
DesiredCapacity | 是 | 否 | Uint64 | 定时任务设置的期望实例数。 |
MinSize | 是 | 否 | Uint64 | 定时任务设置的最小实例数。 |
CreatedTime | 是 | 否 | Datetime_iso | 定时任务的创建时间。取值为UTC 时间,按照ISO8601 标准,格式:YYYY-MM-DDThh:mm:ssZ 。 |
AutoScalingGroupAbstract
伸缩组简明信息。
被如下接口引用:DescribeLaunchConfigurations
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AutoScalingGroupId | 是 | 否 | String | 伸缩组ID。 |
AutoScalingGroupName | 是 | 否 | String | 伸缩组名称。 |
LifecycleActionResultInfo
生命周期挂钩动作的执行结果信息。
被如下接口引用:DescribeAutoScalingActivities、DescribeAutoScalingGroupLastActivities
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
LifecycleHookId | 是 | 否 | String | 生命周期挂钩标识。 |
InstanceId | 是 | 否 | String | 实例标识。 |
NotificationResult | 是 | 否 | String | 通知的结果,表示通知CMQ是否成功。 |
LifecycleActionResult | 是 | 否 | String | 生命周期挂钩动作的执行结果,取值包括 CONTINUE、ABANDON。 |
ResultReason | 是 | 否 | String | 结果的原因。 |
TargetAttribute
负载均衡器目标属性
被如下接口引用:CreateAutoScalingGroup、DescribeAutoScalingGroups、ModifyLoadBalancers
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Port | 是 | 否 | Uint64 | 端口 |
Weight | 是 | 否 | Uint64 | 权重 |
LifecycleHook
生命周期挂钩
被如下接口引用:DescribeLifecycleHooks
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
LifecycleHookId | 是 | 否 | String | 生命周期挂钩ID |
LifecycleHookName | 是 | 否 | String | 生命周期挂钩名称 |
AutoScalingGroupId | 是 | 否 | String | 伸缩组ID |
DefaultResult | 是 | 否 | String | 生命周期挂钩默认结果 |
HeartbeatTimeout | 是 | 否 | Int64 | 生命周期挂钩等待超时时间 |
LifecycleTransition | 是 | 否 | String | 生命周期挂钩适用场景 |
NotificationMetadata | 是 | 否 | String | 通知目标的附加信息 |
CreatedTime | 是 | 否 | Datetime_iso | 创建时间 |
NotificationTarget | 是 | 否 | NotificationTarget | 通知目标 |
LifecycleTransitionType | 是 | 否 | String | 生命周期挂钩场景类型 |
HostNameSettings
云服务器主机名(HostName)的相关设置
被如下接口引用:DescribeLaunchConfigurations
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
HostName | 是 | 是 | String | 云服务器的主机名。<br><li> 点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。<br><li> 不支持 Windows 实例。<br><li> 其他类型(Linux 等)实例:字符长度为[2, 40],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。 |
HostNameStyle | 否 | 是 | String | 云服务器主机名的风格,取值范围包括 ORIGINAL 和 UNIQUE,默认为 ORIGINAL。<br><li> ORIGINAL,AS 直接将入参中所填的 HostName 传递给 CVM,CVM 可能会对 HostName 追加序列号,伸缩组中实例的 HostName 会出现冲突的情况。<br><li> UNIQUE,入参所填的 HostName 相当于主机名前缀,AS 和 CVM 会对其进行拓展,伸缩组中实例的 HostName 可以保证唯一。 |
AutoScalingGroup
伸缩组
被如下接口引用:DescribeAutoScalingGroups
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AutoScalingGroupId | 是 | 否 | String | 伸缩组ID |
AutoScalingGroupName | 是 | 否 | String | 伸缩组名称 |
AutoScalingGroupStatus | 是 | 否 | String | 伸缩组当前状态。取值范围:<br><li>NORMAL:正常<br><li>CVM_ABNORMAL:启动配置异常<br><li>LB_ABNORMAL:负载均衡器异常<br><li>VPC_ABNORMAL:VPC网络异常<br><li>INSUFFICIENT_BALANCE:余额不足<br> |
CreatedTime | 是 | 否 | Datetime_iso | 创建时间,采用UTC标准计时 |
DefaultCooldown | 是 | 否 | Int64 | 默认冷却时间,单位秒 |
DesiredCapacity | 是 | 否 | Int64 | 期望实例数 |
EnabledStatus | 是 | 否 | String | 启用状态,取值包括ENABLED 和DISABLED |
ForwardLoadBalancerSet | 是 | 否 | Array of ForwardLoadBalancer | 应用型负载均衡器列表 |
InstanceCount | 是 | 否 | Int64 | 实例数量 |
InServiceInstanceCount | 是 | 否 | Int64 | 状态为IN_SERVICE 实例的数量 |
LaunchConfigurationId | 是 | 否 | String | 启动配置ID |
LaunchConfigurationName | 是 | 否 | String | 启动配置名称 |
LoadBalancerIdSet | 是 | 否 | Array of String | 传统型负载均衡器ID列表 |
MaxSize | 是 | 否 | Int64 | 最大实例数 |
MinSize | 是 | 否 | Int64 | 最小实例数 |
ProjectId | 是 | 否 | Int64 | 项目ID |
SubnetIdSet | 是 | 否 | Array of String | 子网ID列表 |
TerminationPolicySet | 是 | 否 | Array of String | 销毁策略 |
VpcId | 是 | 否 | String | VPC标识 |
ZoneSet | 是 | 否 | Array of String | 可用区列表 |
RetryPolicy | 是 | 否 | String | 重试策略 |
InActivityStatus | 是 | 否 | String | 伸缩组是否处于伸缩活动中,IN_ACTIVITY 表示处于伸缩活动中,NOT_IN_ACTIVITY 表示不处于伸缩活动中。 |
Tags | 是 | 否 | Array of Tag | 伸缩组标签列表 |
ServiceSettings | 是 | 否 | ServiceSettings | 服务设置 |
Ipv6AddressCount | 是 | 否 | Int64 | 实例具有IPv6地址数量的配置 |
MultiZoneSubnetPolicy | 是 | 否 | String | 多可用区/子网策略。<br><li> PRIORITY,按照可用区/子网列表的顺序,作为优先级来尝试创建实例,如果优先级最高的可用区/子网可以创建成功,则总在该可用区/子网创建。<br><li> EQUALITY:每次选择当前实例数最少的可用区/子网进行扩容,使得每个可用区/子网都有机会发生扩容,多次扩容出的实例会打散到多个可用区/子网。 |
AutoScalingNotification
弹性伸缩事件通知
被如下接口引用:DescribeNotificationConfigurations
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AutoScalingGroupId | 是 | 否 | String | 伸缩组ID。 |
NotificationUserGroupIds | 是 | 否 | Array of String | 用户组ID列表。 |
NotificationTypes | 是 | 否 | Array of String | 通知事件列表。 |
AutoScalingNotificationId | 是 | 否 | String | 事件通知ID。 |
ScalingPolicy
告警触发策略。
被如下接口引用:DescribeScalingPolicies
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AutoScalingGroupId | 是 | 否 | String | 伸缩组ID。 |
AutoScalingPolicyId | 是 | 否 | String | 告警触发策略ID。 |
ScalingPolicyName | 是 | 否 | String | 告警触发策略名称。 |
AdjustmentType | 是 | 否 | String | 告警触发后,期望实例数修改方式。取值 :<br><li>CHANGE_IN_CAPACITY:增加或减少若干期望实例数</li><li>EXACT_CAPACITY:调整至指定期望实例数</li> <li>PERCENT_CHANGE_IN_CAPACITY:按百分比调整期望实例数</li> |
AdjustmentValue | 是 | 否 | Int64 | 告警触发后,期望实例数的调整值。 |
Cooldown | 是 | 否 | Uint64 | 冷却时间。 |
MetricAlarm | 是 | 否 | MetricAlarm | 告警监控指标。 |
NotificationUserGroupIds | 是 | 否 | Array of String | 通知组ID,即为用户组ID集合。 |
MetricAlarm
弹性伸缩告警指标
被如下接口引用:CreateScalingPolicy、DescribeScalingPolicies、ModifyScalingPolicy
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ComparisonOperator | 是 | 否 | String | 比较运算符,可选值:<br><li>GREATER_THAN:大于</li><li>GREATER_THAN_OR_EQUAL_TO:大于或等于</li><li>LESS_THAN:小于</li><li> LESS_THAN_OR_EQUAL_TO:小于或等于</li><li> EQUAL_TO:等于</li> <li>NOT_EQUAL_TO:不等于</li> |
MetricName | 是 | 否 | String | 指标名称,可选字段如下:<br><li>CPU_UTILIZATION:CPU利用率</li><li>MEM_UTILIZATION:内存利用率</li><li>LAN_TRAFFIC_OUT:内网出带宽</li><li>LAN_TRAFFIC_IN:内网入带宽</li><li>WAN_TRAFFIC_OUT:外网出带宽</li><li>WAN_TRAFFIC_IN:外网入带宽</li> |
Statistic | 否 | 否 | String | 统计类型,可选字段如下:<br><li>AVERAGE:平均值</li><li>MAXIMUM:最大值<li>MINIMUM:最小值</li><br> 默认取值:AVERAGE |
Threshold | 是 | 否 | Uint64 | 告警阈值:<br><li>CPU_UTILIZATION:[1, 100],单位:%</li><li>MEM_UTILIZATION:[1, 100],单位:%</li><li>LAN_TRAFFIC_OUT:>0,单位:Mbps </li><li>LAN_TRAFFIC_IN:>0,单位:Mbps</li><li>WAN_TRAFFIC_OUT:>0,单位:Mbps</li><li>WAN_TRAFFIC_IN:>0,单位:Mbps</li> |
Period | 是 | 否 | Uint64 | 时间周期,单位:秒,取值枚举值为60、300。 |
ContinuousTime | 是 | 否 | Uint64 | 重复次数。取值范围 [1, 10] |
LimitedLoginSettings
描述了实例登录相关配置与信息,出于安全性考虑,不会描述敏感信息。
被如下接口引用:DescribeLaunchConfigurations
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
KeyIds | 是 | 否 | Array of String | 密钥ID列表。 |
NotificationTarget
通知目标
被如下接口引用:CreateLifecycleHook、DescribeLifecycleHooks、UpgradeLifecycleHook
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
TargetType | 是 | 否 | String | 目标类型,取值范围包括CMQ_QUEUE 、CMQ_TOPIC 。<li> CMQ_QUEUE,指腾讯云消息队列-队列模型。</li><li> CMQ_TOPIC,指腾讯云消息队列-主题模型。</li> |
QueueName | 否 | 否 | String | 队列名称,如果TargetType 取值为CMQ_QUEUE ,则本字段必填。 |
TopicName | 否 | 否 | String | 主题名称,如果TargetType 取值为CMQ_TOPIC ,则本字段必填。 |
RunMonitorServiceEnabled
描述了 “云监控” 服务相关的信息。
被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Enabled | 否 | 是 | Bool | 是否开启云监控服务。取值范围:<br><li>TRUE:表示开启云监控服务<br><li>FALSE:表示不开启云监控服务<br><br>默认取值:TRUE。 |
InstanceChargePrepaid
描述了了实例的计费模式
被如下接口引用:CreatePaiInstance、DescribeLaunchConfigurations
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Period | 是 | 否 | Int64 | 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。 |
RenewFlag | 否 | 否 | String | 自动续费标识。取值范围:<br><li>NOTIFY_AND_AUTO_RENEW:通知过期且自动续费<br><li>NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费<br><li>DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费<br><br>默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。 |
LoginSettings
描述了实例登录相关配置与信息。
被如下接口引用:CreateLaunchConfiguration、CreatePaiInstance、UpgradeLaunchConfiguration
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Password | 否 | 是 | String | 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:<br><li>Linux实例密码必须8到16位,至少包括两项[a-z,A-Z]、[0-9] 和 [( ) ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。<br><li>Windows实例密码必须12到16位,至少包括三项[a-z],[A-Z],[0-9] 和 [( ) ~ ! @ # $ % ^ & * - + = { } [ ] : ; ' , . ? /]中的特殊符号。<br><br>若不指定该参数,则由系统随机生成密码,并通过站内信方式通知到用户。 |
KeyIds | 否 | 否 | Array of String | 密钥ID列表。关联密钥后,就可以通过对应的私钥来访问实例;KeyId可通过接口DescribeKeyPairs获取,密钥与密码不能同时指定,同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。 |
KeepImageLogin | 否 | 是 | Bool | 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围:<br><li>TRUE:表示保持镜像的登录设置<br><li>FALSE:表示不保持镜像的登录设置<br><br>默认取值:FALSE。 |
LaunchConfiguration
符合条件的启动配置信息的集合。
被如下接口引用:DescribeLaunchConfigurations
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ProjectId | 是 | 否 | Int64 | 实例所属项目ID。 |
LaunchConfigurationId | 是 | 否 | String | 启动配置ID。 |
LaunchConfigurationName | 是 | 否 | String | 启动配置名称。 |
InstanceType | 是 | 否 | String | 实例机型。 |
SystemDisk | 是 | 否 | SystemDisk | 实例系统盘配置信息。 |
DataDisks | 是 | 否 | Array of DataDisk | 实例数据盘配置信息。 |
LoginSettings | 是 | 否 | LimitedLoginSettings | 实例登录设置。 |
InternetAccessible | 是 | 否 | InternetAccessible | 公网带宽相关信息设置。 |
SecurityGroupIds | 是 | 否 | Array of String | 实例所属安全组。 |
AutoScalingGroupAbstractSet | 是 | 否 | Array of AutoScalingGroupAbstract | 启动配置关联的伸缩组。 |
UserData | 是 | 是 | String | 自定义数据。 |
CreatedTime | 是 | 否 | Datetime_iso | 启动配置创建时间。 |
EnhancedService | 是 | 否 | EnhancedService | 实例的增强服务启用情况与其设置。 |
ImageId | 是 | 否 | String | 镜像ID。 |
LaunchConfigurationStatus | 是 | 否 | String | 启动配置当前状态。取值范围:<br><li>NORMAL:正常<br><li>IMAGE_ABNORMAL:启动配置镜像异常<br><li>CBS_SNAP_ABNORMAL:启动配置数据盘快照异常<br><li>SECURITY_GROUP_ABNORMAL:启动配置安全组异常<br> |
InstanceChargeType | 是 | 否 | String | 实例计费类型,CVM默认值按照POSTPAID_BY_HOUR处理。<br><li>POSTPAID_BY_HOUR:按小时后付费<br><li>SPOTPAID:竞价付费 |
InstanceMarketOptions | 是 | 是 | InstanceMarketOptionsRequest | 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。 |
InstanceTypes | 是 | 否 | Array of String | 实例机型列表。 |
InstanceTags | 是 | 否 | Array of InstanceTag | 标签列表。 |
VersionNumber | 是 | 否 | Int64 | 版本号。 |
UpdatedTime | 是 | 否 | Datetime_iso | 更新时间。 |
CamRoleName | 是 | 否 | String | CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。 |
LastOperationInstanceTypesCheckPolicy | 是 | 否 | String | 上次操作时,InstanceTypesCheckPolicy 取值。 |
HostNameSettings | 是 | 否 | HostNameSettings | 云服务器主机名(HostName)的相关设置。 |
InstanceNameSettings | 是 | 否 | InstanceNameSettings | 云服务器实例名(InstanceName)的相关设置。 |
InstanceChargePrepaid | 是 | 否 | InstanceChargePrepaid | 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。 |
SpotMarketOptions
竞价相关选项
被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
MaxPrice | 是 | 否 | String | 竞价出价,例如“1.05” |
SpotInstanceType | 否 | 是 | String | 竞价请求类型,当前仅支持类型:one-time,默认值为one-time |
Tag
资源类型及标签键值对
被如下接口引用:CreateAutoScalingGroup、DescribeAutoScalingGroups
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ResourceType | 否 | 是 | String | 标签绑定的资源类型,当前支持类型:"auto-scaling-group |
Key | 是 | 否 | String | 标签键 |
Value | 是 | 否 | String | 标签值 |
RunSecurityServiceEnabled
描述了 “云安全” 服务相关的信息
被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Enabled | 否 | 是 | Bool | 是否开启云安全服务。取值范围:<br><li>TRUE:表示开启云安全服务<br><li>FALSE:表示不开启云安全服务<br><br>默认取值:TRUE。 |
Instance
实例信息
被如下接口引用:DescribeAutoScalingInstances
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
InstanceId | 是 | 否 | String | 实例ID |
AutoScalingGroupId | 是 | 否 | String | 伸缩组ID |
LaunchConfigurationId | 是 | 否 | String | 启动配置ID |
LaunchConfigurationName | 是 | 否 | String | 启动配置名称 |
LifeCycleState | 是 | 否 | String | 生命周期状态,取值包括IN_SERVICE, CREATING, TERMINATING, ATTACHING, DETACHING, ATTACHING_LB, DETACHING_LB等 |
HealthStatus | 是 | 否 | String | 健康状态,取值包括HEALTHY和UNHEALTHY |
ProtectedFromScaleIn | 是 | 否 | Bool | 是否加入缩容保护 |
Zone | 是 | 否 | String | 可用区 |
CreationType | 是 | 否 | String | 创建类型,取值包括AUTO_CREATION, MANUAL_ATTACHING。 |
AddTime | 是 | 否 | Datetime_iso | 实例加入时间 |
InstanceType | 是 | 否 | String | 实例类型 |
VersionNumber | 是 | 否 | Int64 | 版本号 |
AutoScalingGroupName | 是 | 否 | String | 伸缩组名称 |
Filter
>描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等
> * 若存在多个Filter
时,Filter
间的关系为逻辑与(AND
)关系。
> * 若同一个Filter
存在多个Values
,同一Filter
下Values
间的关系为逻辑或(OR
)关系。
>
> 以DescribeInstances接口的Filter
为例。若我们需要查询可用区(zone
)为广州一区 并且 实例计费模式(instance-charge-type
)为包年包月 或者 按量计费的实例时,可如下实现:
Filters.0.Name=zone
&Filters.0.Values.1=ap-guangzhou-1
&Filters.1.Name=instance-charge-type
&Filters.1.Values.1=PREPAID
&Filters.1.Values.2=POSTPAID_BY_HOUR
被如下接口引用:DescribeAutoScalingActivities、DescribeAutoScalingGroups、DescribeAutoScalingInstances、DescribeLaunchConfigurations、DescribeLifecycleHooks、DescribeNotificationConfigurations、DescribePaiInstances、DescribeScalingPolicies、DescribeScheduledActions
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Name | 是 | 否 | String | 需要过滤的字段。 |
Values | 是 | 否 | Array of String | 字段的过滤值。 |
PaiInstanceConfig
PAI实例配置
被如下接口引用:CreatePaiInstanceConfig
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
DomainName | 是 | 否 | String | PAI实例配置的域名 |
UserData | 是 | 否 | String | PAI实例配置的用户自定义数据 |
ImageId | 是 | 否 | String | PAI实例配置的镜像ID |
PaiInstanceConfigId | 是 | 否 | String | PAI实例配置的ID |
PaiInstance
PAI实例
被如下接口引用:DescribePaiInstances
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
InstanceId | 是 | 否 | String | 实例ID |
DomainName | 是 | 否 | String | 实例域名 |
ForwardLoadBalancer
应用型负载均衡器
被如下接口引用:CreateAutoScalingGroup、DescribeAutoScalingGroups、ModifyLoadBalancers
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
LoadBalancerId | 是 | 否 | String | 负载均衡器ID |
ListenerId | 是 | 否 | String | 应用型负载均衡监听器 ID |
LocationId | 否 | 否 | String | 转发规则ID,注意:针对七层监听器此参数必填 |
TargetAttributes | 是 | 否 | Array of TargetAttribute | 目标规则属性列表 |
Region | 否 | 否 | String | 负载均衡实例所属地域,默认取AS服务所在地域。格式与公共参数Region相同,如:"ap-guangzhou"。 |
InstanceTag
实例标签。通过指定该参数,可以为扩容的实例绑定标签。
被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Key | 是 | 否 | String | 标签键 |
Value | 是 | 否 | String | 标签值 |
InstanceMarketOptionsRequest
CVM竞价请求相关选项
被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
MarketType | 否 | 是 | String | 市场选项类型,当前只支持取值:spot |
SpotOptions | 是 | 否 | SpotMarketOptions | 竞价相关选项 |
Activity
符合条件的伸缩活动相关信息。
被如下接口引用:DescribeAutoScalingActivities、DescribeAutoScalingGroupLastActivities
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
AutoScalingGroupId | 是 | 否 | String | 伸缩组ID。 |
ActivityId | 是 | 否 | String | 伸缩活动ID。 |
ActivityType | 是 | 否 | String | 伸缩活动类型。取值如下:<br><li>SCALE_OUT:扩容活动<li>SCALE_IN:缩容活动<li>ATTACH_INSTANCES:添加实例<li>REMOVE_INSTANCES:销毁实例<li>DETACH_INSTANCES:移出实例<li>TERMINATE_INSTANCES_UNEXPECTEDLY:实例在CVM控制台被销毁<li>REPLACE_UNHEALTHY_INSTANCE:替换不健康实例) |
StatusCode | 是 | 否 | String | 伸缩活动状态。取值如下:<br><li>INIT:初始化中<li>RUNNING:运行中<li>SUCCESSFUL:活动成功<li>PARTIALLY_SUCCESSFUL:活动部分成功<li>FAILED:活动失败<li>CANCELLED:活动取消 |
StatusMessage | 是 | 否 | String | 伸缩活动状态描述。 |
Cause | 是 | 否 | String | 伸缩活动起因。 |
Description | 是 | 否 | String | 伸缩活动描述。 |
StartTime | 是 | 否 | Datetime_iso | 伸缩活动开始时间。 |
EndTime | 是 | 是 | Datetime_iso | 伸缩活动结束时间。 |
CreatedTime | 是 | 否 | Datetime_iso | 伸缩活动创建时间。 |
ActivityRelatedInstanceSet | 是 | 否 | Array of ActivtyRelatedInstance | 伸缩活动相关实例信息集合。 |
StatusMessageSimplified | 是 | 否 | String | 伸缩活动状态简要描述。 |
LifecycleActionResultSet | 是 | 否 | Array of LifecycleActionResultInfo | 伸缩活动中生命周期挂钩的执行结果。 |
ServiceSettings
服务设置
被如下接口引用:CreateAutoScalingGroup、DescribeAutoScalingGroups、ModifyAutoScalingGroup
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
ReplaceMonitorUnhealthy | 否 | 否 | Bool | 开启监控不健康替换服务。若开启则对于云监控标记为不健康的实例,弹性伸缩服务会进行替换。若不指定该参数,则默认为 False。 |
ScalingMode | 否 | 否 | String | 取值范围: CLASSIC_SCALING:经典方式,使用创建、销毁实例来实现扩缩容; WAKE_UP_STOPPED_SCALING:扩容优先开机。扩容时优先对已关机的实例执行开机操作,若开机后实例数仍低于期望实例数,则创建实例,缩容仍采用销毁实例的方式。用户可以使用StopAutoScalingInstances接口来关闭伸缩组内的实例。监控告警触发的扩容仍将创建实例默认取值:CLASSIC_SCALING |
InstanceNameSettings
云服务器实例名称(InstanceName)的相关设置
被如下接口引用:DescribeLaunchConfigurations
名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
InstanceName | 是 | 否 | String | 云服务器的实例名。点号(.)和短横线(-)不能作为 InstanceName 的首尾字符,不能连续使用。其他类型(Linux 等)实例:字符长度为[2, 40],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。注意:此字段可能返回 null,表示取不到有效值。 |
InstanceNameStyle | 否 | 否 | String | 云服务器实例名的风格,取值范围包括 ORIGINAL 和 UNIQUE,默认为 ORIGINAL。ORIGINAL,AS 直接将入参中所填的 InstanceName 传递给 CVM,CVM 可能会对 InstanceName 追加序列号,伸缩组中实例的 InstanceName 会出现冲突的情况。UNIQUE,入参所填的 InstanceName 相当于实例名前缀,AS 和 CVM 会对其进行拓展,伸缩组中实例的 InstanceName 可以保证唯一。注意:此字段可能返回 null,表示取不到有效值。 |