数据结构

最近更新时间:2021-10-21 11:15:37

我的收藏

Activity

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

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

名称 类型 描述
AutoScalingGroupId String 伸缩组ID。
ActivityId String 伸缩活动ID。
ActivityType String 伸缩活动类型。取值如下:

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

  • INIT:初始化中
  • RUNNING:运行中
  • SUCCESSFUL:活动成功
  • PARTIALLY_SUCCESSFUL:活动部分成功
  • FAILED:活动失败
  • CANCELLED:活动取消
  • StatusMessage String 伸缩活动状态描述。
    Cause String 伸缩活动起因。
    Description String 伸缩活动描述。
    StartTime Timestamp ISO8601 伸缩活动开始时间。
    EndTime Timestamp ISO8601 伸缩活动结束时间。
    CreatedTime Timestamp ISO8601 伸缩活动创建时间。
    ActivityRelatedInstanceSet Array of ActivtyRelatedInstance 伸缩活动相关实例信息集合。
    StatusMessageSimplified String 伸缩活动状态简要描述。
    LifecycleActionResultSet Array of LifecycleActionResultInfo 伸缩活动中生命周期挂钩的执行结果。
    DetailedStatusMessageSet Array of DetailedStatusMessage 伸缩活动状态详细描述。

    ActivtyRelatedInstance

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

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

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

    伸缩组

    被如下接口引用:DescribeAutoScalingGroups。

    名称 类型 描述
    AutoScalingGroupId String 伸缩组ID
    AutoScalingGroupName String 伸缩组名称
    AutoScalingGroupStatus String 伸缩组当前状态。取值范围:
  • NORMAL:正常
  • CVM_ABNORMAL:启动配置异常
  • LB_ABNORMAL:负载均衡器异常
  • VPC_ABNORMAL:VPC网络异常
  • INSUFFICIENT_BALANCE:余额不足
  • LB_BACKEND_REGION_NOT_MATCH:CLB实例后端地域与AS服务所在地域不匹配
  • CreatedTime Timestamp ISO8601 创建时间,采用UTC标准计时
    DefaultCooldown Integer 默认冷却时间,单位秒
    DesiredCapacity Integer 期望实例数
    EnabledStatus String 启用状态,取值包括ENABLEDDISABLED
    ForwardLoadBalancerSet Array of ForwardLoadBalancer 应用型负载均衡器列表
    InstanceCount Integer 实例数量
    InServiceInstanceCount Integer 状态为IN_SERVICE实例的数量
    LaunchConfigurationId String 启动配置ID
    LaunchConfigurationName String 启动配置名称
    LoadBalancerIdSet Array of String 传统型负载均衡器ID列表
    MaxSize Integer 最大实例数
    MinSize Integer 最小实例数
    ProjectId Integer 项目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 Integer 实例具有IPv6地址数量的配置
    MultiZoneSubnetPolicy String 多可用区/子网策略。

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

  • EQUALITY:每次选择当前实例数最少的可用区/子网进行扩容,使得每个可用区/子网都有机会发生扩容,多次扩容出的实例会打散到多个可用区/子网。
  • HealthCheckType String 伸缩组实例健康检查类型,取值如下:
  • CVM:根据实例网络状态判断实例是否处于不健康状态,不健康的网络状态即发生实例 PING 不可达事件,详细判断标准可参考实例健康检查
  • CLB:根据 CLB 的健康检查状态判断实例是否处于不健康状态,CLB健康检查原理可参考健康检查
  • LoadBalancerHealthCheckGracePeriod Integer CLB健康检查宽限期
    InstanceAllocationPolicy String 实例分配策略,取值包括 LAUNCH_CONFIGURATION 和 SPOT_MIXED。

  • LAUNCH_CONFIGURATION,代表传统的按照启动配置模式。

  • SPOT_MIXED,代表竞价混合模式。目前仅支持启动配置为按量计费模式时使用混合模式,混合模式下,伸缩组将根据设定扩容按量或竞价机型。使用混合模式时,关联的启动配置的计费类型不可被修改。
  • SpotMixedAllocationPolicy SpotMixedAllocationPolicy 竞价混合模式下,各计费类型实例的分配策略。
    仅当 InstanceAllocationPolicy 取 SPOT_MIXED 时才会返回有效值。
    CapacityRebalance Boolean 容量重平衡功能,仅对伸缩组内的竞价实例有效。取值范围:

  • TRUE,开启该功能,当伸缩组内的竞价实例即将被竞价实例服务自动回收前,AS 主动发起竞价实例销毁流程,如果有配置过缩容 hook,则销毁前 hook 会生效。销毁流程启动后,AS 会异步开启一个扩容活动,用于补齐期望实例数。

  • FALSE,不开启该功能,则 AS 等待竞价实例被销毁后才会去扩容补齐伸缩组期望实例数。
  • AutoScalingGroupAbstract

    伸缩组简明信息。

    被如下接口引用:DescribeLaunchConfigurations。

    名称 类型 描述
    AutoScalingGroupId String 伸缩组ID。
    AutoScalingGroupName String 伸缩组名称。

    AutoScalingNotification

    弹性伸缩事件通知

    被如下接口引用:DescribeNotificationConfigurations。

    名称 类型 描述
    AutoScalingGroupId String 伸缩组ID。
    NotificationUserGroupIds Array of String 用户组ID列表。
    NotificationTypes Array of String 通知事件列表。
    AutoScalingNotificationId String 事件通知ID。
    TargetType String 通知接收端类型。
    QueueName String CMQ 队列名。
    TopicName String CMQ 主题名。

    DataDisk

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

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

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

    默认取值与系统盘类型(SystemDisk.DiskType)保持一致。
    注意:此字段可能返回 null,表示取不到有效值。
  • DiskSize Integer 数据盘大小,单位:GB。最小调整步长为10G,不同数据盘类型取值范围不同,具体限制详见:CVM实例配置。默认值为0,表示不购买数据盘。更多限制详见产品文档。
    注意:此字段可能返回 null,表示取不到有效值。
    SnapshotId String 数据盘快照 ID,类似 snap-l8psqwnt
    注意:此字段可能返回 null,表示取不到有效值。

    DetailedStatusMessage

    伸缩活动状态详细描述。

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

    名称 类型 描述
    Code String 错误类型。
    Zone String 可用区信息。
    InstanceId String 实例ID。
    InstanceChargeType String 实例计费类型。
    SubnetId String 子网ID。
    Message String 错误描述。
    InstanceType String 实例类型。

    EnhancedService

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

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

    名称 类型 必选 描述
    SecurityService RunSecurityServiceEnabled 开启云安全服务。若不指定该参数,则默认开启云安全服务。
    MonitorService RunMonitorServiceEnabled 开启云监控服务。若不指定该参数,则默认开启云监控服务。

    Filter

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

    • 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
    • 若同一个Filter存在多个Values,同一FilterValues间的关系为逻辑或(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, DescribePaiInstances, DescribeScalingPolicies, DescribeScheduledActions。

    名称 类型 必选 描述
    Name String 需要过滤的字段。
    Values Array of String 字段的过滤值。

    ForwardLoadBalancer

    应用型负载均衡器

    被如下接口引用:CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyLoadBalancers。

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

    HostNameSettings

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

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

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

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

  • 不支持 Windows 实例。

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

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

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

    实例信息

    被如下接口引用:DescribeAutoScalingInstances。

    名称 类型 描述
    InstanceId String 实例ID
    AutoScalingGroupId String 伸缩组ID
    LaunchConfigurationId String 启动配置ID
    LaunchConfigurationName String 启动配置名称
    LifeCycleState String 生命周期状态,取值如下:

  • IN_SERVICE:运行中
  • CREATING:创建中
  • CREATION_FAILED:创建失败
  • TERMINATING:中止中
  • TERMINATION_FAILED:中止失败
  • ATTACHING:绑定中
  • DETACHING:解绑中
  • ATTACHING_LB:绑定LB中
  • DETACHING_LB:解绑LB中
  • STARTING:开机中
  • START_FAILED:开机失败
  • STOPPING:关机中
  • STOP_FAILED:关机失败
  • STOPPED:已关机
  • HealthStatus String 健康状态,取值包括HEALTHY和UNHEALTHY
    ProtectedFromScaleIn Boolean 是否加入缩容保护
    Zone String 可用区
    CreationType String 创建类型,取值包括AUTO_CREATION, MANUAL_ATTACHING。
    AddTime Timestamp ISO8601 实例加入时间
    InstanceType String 实例类型
    VersionNumber Integer 版本号
    AutoScalingGroupName String 伸缩组名称

    InstanceChargePrepaid

    描述了实例的计费模式

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

    名称 类型 必选 描述
    Period Integer 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。
    RenewFlag String 自动续费标识。取值范围:
  • NOTIFY_AND_AUTO_RENEW:通知过期且自动续费
  • NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费
  • DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费

    默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。
  • InstanceMarketOptionsRequest

    CVM竞价请求相关选项

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

    名称 类型 必选 描述
    SpotOptions SpotMarketOptions 竞价相关选项
    MarketType String 市场选项类型,当前只支持取值:spot
    注意:此字段可能返回 null,表示取不到有效值。

    InstanceNameSettings

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

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

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

    点号(.)和短横线(-)不能作为 InstanceName 的首尾字符,不能连续使用。
    字符长度为[2, 40],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。不允许为纯数字。
    InstanceNameStyle String 云服务器实例名的风格,取值范围包括 ORIGINAL 和 UNIQUE,默认为 ORIGINAL。

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

    UNIQUE,入参所填的 InstanceName 相当于实例名前缀,AS 和 CVM 会对其进行拓展,伸缩组中实例的 InstanceName 可以保证唯一。

    InstanceTag

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

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

    名称 类型 必选 描述
    Key String 标签键
    Value String 标签值

    InternetAccessible

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

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

    名称 类型 必选 描述
    InternetChargeType String 网络计费类型。取值范围:
  • BANDWIDTH_PREPAID:预付费按带宽结算
  • TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费
  • BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费
  • BANDWIDTH_PACKAGE:带宽包用户
    默认取值:TRAFFIC_POSTPAID_BY_HOUR。
    注意:此字段可能返回 null,表示取不到有效值。
  • InternetMaxBandwidthOut Integer 公网出带宽上限,单位:Mbps。默认值:0Mbps。不同机型带宽上限范围不一致,具体限制详见购买网络带宽
    注意:此字段可能返回 null,表示取不到有效值。
    PublicIpAssigned Boolean 是否分配公网IP。取值范围:
  • TRUE:表示分配公网IP
  • FALSE:表示不分配公网IP

    当公网带宽大于0Mbps时,可自由选择开通与否,默认开通公网IP;当公网带宽为0,则不允许分配公网IP。
    注意:此字段可能返回 null,表示取不到有效值。
  • BandwidthPackageId String 带宽包ID。可通过DescribeBandwidthPackages接口返回值中的BandwidthPackageId获取。
    注意:此字段可能返回 null,表示取不到有效值。

    LaunchConfiguration

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

    被如下接口引用:DescribeLaunchConfigurations。

    名称 类型 描述
    ProjectId Integer 实例所属项目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 自定义数据。
    注意:此字段可能返回 null,表示取不到有效值。
    CreatedTime Timestamp ISO8601 启动配置创建时间。
    EnhancedService EnhancedService 实例的增强服务启用情况与其设置。
    ImageId String 镜像ID。
    LaunchConfigurationStatus String 启动配置当前状态。取值范围:
  • NORMAL:正常
  • IMAGE_ABNORMAL:启动配置镜像异常
  • CBS_SNAP_ABNORMAL:启动配置数据盘快照异常
  • SECURITY_GROUP_ABNORMAL:启动配置安全组异常
  • InstanceChargeType String 实例计费类型,CVM默认值按照POSTPAID_BY_HOUR处理。

  • POSTPAID_BY_HOUR:按小时后付费

  • SPOTPAID:竞价付费
  • InstanceMarketOptions InstanceMarketOptionsRequest 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。
    注意:此字段可能返回 null,表示取不到有效值。
    InstanceTypes Array of String 实例机型列表。
    InstanceTags Array of InstanceTag 标签列表。
    VersionNumber Integer 版本号。
    UpdatedTime Timestamp ISO8601 更新时间。
    CamRoleName String CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。
    LastOperationInstanceTypesCheckPolicy String 上次操作时,InstanceTypesCheckPolicy 取值。
    HostNameSettings HostNameSettings 云服务器主机名(HostName)的相关设置。
    InstanceNameSettings InstanceNameSettings 云服务器实例名(InstanceName)的相关设置。
    InstanceChargePrepaid InstanceChargePrepaid 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
    DiskTypePolicy String 云盘类型选择策略。取值范围:

  • ORIGINAL:使用设置的云盘类型

  • AUTOMATIC:自动选择当前可用区下可用的云盘类型
  • LifecycleActionResultInfo

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

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

    名称 类型 描述
    LifecycleHookId String 生命周期挂钩标识。
    InstanceId String 实例标识。
    NotificationResult String 通知的结果,表示通知CMQ是否成功。
    LifecycleActionResult String 生命周期挂钩动作的执行结果,取值包括 CONTINUE、ABANDON。
    ResultReason String 结果的原因。

    LifecycleHook

    生命周期挂钩

    被如下接口引用:DescribeLifecycleHooks。

    名称 类型 描述
    LifecycleHookId String 生命周期挂钩ID
    LifecycleHookName String 生命周期挂钩名称
    AutoScalingGroupId String 伸缩组ID
    DefaultResult String 生命周期挂钩默认结果
    HeartbeatTimeout Integer 生命周期挂钩等待超时时间
    LifecycleTransition String 生命周期挂钩适用场景
    NotificationMetadata String 通知目标的附加信息
    CreatedTime Timestamp ISO8601 创建时间
    NotificationTarget NotificationTarget 通知目标
    LifecycleTransitionType String 生命周期挂钩适用场景

    LimitedLoginSettings

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

    被如下接口引用:DescribeLaunchConfigurations。

    名称 类型 描述
    KeyIds Array of String 密钥ID列表。

    LoginSettings

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

    被如下接口引用:CreateLaunchConfiguration, CreatePaiInstance, UpgradeLaunchConfiguration。

    名称 类型 必选 描述
    Password String 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:
  • Linux实例密码必须8到16位,至少包括两项[a-z,A-Z]、[0-9] 和 [( ) ~ ! @ # $ % ^ & * - + = &#124; { } [ ] : ; ' , . ? / ]中的特殊符号。<br><li>Windows实例密码必须12到16位,至少包括三项[a-z],[A-Z],[0-9] 和 [( ) ~ ! @ # $ % ^ & * - + = { } [ ] : ; ' , . ? /]中的特殊符号。

    若不指定该参数,则由系统随机生成密码,并通过站内信方式通知到用户。
    注意:此字段可能返回 null,表示取不到有效值。
  • KeyIds Array of String 密钥ID列表。关联密钥后,就可以通过对应的私钥来访问实例;KeyId可通过接口DescribeKeyPairs获取,密钥与密码不能同时指定,同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。
    KeepImageLogin Boolean 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围:
  • TRUE:表示保持镜像的登录设置
  • FALSE:表示不保持镜像的登录设置

    默认取值:FALSE。
    注意:此字段可能返回 null,表示取不到有效值。
  • 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:不等于
  • MetricName String 指标名称,可选字段如下:
  • CPU_UTILIZATION:CPU利用率
  • MEM_UTILIZATION:内存利用率
  • LAN_TRAFFIC_OUT:内网出带宽
  • LAN_TRAFFIC_IN:内网入带宽
  • WAN_TRAFFIC_OUT:外网出带宽
  • WAN_TRAFFIC_IN:外网入带宽
  • 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
  • Period Integer 时间周期,单位:秒,取值枚举值为60、300。
    ContinuousTime Integer 重复次数。取值范围 [1, 10]
    Statistic String 统计类型,可选字段如下:
  • AVERAGE:平均值
  • MAXIMUM:最大值
  • MINIMUM:最小值

  • 默认取值:AVERAGE

    NotificationTarget

    通知目标

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

    名称 类型 必选 描述
    TargetType String 目标类型,取值范围包括CMQ_QUEUECMQ_TOPIC
  • CMQ_QUEUE,指腾讯云消息队列-队列模型。
  • CMQ_TOPIC,指腾讯云消息队列-主题模型。
  • QueueName String 队列名称,如果TargetType取值为CMQ_QUEUE,则本字段必填。
    TopicName String 主题名称,如果TargetType取值为CMQ_TOPIC,则本字段必填。

    PaiInstance

    PAI实例

    被如下接口引用:DescribePaiInstances。

    名称 类型 描述
    InstanceId String 实例ID
    DomainName String 实例域名
    PaiMateUrl String PAI管理页面URL

    RunMonitorServiceEnabled

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

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

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

    默认取值:TRUE。
    注意:此字段可能返回 null,表示取不到有效值。
  • RunSecurityServiceEnabled

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

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

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

    默认取值:TRUE。
    注意:此字段可能返回 null,表示取不到有效值。
  • ScalingPolicy

    告警触发策略。

    被如下接口引用:DescribeScalingPolicies。

    名称 类型 描述
    AutoScalingGroupId String 伸缩组ID。
    AutoScalingPolicyId String 告警触发策略ID。
    ScalingPolicyName String 告警触发策略名称。
    AdjustmentType String 告警触发后,期望实例数修改方式。取值 :
  • CHANGE_IN_CAPACITY:增加或减少若干期望实例数
  • EXACT_CAPACITY:调整至指定期望实例数
  • PERCENT_CHANGE_IN_CAPACITY:按百分比调整期望实例数
  • AdjustmentValue Integer 告警触发后,期望实例数的调整值。
    Cooldown Integer 冷却时间。
    MetricAlarm MetricAlarm 告警监控指标。
    NotificationUserGroupIds Array of String 通知组ID,即为用户组ID集合。

    ScheduledAction

    描述定时任务的信息

    被如下接口引用:DescribeScheduledActions。

    名称 类型 描述
    ScheduledActionId String 定时任务ID。
    ScheduledActionName String 定时任务名称。
    AutoScalingGroupId String 定时任务所在伸缩组ID。
    StartTime Timestamp ISO8601 定时任务的开始时间。取值为北京时间(UTC+8),按照ISO8601标准,格式:YYYY-MM-DDThh:mm:ss+08:00
    Recurrence String 定时任务的重复方式。
    EndTime Timestamp ISO8601 定时任务的结束时间。取值为北京时间(UTC+8),按照ISO8601标准,格式:YYYY-MM-DDThh:mm:ss+08:00
    MaxSize Integer 定时任务设置的最大实例数。
    DesiredCapacity Integer 定时任务设置的期望实例数。
    MinSize Integer 定时任务设置的最小实例数。
    CreatedTime Timestamp ISO8601 定时任务的创建时间。取值为UTC时间,按照ISO8601标准,格式:YYYY-MM-DDThh:mm:ssZ

    ServiceSettings

    服务设置

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

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

    SpotMarketOptions

    竞价相关选项

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

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

    SpotMixedAllocationPolicy

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

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

    名称 类型 必选 描述
    BaseCapacity Integer 混合模式下,基础容量的大小,基础容量部分固定为按量计费实例。默认值 0,最大不可超过伸缩组的最大实例数。
    注意:此字段可能返回 null,表示取不到有效值。
    OnDemandPercentageAboveBaseCapacity Integer 超出基础容量部分,按量计费实例所占的比例。取值范围 [0, 100],0 代表超出基础容量的部分仅生产竞价实例,100 代表仅生产按量实例,默认值为 70。按百分比计算按量实例数时,向上取整。
    比如,总期望实例数取 3,基础容量取 1,超基础部分按量百分比取 1,则最终按量 2 台(1 台来自基础容量,1 台按百分比向上取整得到),竞价 1台。
    注意:此字段可能返回 null,表示取不到有效值。
    SpotAllocationStrategy String 混合模式下,竞价实例的分配策略。取值包括 COST_OPTIMIZED 和 CAPACITY_OPTIMIZED,默认取 COST_OPTIMIZED。

  • COST_OPTIMIZED,成本优化策略。对于启动配置内的所有机型,按照各机型在各可用区的每核单价由小到大依次尝试。优先尝试购买每核单价最便宜的,如果购买失败则尝试购买次便宜的,以此类推。

  • CAPACITY_OPTIMIZED,容量优化策略。对于启动配置内的所有机型,按照各机型在各可用区的库存情况由大到小依次尝试。优先尝试购买剩余库存最大的机型,这样可尽量降低竞价实例被动回收的发生概率。
    注意:此字段可能返回 null,表示取不到有效值。
  • CompensateWithBaseInstance Boolean 按量实例替补功能。取值范围:

  • TRUE,开启该功能,当所有竞价机型因库存不足等原因全部购买失败后,尝试购买按量实例。

  • FALSE,不开启该功能,伸缩组在需要扩容竞价实例时仅尝试所配置的竞价机型。

    默认取值: TRUE。
    注意:此字段可能返回 null,表示取不到有效值。
  • SystemDisk

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

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

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

    默认取值:CLOUD_PREMIUM。
    注意:此字段可能返回 null,表示取不到有效值。
  • DiskSize Integer 系统盘大小,单位:GB。默认值为 50
    注意:此字段可能返回 null,表示取不到有效值。

    Tag

    资源类型及标签键值对

    被如下接口引用:CreateAutoScalingGroup, DescribeAutoScalingGroups。

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

    TargetAttribute

    负载均衡器目标属性

    被如下接口引用:CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyLoadBalancers。

    名称 类型 必选 描述
    Port Integer 端口
    Weight Integer 权重
    目录