数据结构

最近更新时间:2019-03-14 16:31:59

Activity

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

被如下接口引用:DescribeAutoScalingActivities。

名称 类型 描述
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:替换不健康实例)
  • StatusCode String 伸缩活动状态。取值如下:

  • INIT:初始化中
  • RUNNING:运行中
  • SUCCESSFUL:活动成功
  • PARTIALLY_SUCCESSFUL:活动部分成功
  • FAILED:活动失败
  • CANCELLED:活动取消
  • StatusMessage String 伸缩活动状态描述。
    Cause String 伸缩活动起因。
    Description String 伸缩活动描述。
    StartTime Timestamp 伸缩活动开始时间。
    EndTime Timestamp 伸缩活动结束时间。
    CreatedTime Timestamp 伸缩活动创建时间。
    ActivityRelatedInstanceSet Array of ActivtyRelatedInstance 伸缩活动相关实例信息集合。
    StatusMessageSimplified String 伸缩活动状态简要描述。

    ActivtyRelatedInstance

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

    被如下接口引用:DescribeAutoScalingActivities。

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

    伸缩组

    被如下接口引用:DescribeAutoScalingGroups。

    名称 类型 描述
    AutoScalingGroupId String 伸缩组ID
    AutoScalingGroupName String 伸缩组名称
    AutoScalingGroupStatus String 伸缩组当前状态。取值范围:
  • NORMAL:正常
  • CVM_ABNORMAL:启动配置异常
  • LB_ABNORMAL:负载均衡器异常
  • VPC_ABNORMAL:VPC网络异常
  • INSUFFICIENT_BALANCE:余额不足
  • CreatedTime Timestamp 创建时间,采用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表示不处于伸缩活动中。

    AutoScalingGroupAbstract

    伸缩组简明信息。

    被如下接口引用:DescribeLaunchConfigurations。

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

    AutoScalingNotification

    弹性伸缩事件通知

    被如下接口引用:DescribeNotificationConfigurations。

    名称 类型 描述
    AutoScalingGroupId String 伸缩组ID。
    NotificationUserGroupIds Array of String 用户组ID列表。
    NotificationTypes Array of String 通知事件列表。
    AutoScalingNotificationId String 事件通知ID。

    DataDisk

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

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

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

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

    EnhancedService

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

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

    名称 类型 必选 描述
    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.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、DescribeNotificationConfigurations、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

    Instance

    实例信息

    被如下接口引用:DescribeAutoScalingInstances。

    名称 类型 描述
    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 Boolean 是否加入缩容保护
    Zone String 可用区
    CreationType String 创建类型,取值包括AUTO_CREATION, MANUAL_ATTACHING。
    AddTime Timestamp 实例加入时间
    InstanceType String 实例类型

    InstanceMarketOptionsRequest

    CVM竞价请求相关选项

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

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

    InternetAccessible

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

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

    名称 类型 必选 描述
    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,表示取不到有效值。
  • 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 启动配置创建时间。
    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 实例机型列表。

    LimitedLoginSettings

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

    被如下接口引用:DescribeLaunchConfigurations。

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

    LoginSettings

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

    被如下接口引用:CreateLaunchConfiguration。

    名称 类型 必选 描述
    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 时间周期。单位:秒
    ContinuousTime Integer 重复次数。取值范围 [1, 10]
    Statistic String 统计类型,可选字段如下:
  • AVERAGE:平均值
  • MAXIMUM:最大值
  • MINIMUM:最小值

  • 默认取值:AVERAGE

    RunMonitorServiceEnabled

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

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

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

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

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

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

    名称 类型 必选 描述
    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 String 告警触发后,期望实例数的调整值。
    Cooldown Integer 冷却时间。
    MetricAlarm MetricAlarm 告警监控指标。
    NotificationUserGroupIds Array of String 通知组ID,即为用户组ID集合。

    ScheduledAction

    描述定时任务的信息

    被如下接口引用:DescribeScheduledActions。

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

    SpotMarketOptions

    竞价相关选项

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

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

    SystemDisk

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

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

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

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

    TargetAttribute

    负载均衡器目标属性

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

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