数据结构

最近更新时间: 2026-08-29 00:19:45

RunMonitorServiceEnabled

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

被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration

名称 必选 允许NULL 类型 描述
Enabled Bool 是否开启云监控服务。取值范围:
  • TRUE:表示开启云监控服务
  • FALSE:表示不开启云监控服务

    默认取值:TRUE。
    示例值: true
  • ActivtyRelatedInstance

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

    被如下接口引用:DescribeAutoScalingActivities、DescribeAutoScalingGroupLastActivities

    名称 必选 允许NULL 类型 描述
    InstanceId String 实例ID。
    示例值: ins-61dyt49h
    InstanceStatus String 实例在伸缩活动中的状态。取值如下:
  • INIT:初始化中
  • RUNNING:实例操作中
  • SUCCESSFUL:活动成功
  • FAILED:活动失败
    示例值: SUCCESSFUL
  • ScalingPolicy

    告警触发策略。

    被如下接口引用:DescribeScalingPolicies

    名称 必选 允许NULL 类型 描述
    AutoScalingGroupId String 伸缩组ID。
    示例值: asg-1tgr5cf8
    AutoScalingPolicyId String 告警触发策略ID。
    示例值: asg-1tgr5cf8
    ScalingPolicyName String 告警触发策略名称。
    示例值: alice-asp
    AdjustmentType String 告警触发后,期望实例数修改方式。取值 :
  • CHANGE_IN_CAPACITY:增加或减少若干期望实例数
  • EXACT_CAPACITY:调整至指定期望实例数
  •  
  • PERCENT_CHANGE_IN_CAPACITY:按百分比调整期望实例数

  • 示例值: CHANGE_IN_CAPACITY
    AdjustmentValue Int64 告警触发后,期望实例数的调整值。
    示例值: 2
    Cooldown Uint64 冷却时间。
    示例值: 60
    MetricAlarm MetricAlarm 告警监控指标。
    示例值:查看
    NotificationUserGroupIds Array of String 通知组ID,即为用户组ID集合。
    示例值: []

    ServiceSettings

    服务设置

    被如下接口引用:CreateAutoScalingGroup、DescribeAutoScalingGroups、ModifyAutoScalingGroup

    名称 必选 允许NULL 类型 描述
    ReplaceMonitorUnhealthy Bool 开启监控不健康替换服务。若开启则对于云监控标记为不健康的实例,弹性伸缩服务会进行替换。若不指定该参数,则默认为 False。
    示例值: False
    ScalingMode String 取值范围: 
    CLASSIC_SCALING:经典方式,使用创建、销毁实例来实现扩缩容; 
    WAKE_UP_STOPPED_SCALING:扩容优先开机。扩容时优先对已关机的实例执行开机操作,若开机后实例数仍低于期望实例数,则创建实例,缩容仍采用销毁实例的方式。用户可以使用StopAutoScalingInstances接口来关闭伸缩组内的实例。监控告警触发的扩容仍将创建实例
    默认取值:CLASSIC_SCALING
    示例值: CLASSIC_SCALING

    InternetAccessible

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

    被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration

    名称 必选 允许NULL 类型 描述
    InternetChargeType String 网络计费类型。取值范围:
  • BANDWIDTH_PREPAID:预付费按带宽结算
  • TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费
  • BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费
  • BANDWIDTH_PACKAGE:带宽包用户
    默认取值:TRAFFIC_POSTPAID_BY_HOUR。
    示例值: BANDWIDTH_POSTPAID_BY_HOUR
  • InternetMaxBandwidthOut Uint64 公网出带宽上限,单位:Mbps。默认值:0Mbps。不同机型带宽上限范围不一致。
    示例值: 1
    PublicIpAssigned Bool 是否分配公网IP。取值范围:
  • TRUE:表示分配公网IP
  • FALSE:表示不分配公网IP

    当公网带宽大于0Mbps时,可自由选择开通与否,默认开通公网IP;当公网带宽为0,则不允许分配公网IP。
    示例值: true
  • MetricAlarm

    弹性伸缩告警指标

    被如下接口引用:CreateScalingPolicy、DescribeScalingPolicies、ModifyScalingPolicy

    名称 必选 允许NULL 类型 描述
    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:外网入带宽

  • 示例值: CPU_UTILIZATION
    Statistic String 统计类型,可选字段如下:
  • AVERAGE:平均值
  • MAXIMUM:最大值
  • MINIMUM:最小值

  •  默认取值:AVERAGE
    示例值: AVERAGE
    Threshold Uint64 告警阈值:
  • 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

  • 示例值: 10
    Period Uint64 时间周期,单位:秒,取值枚举值为60、300。
    示例值: 60
    ContinuousTime Uint64 重复次数。取值范围 [1, 10]
    示例值: 3

    EnhancedService

    描述了实例的增强服务启用情况与其设置,如云安全,云监控等实例 Agent。

    被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration

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

    ForwardLoadBalancer

    应用型负载均衡器

    被如下接口引用:CreateAutoScalingGroup、DescribeAutoScalingGroups、ModifyLoadBalancers

    名称 必选 允许NULL 类型 描述
    LoadBalancerId String 负载均衡器ID
    示例值: lb-crhgatrf
    ListenerId String 应用型负载均衡监听器 ID
    示例值: lb-61dyt49h
    LocationId String 转发规则ID,注意:针对七层监听器此参数必填
    示例值: loc-61dyt49h
    TargetAttributes Array of TargetAttribute 目标规则属性列表
    示例值:查看
    Region String 负载均衡实例所属地域,默认取AS服务所在地域。格式与公共参数Region相同,如:"ap-region"。
    示例值: ap-region

    RunSecurityServiceEnabled

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

    被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration

    名称 必选 允许NULL 类型 描述
    Enabled Bool 是否开启云安全服务。取值范围:
  • TRUE:表示开启云安全服务
  • FALSE:表示不开启云安全服务

    默认取值:TRUE。
    示例值: true
  • Filter

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

    • 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
    • 若同一个Filter存在多个Values,同一FilterValues间的关系为逻辑或(OR)关系。

    DescribeInstances接口的Filter为例。若我们需要查询可用区(zone)为region一区 并且 实例计费模式(instance-charge-type)为包年包月 或者 按量计费的实例时,可如下实现:

    Filters.0.Name=zone
    &Filters.0.Values.1=ap-region-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、DescribeScalingPolicies、DescribeScheduledActions

    名称 必选 允许NULL 类型 描述
    Name String 需要过滤的字段。
    示例值: key
    Values Array of String 字段的过滤值。
    示例值: value

    SpotMarketOptions

    竞价相关选项

    被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration

    名称 必选 允许NULL 类型 描述
    MaxPrice String 竞价出价,例如“1.05”
    示例值: 0.99
    SpotInstanceType String 竞价请求类型,当前仅支持类型:one-time,默认值为one-time
    示例值: one-time

    LifecycleActionResultInfo

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

    被如下接口引用:DescribeAutoScalingActivities、DescribeAutoScalingGroupLastActivities

    名称 必选 允许NULL 类型 描述
    LifecycleHookId String 生命周期挂钩标识。
    示例值: ash-61dyt49h
    InstanceId String 实例标识。
    示例值: ins-61dyt49h
    NotificationResult String 通知的结果,表示通知CMQ是否成功。
    示例值: null
    LifecycleActionResult String 生命周期挂钩动作的执行结果,取值包括 CONTINUE、ABANDON。
    示例值: CONTINUE
    ResultReason String 结果的原因。
    示例值: HEARTBEAT_TIMEOUT

    InstanceMarketOptionsRequest

    CVM竞价请求相关选项

    被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration

    名称 必选 允许NULL 类型 描述
    MarketType String 市场选项类型,当前只支持取值:spot
    示例值: spot
    SpotOptions SpotMarketOptions 竞价相关选项
    示例值:查看

    InstanceNameSettings

    云服务器实例名称(InstanceName)的相关设置

    被如下接口引用:DescribeLaunchConfigurations

    名称 必选 允许NULL 类型 描述
    InstanceName String 云服务器的实例名。

    点号(.)和短横线(-)不能作为 InstanceName 的首尾字符,不能连续使用。

    其他类型(Linux 等)实例:字符长度为[2, 40],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值: alice-1
    InstanceNameStyle String 云服务器实例名的风格,取值范围包括 ORIGINAL 和 UNIQUE,默认为 ORIGINAL。

    ORIGINAL,AS 直接将入参中所填的 InstanceName 传递给 CVM,CVM 可能会对 InstanceName 追加序列号,伸缩组中实例的 InstanceName 会出现冲突的情况。

    UNIQUE,入参所填的 InstanceName 相当于实例名前缀,AS 和 CVM 会对其进行拓展,伸缩组中实例的 InstanceName 可以保证唯一。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值: ORIGINAL

    InstanceTag

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

    被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration

    名称 必选 允许NULL 类型 描述
    Key String 标签键
    示例值: TYPE
    Value String 标签值
    示例值: region

    ScheduledAction

    描述定时任务的信息

    被如下接口引用:DescribeScheduledActions

    名称 必选 允许NULL 类型 描述
    ScheduledActionId String 定时任务ID。
    示例值: asst-jf898dps
    ScheduledActionName String 定时任务名称。
    示例值: RunInstances
    AutoScalingGroupId String 定时任务所在伸缩组ID。
    示例值: asg-keqt9eg1
    StartTime Datetime_iso 定时任务的开始时间。取值为region时间(UTC+8),按照ISO8601标准,格式:YYYY-MM-DDThh:mm:ss+08:00
    示例值: 2022-02-22T16:00:00+08:00
    Recurrence String 定时任务的重复方式。
    示例值: 0 23 /1  *
    EndTime Datetime_iso 定时任务的结束时间。取值为region时间(UTC+8),按照ISO8601标准,格式:YYYY-MM-DDThh:mm:ss+08:00
    示例值: 2023-02-23T16:00:00+08:00
    MaxSize Uint64 定时任务设置的最大实例数。
    示例值: 20
    DesiredCapacity Uint64 定时任务设置的期望实例数。
    示例值: 5
    MinSize Uint64 定时任务设置的最小实例数。
    示例值: 1
    CreatedTime Datetime_iso 定时任务的创建时间。取值为UTC时间,按照ISO8601标准,格式:YYYY-MM-DDThh:mm:ssZ
    示例值: 2022-02-21T02:19:52Z

    AutoScalingNotification

    弹性伸缩事件通知

    被如下接口引用:DescribeNotificationConfigurations

    名称 必选 允许NULL 类型 描述
    AutoScalingGroupId String 伸缩组ID。
    示例值: asg-19kw47wk
    NotificationUserGroupIds Array of String 用户组ID列表。
    示例值: ["12529"]
    NotificationTypes Array of String 通知事件列表。
    示例值: ["SCALE_OUT_SUCCESSFUL"]
    AutoScalingNotificationId String 事件通知ID。
    示例值: asn-6r4waxc4

    DataDisk

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

    被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration

    名称 必选 允许NULL 类型 描述
    DiskType String 数据盘类型。取值范围:
  • LOCAL_BASIC:本地硬盘
  • LOCAL_SSD:本地SSD硬盘
  • CLOUD_BASIC:普通云硬盘
  • CLOUD_PREMIUM:高性能云硬盘
  • CLOUD_SSD:SSD云硬盘

    默认取值:LOCAL_BASIC。
    示例值: CLOUD_PREMIUM
  • DiskSize Uint64 数据盘大小,单位:GB。最小调整步长为10G,不同数据盘类型取值范围不同。默认值为0,表示不购买数据盘。更多限制详见产品文档。
    示例值: 0
    SnapshotId String 数据盘快照 ID,类似 snap-l8psqwnt
    示例值: snap-l8psqwnt

    AutoScalingGroup

    伸缩组

    被如下接口引用:DescribeAutoScalingGroups

    名称 必选 允许NULL 类型 描述
    AutoScalingGroupId String 伸缩组ID
    示例值: asg-30wif85u
    AutoScalingGroupName String 伸缩组名称
    示例值: alice use
    AutoScalingGroupStatus String 伸缩组当前状态。取值范围:
  • NORMAL:正常
  • CVM_ABNORMAL:启动配置异常
  • LB_ABNORMAL:负载均衡器异常
  • VPC_ABNORMAL:VPC网络异常
  • INSUFFICIENT_BALANCE:余额不足

    示例值: NORMAL
  • CreatedTime Datetime_iso 创建时间,采用UTC标准计时
    示例值: 2021-05-31T12:38:35Z
    DefaultCooldown Int64 默认冷却时间,单位秒
    示例值: 300
    DesiredCapacity Int64 期望实例数
    示例值: 0
    EnabledStatus String 启用状态,取值包括ENABLEDDISABLED
    示例值: ENABLED
    ForwardLoadBalancerSet Array of ForwardLoadBalancer 应用型负载均衡器列表
    示例值:查看
    InstanceCount Int64 实例数量
    示例值: 0
    InServiceInstanceCount Int64 状态为IN_SERVICE实例的数量
    示例值: 0
    LaunchConfigurationId String 启动配置ID
    示例值: asc-966b7fk2
    LaunchConfigurationName String 启动配置名称
    示例值: alice-lc
    LoadBalancerIdSet Array of String 传统型负载均衡器ID列表
    示例值: []
    MaxSize Int64 最大实例数
    示例值: 10
    MinSize Int64 最小实例数
    示例值: 0
    ProjectId Int64 项目ID
    示例值: 0
    SubnetIdSet Array of String 子网ID列表
    示例值: ["subnet-rdm629r2"]
    TerminationPolicySet Array of String 销毁策略
    示例值: OLDEST_INSTANCE
    VpcId String VPC标识
    示例值: vpc-h3cd5td5
    ZoneSet Array of String 可用区列表
    示例值: []
    RetryPolicy String 重试策略
    示例值: NO_RETRY
    InActivityStatus String 伸缩组是否处于伸缩活动中,IN_ACTIVITY表示处于伸缩活动中,NOT_IN_ACTIVITY表示不处于伸缩活动中。
    示例值: IN_ACTIVITY
    Tags Array of Tag 伸缩组标签列表
    示例值:查看
    ServiceSettings ServiceSettings 服务设置
    示例值:查看
    Ipv6AddressCount Int64 实例具有IPv6地址数量的配置
    示例值: 0
    MultiZoneSubnetPolicy String 多可用区/子网策略。

  •  PRIORITY,按照可用区/子网列表的顺序,作为优先级来尝试创建实例,如果优先级最高的可用区/子网可以创建成功,则总在该可用区/子网创建。

  •  EQUALITY:每次选择当前实例数最少的可用区/子网进行扩容,使得每个可用区/子网都有机会发生扩容,多次扩容出的实例会打散到多个可用区/子网。
    示例值: PRIORITY
  • AutoScalingGroupAbstract

    伸缩组简明信息。

    被如下接口引用:DescribeLaunchConfigurations

    名称 必选 允许NULL 类型 描述
    AutoScalingGroupId String 伸缩组ID。
    示例值: asg-30wif85u
    AutoScalingGroupName String 伸缩组名称。
    示例值: alice-asg

    RunAutomationServiceEnabled

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

    被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration

    名称 必选 允许NULL 类型 描述
    Enabled Bool 是否开启[自动化助手]服务。取值范围:
  • TRUE:表示开启自动化助手服务
  • FALSE:表示不开启自动化助手服务
    示例值: True
  • Tag

    资源类型及标签键值对

    被如下接口引用:CreateAutoScalingGroup、DescribeAutoScalingGroups

    名称 必选 允许NULL 类型 描述
    ResourceType String 标签绑定的资源类型,当前支持类型:"auto-scaling-group
    示例值: instance
    Key String 标签键
    示例值: key
    Value String 标签值
    示例值: val
    TagKey String 标签键
    示例值: key
    TagValue String 标签值
    示例值: val

    Activity

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

    被如下接口引用:DescribeAutoScalingActivities、DescribeAutoScalingGroupLastActivities

    名称 必选 允许NULL 类型 描述
    AutoScalingGroupId String 伸缩组ID。
    示例值: asg-aaaaqqqq
    ActivityId String 伸缩活动ID。
    示例值: asa-fznnvrja
    ActivityType String 伸缩活动类型。取值如下:

  • SCALE_OUT:扩容活动
  • SCALE_IN:缩容活动
  • ATTACH_INSTANCES:添加实例
  • REMOVE_INSTANCES:销毁实例
  • DETACH_INSTANCES:移出实例
  • TERMINATE_INSTANCES_UNEXPECTEDLY:实例在CVM控制台被销毁
  • REPLACE_UNHEALTHY_INSTANCE:替换不健康实例)
    示例值: SCALE_OUT
  • StatusCode String 伸缩活动状态。取值如下:

  • INIT:初始化中
  • RUNNING:运行中
  • SUCCESSFUL:活动成功
  • PARTIALLY_SUCCESSFUL:活动部分成功
  • FAILED:活动失败
  • CANCELLED:活动取消
    示例值: SUCCESSFUL
  • StatusMessage String 伸缩活动状态描述。
    示例值: Success
    Cause String 伸缩活动起因。
    示例值: Activity was launched in response to a difference between desired capacity and actual capacity.
    Description String 伸缩活动描述。
    示例值: alice use
    StartTime Datetime_iso 伸缩活动开始时间。
    示例值: 2014-08-03T12:00:00+08:00
    EndTime Datetime_iso 伸缩活动结束时间。
    示例值: 2014-08-03T12:00:00+08:00
    CreatedTime Datetime_iso 伸缩活动创建时间。
    示例值: 2014-08-03T12:00:00+08:00
    ActivityRelatedInstanceSet Array of ActivtyRelatedInstance 伸缩活动相关实例信息集合。
    示例值:查看
    StatusMessageSimplified String 伸缩活动状态简要描述。
    示例值: Success
    LifecycleActionResultSet Array of LifecycleActionResultInfo 伸缩活动中生命周期挂钩的执行结果。
    示例值:查看

    NotificationTarget

    通知目标

    被如下接口引用:CreateLifecycleHook、DescribeLifecycleHooks、UpgradeLifecycleHook

    名称 必选 允许NULL 类型 描述
    TargetType String 目标类型,取值范围包括CMQ_QUEUECMQ_TOPIC
  •  CMQ_QUEUE,指云平台消息队列-队列模型。
  •  CMQ_TOPIC,指云平台消息队列-主题模型。

  • 示例值: TDMQ_CMQ_QUEUE
    QueueName String 队列名称,如果TargetType取值为CMQ_QUEUE,则本字段必填。
    示例值: alice-queue
    TopicName String 主题名称,如果TargetType取值为CMQ_TOPIC,则本字段必填。
    示例值: alice-topic
    EnvironmentId String 环境ID。
    示例值: 84763
    ClusterId String 集群Id
    示例值: 29183

    InstanceChargePrepaid

    描述了了实例的计费模式

    被如下接口引用:DescribeLaunchConfigurations

    名称 必选 允许NULL 类型 描述
    Period Int64 购买实例的时长,单位:月。取值范围: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
  • LifecycleHook

    生命周期挂钩

    被如下接口引用:DescribeLifecycleHooks

    名称 必选 允许NULL 类型 描述
    LifecycleHookId String 生命周期挂钩ID
    示例值: ash-ck4bkcjt
    LifecycleHookName String 生命周期挂钩名称
    示例值: demo
    AutoScalingGroupId String 伸缩组ID
    示例值: asg-lk5nn4xi
    DefaultResult String 生命周期挂钩默认结果
    示例值: CONTINUE
    HeartbeatTimeout Int64 生命周期挂钩等待超时时间
    示例值: 300
    LifecycleTransition String 生命周期挂钩适用场景
    示例值: INSTANCE_TERMINATING
    NotificationMetadata String 通知目标的附加信息
    示例值: ""
    CreatedTime Datetime_iso 创建时间
    示例值: 2021-05-31T12:38:35Z
    NotificationTarget NotificationTarget 通知目标
    示例值:查看
    LifecycleTransitionType String 生命周期挂钩场景类型
    示例值: NORMAL

    LoginSettings

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

    被如下接口引用:CreateLaunchConfiguration、UpgradeLaunchConfiguration

    名称 必选 允许NULL 类型 描述
    Password String 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:
  • Linux实例密码必须8到16位,至少包括两项[a-z,A-Z]、[0-9] 和 [( ) ` ~ ! @ # $ % ^ & * - + = 
  • KeyIds Array of String 密钥ID列表。关联密钥后,就可以通过对应的私钥来访问实例;KeyId可通过接口DescribeKeyPairs获取,密钥与密码不能同时指定,同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。
    示例值: ["skey-k8eypc1"]
    KeepImageLogin Bool 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围:
  • TRUE:表示保持镜像的登录设置
  • FALSE:表示不保持镜像的登录设置

    默认取值:FALSE。
    示例值: true
  • Instance

    实例信息

    被如下接口引用:DescribeAutoScalingInstances

    名称 必选 允许NULL 类型 描述
    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, TERMINATING, ATTACHING, DETACHING, ATTACHING_LB, DETACHING_LB等
    示例值: IN_SERVICE
    HealthStatus String 健康状态,取值包括HEALTHY和UNHEALTHY
    示例值: HEALTHY
    ProtectedFromScaleIn Bool 是否加入缩容保护
    示例值: false
    Zone String 可用区
    示例值: ap-region-1
    CreationType String 创建类型,取值包括AUTO_CREATION, MANUAL_ATTACHING。
    示例值: AUTO_CREATION
    AddTime Datetime_iso 实例加入时间
    示例值: 2023-01-13T03:06:25Z
    InstanceType String 实例类型
    示例值: S3.MEDIUM2
    VersionNumber Int64 版本号
    示例值: 1
    AutoScalingGroupName String 伸缩组名称
    示例值: 测试asg-01_2.3

    HostNameSettings

    云服务器主机名(HostName)的相关设置

    被如下接口引用:DescribeLaunchConfigurations

    名称 必选 允许NULL 类型 描述
    HostName String 云服务器的主机名。

  •  点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。

  •  不支持 Windows 实例。

  •  其他类型(Linux 等)实例:字符长度为[2, 40],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。
    示例值: aaa
  • HostNameStyle String 云服务器主机名的风格,取值范围包括 ORIGINAL 和  UNIQUE,默认为 ORIGINAL。

  •  ORIGINAL,AS 直接将入参中所填的 HostName 传递给 CVM,CVM 可能会对 HostName 追加序列号,伸缩组中实例的 HostName 会出现冲突的情况。

  •  UNIQUE,入参所填的 HostName 相当于主机名前缀,AS 和 CVM 会对其进行拓展,伸缩组中实例的 HostName 可以保证唯一。
    示例值: ORIGINAL
  • LaunchConfiguration

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

    被如下接口引用:DescribeLaunchConfigurations

    名称 必选 允许NULL 类型 描述
    ProjectId Int64 实例所属项目ID。
    示例值: 0
    LaunchConfigurationId String 启动配置ID。
    示例值: asc-61dyt49h
    LaunchConfigurationName String 启动配置名称。
    示例值: TestLauchConfig0_0
    InstanceType String 实例机型。
    示例值: SA2.MEDIUM2
    SystemDisk SystemDisk 实例系统盘配置信息。
    示例值:查看
    DataDisks Array of DataDisk 实例数据盘配置信息。
    示例值:查看
    LoginSettings LimitedLoginSettings 实例登录设置。
    示例值:查看
    InternetAccessible InternetAccessible 公网带宽相关信息设置。
    示例值:查看
    SecurityGroupIds Array of String 实例所属安全组。
    示例值: ["sg-brwzhm6d"]
    AutoScalingGroupAbstractSet Array of AutoScalingGroupAbstract 启动配置关联的伸缩组。
    示例值:查看
    UserData String 自定义数据。
    示例值: dGVzdA==
    CreatedTime Datetime_iso 启动配置创建时间。
    示例值: 2021-05-31T12:38:35Z
    EnhancedService EnhancedService 实例的增强服务启用情况与其设置。
    示例值:查看
    ImageId String 镜像ID。
    示例值: img-61dyt49h
    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 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。
    示例值:查看
    InstanceTypes Array of String 实例机型列表。
    示例值: ["SA2.MEDIUM2"]
    InstanceTags Array of InstanceTag 标签列表。
    示例值:查看
    VersionNumber Int64 版本号。
    示例值: 1
    UpdatedTime Datetime_iso 更新时间。
    示例值: 2023-09-04T11:42:46Z
    CamRoleName String CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。
    示例值: TestRole
    LastOperationInstanceTypesCheckPolicy String 上次操作时,InstanceTypesCheckPolicy 取值。
    示例值: ANY
    HostNameSettings HostNameSettings 云服务器主机名(HostName)的相关设置。
    示例值:查看
    InstanceNameSettings InstanceNameSettings 云服务器实例名(InstanceName)的相关设置。
    示例值:查看
    InstanceChargePrepaid InstanceChargePrepaid 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
    示例值:查看

    TargetAttribute

    负载均衡器目标属性

    被如下接口引用:CreateAutoScalingGroup、DescribeAutoScalingGroups、ModifyLoadBalancers

    名称 必选 允许NULL 类型 描述
    Port Uint64 端口
    示例值: 8080
    Weight Uint64 权重
    示例值: 5

    SystemDisk

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

    被如下接口引用:CreateLaunchConfiguration、DescribeLaunchConfigurations、UpgradeLaunchConfiguration

    名称 必选 允许NULL 类型 描述
    DiskType String 系统盘类型。取值范围:
  • LOCAL_BASIC:本地硬盘
  • LOCAL_SSD:本地SSD硬盘
  • CLOUD_BASIC:普通云硬盘
  • CLOUD_PREMIUM:高性能云硬盘
  • CLOUD_SSD:SSD云硬盘

    默认取值:LOCAL_BASIC。
    示例值: CLOUD_PREMIUM
  • DiskSize Uint64 系统盘大小,单位:GB。默认值为 50
    示例值: 50

    LimitedLoginSettings

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

    被如下接口引用:DescribeLaunchConfigurations

    名称 必选 允许NULL 类型 描述
    KeyIds Array of String 密钥ID列表。
    示例值: ["skey-k8eypc1"]