{ "name": "autoscaling", "display_name": "弹性伸缩", "description": "介绍如何使用API对弹性伸缩服务进行操作，包括管理伸缩组、触发任务、生命周期等。", "domain": "compute", "api_version": "2018-04-19", "endpoint": "autoscaling.tencentcloudapi.com", "actions": [ { "name": "AttachInstances", "description": "本接口（AttachInstances）用于将 CVM 实例添加到伸缩组。 * 仅支持添加处于`RUNNING`（运行中）或`STOPPED`（已关机）状态的 CVM 实例 * 添加的 CVM 实例需要和伸缩组 VPC 网络一致", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可以通过如下方式获取可用的伸缩组ID: 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-boz1qhnk" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "CVM实例ID列表。可以通过以下方式获取可用的实例ID： 通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。 通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ，取返回信息中的 `InstanceId` 获取实例ID。", "example": "[\"ins-cri8d02t\",\"ins-osckfnm7\"]", "item_type": "string" } ], "required": [ "AutoScalingGroupId", "InstanceIds" ] }, { "name": "AttachLoadBalancers", "description": "此接口（AttachLoadBalancers）用于将负载均衡器添加到伸缩组。", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可通过登录 控制台 或调用接口 DescribeAutoScalingGroups ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-12wjuh0s" }, { "name": "LoadBalancerIds", "type": "array", "required": false, "description": "传统型负载均衡器ID列表，每个伸缩组绑定传统型负载均衡器数量上限为20，LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个。可以通过 DescribeLoadBalancers 接口获取。", "example": "[\"lb-crhgatrf\"]", "item_type": "string" }, { "name": "ForwardLoadBalancers", "type": "array", "required": false, "description": "负载均衡器列表，每个伸缩组绑定应用型负载均衡器数量上限为100，LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个。可以通过 DescribeLoadBalancers 接口获取。", "example": "无", "item_type": "object", "children": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡器ID。作为入参时，该参数必填。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "lb-fy6te4r5" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器 ID。作为入参时，该参数必填。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "lbl-dhyt56rf" }, { "name": "TargetAttributes", "type": "array", "required": true, "description": "目标规则属性列表。作为入参时，该参数必填。", "example": "[{\"Port\": 80, \"Weight\": 10}]", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "端口。取值范围为 [1,65535]。作为入参时，该参数必填。", "example": "80" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重。取值范围为 [0,100]。作为入参时，该参数必填。", "example": "10" } ] }, { "name": "LocationId", "type": "string", "required": false, "description": "转发规则ID，注意：针对七层监听器此参数必填。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "loc-sj8y6tr4" }, { "name": "Region", "type": "string", "required": false, "description": "负载均衡实例所属地域，默认取AS服务所在地域。格式与公共参数Region相同，如：\"ap-guangzhou\"。", "example": "ap-guangzhou" } ] } ], "required": [ "AutoScalingGroupId" ] }, { "name": "CancelInstanceRefresh", "description": "取消伸缩组的实例刷新活动。 * 已刷新的批次不受影响，待刷新批次被取消 * 如存在正在刷新的批次，不允许取消；可先暂停活动，等待当前批次结束后再取消 * 刷新失败的实例保持备用中状态，需用户手动处理后尝试退出备用中状态或销毁 * 取消后不允许回滚操作，也不支持恢复操作 * 因 maxSurge 参数而临时扩容的实例在取消后会自动销毁 * 进行缩容时，所有实例都已经更新\ufffd...", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可以通过如下方式获取可用的伸缩组ID: 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-u7dy6t5r" }, { "name": "RefreshActivityId", "type": "string", "required": true, "description": "刷新活动ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ，取返回信息中的 RefreshActivityId 获取实例刷新活动ID。", "example": "asr-dhwt6r54" } ], "required": [ "AutoScalingGroupId", "RefreshActivityId" ] }, { "name": "ClearLaunchConfigurationAttributes", "description": "本接口（ClearLaunchConfigurationAttributes）用于将启动配置内的特定属性完全清空。", "status": "online", "parameters": [ { "name": "LaunchConfigurationId", "type": "string", "required": true, "description": "启动配置ID。可通过如下方式获取： 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/config) 查询启动配置ID。 通过调用接口 [DescribeLaunchConfigurations](https://cloud.tencent.com/document/api/377/20445) ，取返回信息中的 LaunchConfigurationId 获取启动配置ID。", "example": "asc-w37yt5r4" }, { "name": "ClearDataDisks", "type": "boolean", "required": false, "description": "是否清空数据盘信息，非必填，默认为 false。 填 true 代表清空“数据盘”信息，清空后基于此新创建的云主机将不含有任何数据盘。", "example": "false" }, { "name": "ClearHostNameSettings", "type": "boolean", "required": false, "description": "是否清空云服务器主机名相关设置信息，非必填，默认为 false。 填 true 代表清空主机名设置信息，清空后基于此新创建的云主机将不设置主机名。", "example": "false" }, { "name": "ClearInstanceNameSettings", "type": "boolean", "required": false, "description": "是否清空云服务器实例名相关设置信息，非必填，默认为 false。 填 true 代表清空主机名设置信息，清空后基于此新创建的云主机将按照“as-{{ 伸缩组AutoScalingGroupName }}”进行设置。", "example": "false" }, { "name": "ClearDisasterRecoverGroupIds", "type": "boolean", "required": false, "description": "是否清空置放群组信息，非必填，默认为 false。 填 true 代表清空置放群组信息，清空后基于此新创建的云主机将不指定任何置放群组。", "example": "false" }, { "name": "ClearInstanceTags", "type": "boolean", "required": false, "description": "是否清空实例标签列表，非必填，默认为 false。 填 true 代表清空实例标签列表，清空后基于此新创建的云主机将不会绑定列表中的标签。", "example": "false" }, { "name": "ClearMetadata", "type": "boolean", "required": false, "description": "是否清空 MetaData，非必填，默认为 false。填 true 代表清空 MetaData，清空后基于此新创建的云主机将不会关联自定义的 Metadata。", "example": "false" } ], "required": [ "LaunchConfigurationId" ] }, { "name": "CompleteLifecycleAction", "description": "本接口（CompleteLifecycleAction）用于完成生命周期动作。 * 用户通过调用本接口，指定一个具体的生命周期挂钩的结果（“CONITNUE”或者“ABANDON”）。如果一直不调用本接口，则生命周期挂钩会在超时后按照“DefaultResult”进行处理。", "status": "online", "parameters": [ { "name": "LifecycleHookId", "type": "string", "required": true, "description": "生命周期挂钩ID。可以通过调用接口 [DescribeLifecycleHooks](https://cloud.tencent.com/document/api/377/34452) ，取返回信息中的 LifecycleHookId 获取生命周期挂钩ID。", "example": "ash-fbjiexz7" }, { "name": "LifecycleActionResult", "type": "string", "required": true, "description": "生命周期动作的结果，取值范围如下： CONTINUE: 默认值，表示继续执行扩缩容活动 ABANDON: 针对扩容挂钩，挂钩超时或 LifecycleCommand 执行失败的 CVM 实例会直接释放或移出；而针对缩容挂钩，会继续执行缩容活动。", "example": "CONTINUE" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID，`InstanceId` 和 `LifecycleActionToken` 参数必须填写其中一个。可通过登录 [控制台](https://console.cloud.tencent.com/cvm/index) 或调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ，取返回信息中的 `InstanceId` 获取实例ID。", "example": "ins-ni8bpmve" }, { "name": "LifecycleActionToken", "type": "string", "required": false, "description": "生命周期动作令牌，`InstanceId` 和 `LifecycleActionToken` 必须填充其中一个。 该参数获取方式如下：配置 `NotificationTarget ` 参数的挂钩被触发时，向 `NotificationTarget ` 参数中指定的消息队列投递包含令牌的消息，消息队列的消费者可从消息中获取令牌。", "example": "34b59a82-6435-4516-90db-c98aeb46769b" } ], "required": [ "LifecycleHookId", "LifecycleActionResult" ] }, { "name": "CreateAutoScalingGroup", "description": "本接口（CreateAutoScalingGroup）用于创建伸缩组", "status": "online", "parameters": [ { "name": "AutoScalingGroupName", "type": "string", "required": true, "description": "伸缩组名称，在您账号中必须唯一。名称仅支持中文、英文、数字、下划线、分隔符\"-\"、小数点，最大长度不能超55个字节。", "example": "asgname" }, { "name": "LaunchConfigurationId", "type": "string", "required": true, "description": "启动配置ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/config) 或调用接口 [DescribeLaunchConfigurations](https://cloud.tencent.com/document/api/377/20445) ，取返回信息中的 LaunchConfigurationId 获取启动配置ID。", "example": "asc-aaaabbbb" }, { "name": "MaxSize", "type": "integer", "required": true, "description": "最大实例数，取值范围为 [0,2000]，同时需满足 MaxSize \u003e= DesiredCapacity \u003e= MinSize 。", "example": "1" }, { "name": "MinSize", "type": "integer", "required": true, "description": "最小实例数，取值范围为 [0,2000]，同时需满足 MaxSize \u003e= DesiredCapacity \u003e= MinSize 。", "example": "1" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc)查询；也可以调用接口 [DescribeVpc](https://cloud.tencent.com/document/api/215/15778) ，从接口返回中的VpcId字段获取。", "example": "vpc-uhygtf56" }, { "name": "DefaultCooldown", "type": "integer", "required": false, "description": "默认冷却时间，单位秒，默认值为300。取值范围为 [0,3600]。", "example": "300" }, { "name": "DesiredCapacity", "type": "integer", "required": false, "description": "期望实例数，取值范围 [0,2000]，默认值等于当前 MinSize，同时需满足 MaxSize \u003e= DesiredCapacity \u003e= MinSize 。", "example": "1" }, { "name": "LoadBalancerIds", "type": "array", "required": false, "description": "传统负载均衡器ID列表，目前长度上限为20，LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "[\"lb-uhygtf56\"]", "item_type": "string" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "伸缩组内实例所属项目ID。默认值为0，表示使用默认项目。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。", "example": "1" }, { "name": "ForwardLoadBalancers", "type": "array", "required": false, "description": "负载均衡器列表，目前长度上限为100，LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个", "example": "无", "item_type": "object", "children": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡器ID。作为入参时，该参数必填。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "lb-fy6te4r5" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器 ID。作为入参时，该参数必填。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "lbl-dhyt56rf" }, { "name": "TargetAttributes", "type": "array", "required": true, "description": "目标规则属性列表。作为入参时，该参数必填。", "example": "[{\"Port\": 80, \"Weight\": 10}]", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "端口。取值范围为 [1,65535]。作为入参时，该参数必填。", "example": "80" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重。取值范围为 [0,100]。作为入参时，该参数必填。", "example": "10" } ] }, { "name": "LocationId", "type": "string", "required": false, "description": "转发规则ID，注意：针对七层监听器此参数必填。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "loc-sj8y6tr4" }, { "name": "Region", "type": "string", "required": false, "description": "负载均衡实例所属地域，默认取AS服务所在地域。格式与公共参数Region相同，如：\"ap-guangzhou\"。", "example": "ap-guangzhou" } ] }, { "name": "SubnetIds", "type": "array", "required": false, "description": "子网ID列表，VPC场景下必须指定子网。多个子网以填写顺序为优先级，依次进行尝试，直至可以成功创建实例。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet)查询；也可以调用接口 [DescribeSubnets](https://cloud.tencent.com/document/product/215/15784) ，从接口返回中的SubnetId字段获取。", "example": "[\"subnet-uhygtf56\"]", "item_type": "string" }, { "name": "TerminationPolicies", "type": "array", "required": false, "description": "销毁策略，目前长度上限为1。取值包括 OLDEST_INSTANCE 和 NEWEST_INSTANCE，默认取值为 OLDEST_INSTANCE。 OLDEST_INSTANCE 优先销毁伸缩组中最旧的实例。 NEWEST_INSTANCE，优先销毁伸缩组中最新的实例。", "example": "[\"OLDEST_INSTANCE\"]", "item_type": "string" }, { "name": "Zones", "type": "array", "required": false, "description": "可用区列表，基础网络场景下必须指定可用区。多个可用区以填写顺序为优先级，依次进行尝试，直至可以成功创建实例。", "example": "[\"ap-beijing-1\"]", "item_type": "string" }, { "name": "RetryPolicy", "type": "string", "required": false, "description": "重试策略，取值包括 IMMEDIATE_RETRY、 INCREMENTAL_INTERVALS、NO_RETRY，默认取值为 IMMEDIATE_RETRY。部分成功的伸缩活动判定为一次失败活动。 IMMEDIATE_RETRY，立即重试，在较短时间内快速重试，连续失败超过一定次数（5次）后不再重试。 INCREMENTAL_INTERVALS，间隔递增重试，随着连续失败次数的增加，重试间隔逐渐增大。前 10 次重试间隔与立即重试模式相同，后续逐步递增至 10 分钟、30 分\ufffd...", "example": "IMMEDIATE_RETRY" }, { "name": "ZonesCheckPolicy", "type": "string", "required": false, "description": "可用区校验策略，取值包括 ALL 和 ANY，默认取值为ANY。 ALL，所有可用区（Zone）或子网（SubnetId）都可用则通过校验，否则校验报错。 ANY，存在任何一个可用区（Zone）或子网（SubnetId）可用则通过校验，否则校验报错。 可用区或子网不可用的常见原因包括该可用区CVM实例类型售罄、该可用区CBS云盘售罄、该可用区配额不足、该子网IP不足等。 如果 Zones/SubnetIds 中可用区或者子网...", "example": "ALL" }, { "name": "Tags", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以支持绑定标签到伸缩组。同时绑定标签到相应的资源实例。每个伸缩组最多支持30个标签。可通过调用接口 [GetTags](https://cloud.tencent.com/document/product/651/72275) ，根据回参获取已有的标签键值对信息。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "as-group-tag0" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "app0" }, { "name": "ResourceType", "type": "string", "required": false, "description": "标签绑定的资源类型，当前支持类型：\"auto-scaling-group\", \"launch-configuration\"。分别表示：伸缩组资源，启动配置资源。", "example": "auto-scaling-group" } ] }, { "name": "ServiceSettings", "type": "object", "required": false, "description": "服务设置，包括云监控不健康替换等服务设置。", "example": "无", "children": [ { "name": "ReplaceMonitorUnhealthy", "type": "boolean", "required": false, "description": "开启监控不健康替换服务。若开启则对于云监控标记为不健康的实例，弹性伸缩服务会进行替换。若不指定该参数，则默认为 False。", "example": "false" }, { "name": "ScalingMode", "type": "string", "required": false, "description": "取值范围： CLASSIC_SCALING：经典方式，使用创建、销毁实例来实现扩缩容； WAKE_UP_STOPPED_SCALING：扩容优先开机。扩容时优先对已关机的实例执行开机操作，若开机后实例数仍低于期望实例数，则创建实例，缩容仍采用销毁实例的方式。用户可以使用StopAutoScalingInstances接口来关闭伸缩组内的实例。监控告警触发的扩容仍将创建实例 默认取值：CLASSIC_SCALING", "example": "CLASSIC_SCALING" }, { "name": "ReplaceLoadBalancerUnhealthy", "type": "boolean", "required": false, "description": "开启负载均衡不健康替换服务。若开启则对于负载均衡健康检查判断不健康的实例，弹性伸缩服务会进行替换。若不指定该参数，则默认为 False。", "example": "false" }, { "name": "ReplaceMode", "type": "string", "required": false, "description": "不健康替换服务的替换模式。取值范围： RECREATE：重建实例替代原有不健康实例； RESET：对原有不健康实例进行重装系统操作，可保持数据盘、内网IP、实例id等信息不发生变化，实例登录设置、主机名、增强服务和 UserData 与当前启动配置保持一致。 默认取值：RECREATE", "example": "RECREATE" }, { "name": "AutoUpdateInstanceTags", "type": "boolean", "required": false, "description": "自动更新实例标签。默认取值为 False，配置后如伸缩组标签发生更新，会同步更新（同步更新仅支持新增、修改标签，暂不支持删除标签）伸缩组内运行中状态实例的标签，同步更新非立即生效，存在一定延迟。", "example": "false" }, { "name": "DesiredCapacitySyncWithMaxMinSize", "type": "boolean", "required": false, "description": "期望实例数同步最大最小值。默认值为 False。该参数仅对修改伸缩组接口未传入期望数的场景生效。 True: 修改最大值或最小值时，如与当前期望数存在冲突，则同步调整期望数。例如修改时传入最小值 2，当前期望数为 1，则同步调整期望数为 2。 False: 修改最大值或最小值时，如与当前期望数存在冲突，报错提示不允许修改。", "example": "false" }, { "name": "PriorityScaleInUnhealthy", "type": "boolean", "required": false, "description": "优先缩容不健康实例。若开启，缩容时会优先选择不健康实例。默认值为 False。", "example": "false" } ] }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "实例具有IPv6地址数量的配置，取值包括0、1。默认值为 0，表示实例不分配 IPv6 地址。需使用支持 IPv6 的私有网络，需在子网中开启 IPv6 CIDR，其他使用限制可参考 [IPv6使用限制](https://cloud.tencent.com/document/product/1142/38369)。", "example": "1" }, { "name": "MultiZoneSubnetPolicy", "type": "string", "required": false, "description": "多可用区/子网策略，取值包括 PRIORITY 和 EQUALITY，默认为 PRIORITY。 PRIORITY，按照可用区/子网列表的顺序，作为优先级来尝试创建实例，如果优先级最高的可用区/子网可以创建成功，则总在该可用区/子网创建。 EQUALITY：扩容出的实例会打散到多个可用区/子网，保证扩容后的各个可用区/子网实例数相对均衡。 与本策略相关的注意点： 当伸缩组为基础网络时，本策略适用于多可\ufffd\ufffd...", "example": "PRIORITY " }, { "name": "HealthCheckType", "type": "string", "required": false, "description": "伸缩组实例健康检查类型，取值如下： CVM：根据实例网络状态判断实例是否处于不健康状态，不健康的网络状态即发生实例 PING 不可达事件，详细判断标准可参考[实例健康检查](https://cloud.tencent.com/document/product/377/8553) CLB：根据 CLB 的健康检查状态判断实例是否处于不健康状态，CLB健康检查原理可参考[健康检查](https://cloud.tencent.com/document/product/214/6097) 如果选择了`CLB`类型，伸\ufffd\ufffd...", "example": "CLB" }, { "name": "LoadBalancerHealthCheckGracePeriod", "type": "integer", "required": false, "description": "CLB健康检查宽限期，当扩容的实例进入`IN_SERVICE`后，在宽限期时间范围内将不会被标记为不健康`CLB_UNHEALTHY`。默认值：0。取值范围[0, 7200]，单位：秒。", "example": "0" }, { "name": "InstanceAllocationPolicy", "type": "string", "required": false, "description": "实例分配策略，取值包括 LAUNCH_CONFIGURATION 和 SPOT_MIXED，默认取 LAUNCH_CONFIGURATION。 LAUNCH_CONFIGURATION，代表传统的按照启动配置模式。 SPOT_MIXED，代表竞价混合模式。目前仅支持启动配置为按量计费模式时使用混合模式，混合模式下，伸缩组将根据设定扩容按量或竞价机型。使用混合模式时，关联的启动配置的计费类型不可被修改。", "example": "LAUNCH_CONFIGURATION" }, { "name": "SpotMixedAllocationPolicy", "type": "object", "required": false, "description": "竞价混合模式下，各计费类型实例的分配策略。 仅当 InstanceAllocationPolicy 取 SPOT_MIXED 时可用。", "example": "无", "children": [ { "name": "BaseCapacity", "type": "integer", "required": false, "description": "混合模式下，基础容量的大小，基础容量部分固定为按量计费实例。默认值 0，最大不可超过伸缩组的最大实例数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "OnDemandPercentageAboveBaseCapacity", "type": "integer", "required": false, "description": "超出基础容量部分，按量计费实例所占的比例。取值范围 [0, 100]，0 代表超出基础容量的部分仅生产竞价实例，100 代表仅生产按量实例，默认值为 70。按百分比计算按量实例数时，向上取整。 比如，总期望实例数取 3，基础容量取 1，超基础部分按量百分比取 1，则最终按量 2 台（1 台来自基础容量，1 台按百分比向上取整得到），竞价 1台。 注意：此字段可能返回 null，表示取\ufffd...", "example": "0" }, { "name": "SpotAllocationStrategy", "type": "string", "required": false, "description": "混合模式下，竞价实例的分配策略。取值包括 COST_OPTIMIZED 和 CAPACITY_OPTIMIZED，默认取 COST_OPTIMIZED。 COST_OPTIMIZED，成本优化策略。对于启动配置内的所有机型，按照各机型在各可用区的每核单价由小到大依次尝试。优先尝试购买每核单价最便宜的，如果购买失败则尝试购买次便宜的，以此类推。 CAPACITY_OPTIMIZED，容量优化策略。对于启动配置内的所有机型，按照各机型在各可用区\ufffd\ufffd...", "example": "COST_OPTIMIZED" }, { "name": "CompensateWithBaseInstance", "type": "boolean", "required": false, "description": "按量实例替补功能。取值范围： TRUE，开启该功能，当所有竞价机型因库存不足等原因全部购买失败后，尝试购买按量实例。 FALSE，不开启该功能，伸缩组在需要扩容竞价实例时仅尝试所配置的竞价机型。 默认取值： TRUE。 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "CapacityRebalance", "type": "boolean", "required": false, "description": "容量重平衡功能，仅对伸缩组内的竞价实例有效。取值范围： TRUE，开启该功能，当伸缩组内的竞价实例即将被竞价实例服务自动回收前，AS 主动发起竞价实例销毁流程，如果有配置过缩容 hook，则销毁前 hook 会生效。销毁流程启动后，AS 会异步开启一个扩容活动，用于补齐期望实例数。 FALSE，不开启该功能，则 AS 等待竞价实例被销毁后才会去扩容补齐伸缩组期望实例数。 默\ufffd\ufffd...", "example": "false" }, { "name": "InstanceNameIndexSettings", "type": "object", "required": false, "description": "实例名称序号相关设置。若不指定该参数，则默认不开启。开启后为伸缩组内自动创建的实例名称添加递增的数字序号。", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启实例创建序号，默认不开启。取值范围：TRUE：表示开启实例创建序号; FALSE：表示不开启实例创建序号 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "BeginIndex", "type": "integer", "required": false, "description": "初始序号。取值范围与 IndexLength 参数有关：- IndexLength 为 0 时，取值范围为 [0, 99999999]。- IndexLength 为 [1, 8] 时，取值范围为 [0, 10^IndexLength-1]，最大值即为指定位数的最大数字。初始序号默认值如下：- 首次启用递增序号：初始序号默认值为 0 （ 展示位数与 IndexLength 有关，例如 IndexLength 为 4，展示值为 0000）- 非首次开启递增序号：顺延之前的递增序号，例如上次使用递增至序\ufffd\ufffd...", "example": "0" }, { "name": "IndexLength", "type": "integer", "required": false, "description": "递增序号长度，默认为0，表示不指定序号长度。 取值范围：0-8，最大为整数8。 - 长度设置为3，序号展示形式为：000、001、002 ... 010、011 ... 100 ... 999，序号上限为999- 长度设置为0，序号展示形式为：0、1、2 ... 10、11 ... 100 ... 1000 ...10000 ... 99999999，序号上限为99999999注意：递增序号持续超出上限会导致扩容失败，请不要设置过小的递增序号长度。", "example": "0" } ] }, { "name": "HostNameIndexSettings", "type": "object", "required": false, "description": "实例主机名序号相关设置。若不指定该参数，则默认不开启。开启后为伸缩组内自动创建的实例主机名添加递增的数字序号。", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启实例主机名创建序号，默认不开启。取值范围：TRUE：表示开启实例主机名创建序号FALSE：表示不开启实例主机名创建序号", "example": "false" }, { "name": "BeginIndex", "type": "integer", "required": false, "description": "初始序号。取值范围与 IndexLength 参数有关：- IndexLength 为 0 时，取值范围为 [0, 99999999]。- IndexLength 为 [1, 8] 时，取值范围为 [0, 10^IndexLength-1]，最大值即为指定位数的最大数字。初始序号默认值如下：- 首次启用递增序号：初始序号默认值为 0 （ 展示位数与 IndexLength 有关，例如 IndexLength 为 4，展示值为 0000）- 非首次开启递增序号：顺延之前的递增序号，例如上次使用递增至序\ufffd\ufffd...", "example": "0" }, { "name": "IndexLength", "type": "integer", "required": false, "description": "递增序号长度，默认为0，表示不指定序号长度。 取值范围：0-8，最大为整数8。 - 长度设置为3，序号展示形式为：000、001、002 ... 010、011 ... 100 ... 999，序号上限为999- 长度设置为0，序号展示形式为：0、1、2 ... 10、11 ... 100 ... 1000 ...10000 ... 99999999，序号上限为99999999注意：递增序号持续超出上限会导致扩容失败，请不要设置过小的递增序号长度。", "example": "0" } ] }, { "name": "ConcurrentScaleOutForDesiredCapacity", "type": "boolean", "required": false, "description": "匹配期望数并发扩容功能，不能在InstanceAllocationPolicy为竞价混合模式时设置，也不能在ScalingMode为扩容优先开机模式时设置。目前仅支持两个匹配期望数扩容活动并发进行，不支持指定数量扩容、缩容等其他类型活动并发。默认值为FALSE，表示不开启。", "example": "false" } ], "required": [ "AutoScalingGroupName", "LaunchConfigurationId", "MaxSize", "MinSize", "VpcId" ] }, { "name": "CreateAutoScalingGroupFromInstance", "description": "本接口（CreateAutoScalingGroupFromInstance）用于根据实例创建启动配置及伸缩组。 说明：根据按包年包月计费的实例所创建的伸缩组，其扩容的实例为按量计费实例。", "status": "online", "parameters": [ { "name": "AutoScalingGroupName", "type": "string", "required": true, "description": "伸缩组名称，在您账号中必须唯一。名称仅支持中文、英文、数字、下划线、分隔符\"-\"、小数点，最大长度不能超55个字节。", "example": "asgname" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过登录[控制台](https://console.cloud.tencent.com/cvm/index)或调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ，取返回信息中的 `InstanceId` 获取实例ID。", "example": "ins-aaaabbbb" }, { "name": "MinSize", "type": "integer", "required": true, "description": "最小实例数，取值范围为 [0,2000]，同时需满足 MaxSize \u003e= DesiredCapacity \u003e= MinSize 。", "example": "1" }, { "name": "MaxSize", "type": "integer", "required": true, "description": "最大实例数，取值范围为 [0,2000]，同时需满足 MaxSize \u003e= DesiredCapacity \u003e= MinSize 。", "example": "1" }, { "name": "DesiredCapacity", "type": "integer", "required": false, "description": "期望实例数，取值范围 [0,2000]，默认值等于当前 MinSize，同时需满足 MaxSize \u003e= DesiredCapacity \u003e= MinSize 。", "example": "1" }, { "name": "InheritInstanceTag", "type": "boolean", "required": false, "description": "是否继承实例标签，默认值为False", "example": "False" } ], "required": [ "AutoScalingGroupName", "InstanceId", "MinSize", "MaxSize" ] }, { "name": "CreateLaunchConfiguration", "description": "本接口（CreateLaunchConfiguration）用于创建新的启动配置。 * 启动配置，可以通过 [ModifyLaunchConfigurationAttributes](https://cloud.tencent.com/document/api/377/31298) 修改少量字段。如需使用新的启动配置，建议重新创建启动配置。 * 每个地域默认只能创建50个启动配置，详见[使用限制](https://cloud.tencent.com/document/product/377/3120)。", "status": "online", "parameters": [ { "name": "LaunchConfigurationName", "type": "string", "required": true, "description": "启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符\"-\"、小数点，最大长度不能超60个字节。", "example": "as_test" }, { "name": "ImageId", "type": "string", "required": false, "description": "指定有效的镜像ID，格式形如img-8toqc6s3。镜像Id与镜像族名称，二者必填一个且只能填写一个。镜像类型分为四种：公共镜像自定义镜像共享镜像服务市场镜像可通过以下方式获取可用的镜像ID：公共镜像、自定义镜像、共享镜像的镜像ID可通过登录控制台查询；服务镜像市场的镜像ID可通过云市场查询。通过调用接口 DescribeImages ，取返回信息中的ImageId字段。", "example": "img-8toqc6s3" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "启动配置所属项目ID。默认值为0，表示使用默认项目。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。注意：伸缩组内实例所属项目ID取伸缩组项目ID，与这里取值无关。", "example": "0" }, { "name": "InstanceType", "type": "string", "required": false, "description": "实例机型。不同实例机型指定了不同的资源规格，具体取值可通过调用接口 DescribeInstanceTypeConfigs 来获得最新的规格表或参见实例类型描述。InstanceType和InstanceTypes参数互斥，二者必填一个且只能填写一个。", "example": "S2.SMALL1" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "实例系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见[云硬盘类型](https://cloud.tencent.com/document/product/362/2353)。取值范围 LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_BSSD：通用型SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 默认取值：CLOUD_PREMIUM。", "example": "CLOUD_PREMIUM" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GB。默认值为 50", "example": "50" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "实例数据盘配置信息。若不指定该参数，则默认不购买数据盘，最多支持指定11块数据盘。", "example": "无", "item_type": "object", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[云硬盘类型](https://cloud.tencent.com/document/product/362/2353)。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 CLOUD_BSSD：通用型SSD云硬盘 默认取值与系统盘类型（SystemDisk.DiskType）保持一致。", "example": "CLOUD_PREMIUM" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "数据盘大小，单位：GB。不同数据盘类型取值范围不同，具体限制详见：[CVM实例配置](https://cloud.tencent.com/document/product/213/2177)。默认值为0，表示不购买数据盘。更多限制详见[产品文档](https://cloud.tencent.com/document/product/362/5145)。", "example": "0" }, { "name": "SnapshotId", "type": "string", "required": false, "description": "数据盘快照 ID，可通过 [DescribeSnapshots](https://cloud.tencent.com/document/product/362/15647) 接口获取该参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "snap-l8psqwnt" }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "数据盘是否随子机销毁。取值范围： TRUE：子机销毁时，销毁数据盘，只支持按小时后付费云盘 FALSE：子机销毁时，保留数据盘 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "Encrypt", "type": "boolean", "required": false, "description": "数据盘是否加密。取值范围： TRUE：加密 FALSE：不加密 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "ThroughputPerformance", "type": "integer", "required": false, "description": "云硬盘性能，单位：MB/s。使用此参数可给云硬盘购买额外的性能，功能介绍和类型限制详见：[增强型 SSD 云硬盘额外性能说明](https://cloud.tencent.com/document/product/362/51896#.E5.A2.9E.E5.BC.BA.E5.9E.8B-ssd-.E4.BA.91.E7.A1.AC.E7.9B.98.E9.A2.9D.E5.A4.96.E6.80.A7.E8.83.BD)。 当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD）且 需容量 \u003e 460GB。 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "BurstPerformance", "type": "boolean", "required": false, "description": "突发性能。是否开启突发性能，默认取值为 false。当前该参数仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD）且需容量 \u003e 460GB。 注：内测中，需提单申请后使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型。取值范围：BANDWIDTH_PREPAID：预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费BANDWIDTH_PACKAGE：带宽包用户默认取值：TRAFFIC_POSTPAID_BY_HOUR。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/509)。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "PublicIpAssigned", "type": "boolean", "required": false, "description": "是否分配公网IP。取值范围：TRUE：表示分配公网IPFALSE：表示不分配公网IP当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID。可通过[DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bwp-dss86yt5" }, { "name": "InternetServiceProvider", "type": "string", "required": false, "description": "线路类型。各种线路类型及支持地区详情可参考：[EIP 的 IP 地址类型](https://cloud.tencent.com/document/product/1199/41646)。默认值：BGP。 BGP：常规 BGP 线路 已开通静态单线IP白名单的用户，可选值： CMCC：中国移动 CTCC：中国电信 CUCC：中国联通 注意：仅部分地域支持静态单线IP。", "example": "BGP" }, { "name": "IPv4AddressType", "type": "string", "required": false, "description": "公网 IP 类型。 WanIP：普通公网IP。 HighQualityEIP：精品 IP。仅新加坡和中国香港支持精品IP。 AntiDDoSEIP：高防 IP。仅部分地域支持高防IP，详情可见[弹性公网IP产品概述](https://cloud.tencent.com/document/product/1199/41646) 。 如需为资源分配弹性公网IPv4地址，请指定弹性公网IPv4地址类型。如只使用WanIP，不需要设置此字段。 精品IP 高防IP功能仅部分地区灰度开放，如需使用[请提交工单咨询]...", "example": "WanIP" }, { "name": "AntiDDoSPackageId", "type": "string", "required": false, "description": "高防包唯一ID，申请高防IP时，该字段必传。", "example": "bgp-00000000" }, { "name": "IsKeepEIP", "type": "boolean", "required": false, "description": "实例销毁时是否一并销毁绑定的弹性IP。 取值范围： TRUE：表示保留EIP FALSE：表示不保留 请注意，当IPv4AddressType字段指定EIP类型时，默认不保留EIP。WanIP不受此字段影响始终随实例销毁。 变更配置此字段，已绑定伸缩组会立刻生效。", "example": "false" } ] }, { "name": "LoginSettings", "type": "object", "required": false, "description": "实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码，并以站内信方式知会到用户。", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下： - Linux实例密码必须8到30位，至少包括四项（小写字母、大写字母、数字和特殊符号）中的两项。 - Windows实例密码必须12到30位，至少包括包括四项（小写字母、大写字母、数字和特殊符号）中的三项。 - 若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到用户。 特殊符号的取值范围： [( ) ` ~...", "example": "passExam@!7862543" }, { "name": "KeyIds", "type": "array", "required": false, "description": "密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。", "example": "[\"skey-ju7fy6t5\"]", "item_type": "string" }, { "name": "KeepImageLogin", "type": "boolean", "required": false, "description": "保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围： TRUE：表示保持镜像的登录设置 FALSE：表示不保持镜像的登录设置默认取值：FALSE。", "example": "false" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId字段来获取。若不指定该参数，则默认不绑定安全组。", "example": "[\"sg-arrfspxo\"]", "item_type": "string" }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认开启云监控、云安全服务。", "example": "无", "children": [ { "name": "SecurityService", "type": "object", "required": false, "description": "开启云安全服务。若不指定该参数，则默认开启云安全服务。", "example": "{\"Enabled\": True}", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云安全](https://cloud.tencent.com/document/product/296)服务。取值范围： TRUE：表示开启云安全服务 FALSE：表示不开启云安全服务 默认取值：TRUE。", "example": "{\"Enabled\": true}" } ] }, { "name": "MonitorService", "type": "object", "required": false, "description": "开启云监控服务。若不指定该参数，则默认开启云监控服务。", "example": "{\"Enabled\": True}", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[可观测平台（原名云监控）](https://cloud.tencent.com/document/product/248)服务。取值范围： TRUE：表示开启云监控服务 FALSE：表示不开启云监控服务 默认取值：TRUE。", "example": "{\"Enabled\": true}" } ] }, { "name": "AutomationToolsService", "type": "object", "required": false, "description": "开启自动化助手服务。若不指定该参数，则默认逻辑与CVM保持一致。注意：此字段可能返回 null，表示取不到有效值。", "example": "{\"Enabled\": True}", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[自动化助手](https://cloud.tencent.com/document/product/1340)服务。取值范围：TRUE：表示开启自动化助手服务FALSE：表示不开启自动化助手服务 注意：此字段可能返回 null，表示取不到有效值。", "example": "True" } ] } ] }, { "name": "UserData", "type": "string", "required": false, "description": "经过 Base64 编码后的自定义数据，最大长度不超过16KB。", "example": "IyEvYmluL2Jhc2gKZWNobyAxMjMKCg==" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "实例计费类型，CVM默认值按照POSTPAID_BY_HOUR处理。POSTPAID_BY_HOUR：按小时后付费SPOTPAID：竞价付费PREPAID：预付费，即包年包月CDCPAID：专用集群付费", "example": "POSTPAID_BY_HOUR" }, { "name": "InstanceMarketOptions", "type": "object", "required": false, "description": "实例的市场相关选项，如竞价实例相关参数，若指定实例的付费模式为竞价付费则该参数必传。", "example": "无", "children": [ { "name": "SpotOptions", "type": "object", "required": true, "description": "竞价相关选项", "example": "{\"SpotInstanceType\": \"one-time\", \"MaxPrice\": 1000}", "children": [ { "name": "MaxPrice", "type": "string", "required": true, "description": "竞价出价，例如“1.05”", "example": "1.05" }, { "name": "SpotInstanceType", "type": "string", "required": false, "description": "竞价请求类型，当前仅支持类型：one-time，默认值为one-time", "example": "one-time" } ] }, { "name": "MarketType", "type": "string", "required": false, "description": "市场选项类型，当前只支持取值：spot", "example": "spot" } ] }, { "name": "InstanceTypes", "type": "array", "required": false, "description": "实例机型列表，不同实例机型指定了不同的资源规格，最多支持10种实例机型。InstanceType和InstanceTypes参数互斥，二者必填一个且只能填写一个。具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表或参见实例规格描述。", "example": "[\"S5.MEDIUM2\", \"S6.MEDIUM2\"]", "item_type": "string" }, { "name": "CamRoleName", "type": "string", "required": false, "description": "CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。", "example": "CVM_QcsRole" }, { "name": "InstanceTypesCheckPolicy", "type": "string", "required": false, "description": "实例类型校验策略，取值包括 ALL 和 ANY，默认取值为ANY。该参数仅在 InstanceTypes 入参包含多个机型时生效。 ALL，所有实例类型（InstanceType）都可用则通过校验，否则校验报错。 ANY，存在任何一个实例类型（InstanceType）可用则通过校验，否则校验报错。实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。如果 InstanceTypes 中一款机型不存在或者已下线，则无论 Insta...", "example": "ANY" }, { "name": "InstanceTags", "type": "array", "required": false, "description": "标签列表。通过指定该参数，可以为扩容的实例绑定标签。最多支持指定10个标签。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "as-tag-key-app0" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "as-tag-value-app0" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以支持绑定标签到启动配置。每个启动配置最多支持30个标签。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "as-group-tag0" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "app0" }, { "name": "ResourceType", "type": "string", "required": false, "description": "标签绑定的资源类型，当前支持类型：\"auto-scaling-group\", \"launch-configuration\"。分别表示：伸缩组资源，启动配置资源。", "example": "auto-scaling-group" } ] }, { "name": "HostNameSettings", "type": "object", "required": false, "description": "云服务器主机名（HostName）的相关设置。不支持windows实例设置主机名。 新增该属性时，必须传递云服务器的主机名，其它未传递字段会设置为默认值。会校验主机名(如果存在后缀则加上后缀)是否超过最大位数46。", "example": "无", "children": [ { "name": "HostName", "type": "string", "required": true, "description": "云服务器的主机名。 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。 不支持 Windows 实例。 其他类型（Linux 等）实例：字符长度为[2, 42]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。不允许为纯数字。 注意：此字段可能返回 null，表示取不到有效值。", "example": "product-as-host-0" }, { "name": "HostNameStyle", "type": "string", "required": false, "description": "云服务器主机名的风格，取值范围包括 ORIGINAL 和 UNIQUE，默认为 ORIGINAL。 ORIGINAL，AS 直接将入参中所填的 HostName 传递给 CVM，CVM 可能会对 HostName 追加序列号，伸缩组中实例的 HostName 会出现冲突的情况。 UNIQUE，入参所填的 HostName 相当于主机名前缀，AS 和 CVM 会对其进行拓展，伸缩组中实例的 HostName 可以保证唯一。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ORIGINAL" }, { "name": "HostNameSuffix", "type": "string", "required": false, "description": "云服务器的主机名后缀。 点号（.）和短横线（-）不能作为 HostNameSuffix 的尾字符，不能连续使用。 不支持 Windows 实例。 其他类型（Linux 等）实例：字符长度为[1, 39]，且与 HostName 的长度和不能超过 41，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。 注意：此字段可能返回 null，表示取不到有效值。", "example": "suffix" }, { "name": "HostNameDelimiter", "type": "string", "required": false, "description": "云服务器的主机名分隔符。默认的分隔符是点号（.），可选短横线（-）或空字符串。 分隔符用于拼接主机名，递增序号，后缀。假设主机名为 testGpu4090 ，递增序号为 0007，后缀为 server： - 分隔符为英文点号（.），最终拼接为 testGpu4090.007.server - 分隔符为短横线（-），最终拼接为 testGpu4090-007-server - 分隔符为空字符串，最终拼接为 testGpu4090007server", "example": "." } ] }, { "name": "InstanceNameSettings", "type": "object", "required": false, "description": "云服务器实例名（InstanceName）的相关设置。如果用户在启动配置中设置此字段，则伸缩组创建出的实例 InstanceName 参照此字段进行设置，并传递给 CVM；如果用户未在启动配置中设置此字段，则伸缩组创建出的实例 InstanceName 按照“as-{{ 伸缩组AutoScalingGroupName }}”进行设置，并传递给 CVM。新增该属性时，必须传递云服务器的实例名称，其它未传递字段会设置为默认值。会校验实例...", "example": "无", "children": [ { "name": "InstanceName", "type": "string", "required": true, "description": "云服务器的实例名。字符长度为[2, 108]。", "example": "product-as-ins-0" }, { "name": "InstanceNameStyle", "type": "string", "required": false, "description": "云服务器实例名的风格，取值范围包括 ORIGINAL 和 UNIQUE，默认为 ORIGINAL。 ORIGINAL，AS 直接将入参中所填的 InstanceName 传递给 CVM，CVM 可能会对 InstanceName 追加序列号，伸缩组中实例的 InstanceName 会出现冲突的情况。 UNIQUE，入参所填的 InstanceName 相当于实例名前缀，AS 和 CVM 会对其进行拓展，伸缩组中实例的 InstanceName 可以保证唯一。", "example": "ORIGINAL" }, { "name": "InstanceNameSuffix", "type": "string", "required": false, "description": "云服务器实例名后缀。字符长度为[1,105]，且与 InstanceName 的长度和不能超过107。 注意：此字段可能返回 null，表示取不到有效值。", "example": "testsuffix" }, { "name": "InstanceNameDelimiter", "type": "string", "required": false, "description": "云服务器的实例名分隔符。默认的分隔符是点号（.），可选短横线（-）或空字符串。 分隔符用于拼接实例名，递增序号，后缀。假设实例名为 testGpu4090 ，递增序号为 0007，后缀为 server： - 分隔符为英文点号（.），最终拼接为 testGpu4090.007.server - 分隔符为短横线（-），最终拼接为 testGpu4090-007-server - 分隔符为空字符串，最终拼接为 testGpu4090007server", "example": "." } ] }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "NOTIFY_AND_MANUAL_RENEW" } ] }, { "name": "DiskTypePolicy", "type": "string", "required": false, "description": "云盘类型选择策略，默认取值 ORIGINAL，取值范围：ORIGINAL：使用设置的云盘类型AUTOMATIC：自动选择当前可用的云盘类型", "example": "ORIGINAL" }, { "name": "HpcClusterId", "type": "string", "required": false, "description": "高性能计算集群ID。可通过调用DescribeHpcClusters接口获取该参数。注意：此字段默认为空。", "example": "hpc-gt4es2q1" }, { "name": "IPv6InternetAccessible", "type": "object", "required": false, "description": "IPv6公网带宽相关信息设置。若新建实例包含IPv6地址，该参数可为新建实例的IPv6地址分配公网带宽。关联启动配置的伸缩组Ipv6AddressCount参数为0时，该参数不会生效。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费模式。取值包括TRAFFIC_POSTPAID_BY_HOUR、BANDWIDTH_PACKAGE，默认取值为TRAFFIC_POSTPAID_BY_HOUR。查看当前账户类型可参考[账户类型说明](https://cloud.tencent.com/document/product/1199/49090#judge)。 IPv6对标准账户类型支持TRAFFIC_POSTPAID_BY_HOUR。 IPv6对传统账户类型支持BANDWIDTH_PACKAGE。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0，此时不为IPv6分配公网带宽。不同机型、可用区、计费模式的带宽上限范围不一致，具体限制详见[公网带宽上限](https://cloud.tencent.com/document/product/213/12523)。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID。可通过[DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bwp-jfio9i0p" } ] }, { "name": "DisasterRecoverGroupIds", "type": "array", "required": false, "description": "置放群组id，仅支持指定一个。", "example": "[\"ps-dy7ui89o\"]", "item_type": "string" }, { "name": "ImageFamily", "type": "string", "required": false, "description": "镜像族名称。镜像Id与镜像族名称，二者必填一个且只能填写一个。可通过调用DescribeImages接口获取该参数。", "example": "test-family" }, { "name": "DedicatedClusterId", "type": "string", "required": false, "description": "本地专用集群ID。可通过 DescribeDedicatedClusters 接口获取该参数。", "example": "cluster-gbo27yc4" }, { "name": "Metadata", "type": "object", "required": false, "description": "自定义metadata。", "example": "无", "children": [ { "name": "Items", "type": "array", "required": false, "description": "自定义 Metadata 键值对列表", "example": "[{\"Key\": \"Key123_4-5\", \"Value\": \"valueExam\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "自定义 MetaData 键", "example": "keyA-123_4" }, { "name": "Value", "type": "string", "required": true, "description": "自定义 MetaData 值", "example": "Value123" } ] } ] } ], "required": [ "LaunchConfigurationName" ] }, { "name": "CreateLifecycleHook", "description": "本接口（CreateLifecycleHook）用于创建生命周期挂钩。 * 您可以为生命周期挂钩配置消息通知或执行自动化助手命令。 如果您配置了通知消息，弹性伸缩会通知您的TDMQ消息队列，通知内容形如： ``` { \"Service\": \"Tencent Cloud Auto Scaling\", \"Time\": \"2019-03-14T10:15:11Z\", \"AppId\": \"1251783334\", \"ActivityId\": \"asa-fznnvrja\", \"AutoScalingGroupId\": \"asg-ft6y7u8n\", \"LifecycleHookId\": \"ash-p9i7y6t5\", \"LifecycleHookName\": \"my-hook\", \"Lifecycle...", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可以通过如下方式获取可用的伸缩组ID: 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-8fbozqja" }, { "name": "LifecycleHookName", "type": "string", "required": true, "description": "生命周期挂钩名称。名称仅支持中文、英文、数字、下划线（_）、短横线（-）、小数点（.），最大长度不能超128个字节。", "example": "one-hook-default" }, { "name": "LifecycleTransition", "type": "string", "required": true, "description": "进行生命周期挂钩的场景，取值范围如下: INSTANCE_LAUNCHING: 扩容生命周期挂钩 INSTANCE_TERMINATING: 缩容生命周期挂钩", "example": "INSTANCE_LAUNCHING" }, { "name": "DefaultResult", "type": "string", "required": false, "description": "定义伸缩组在生命周期挂钩超时或 LifecycleCommand 执行失败时应采取的操作，取值范围如下： CONTINUE: 默认值，表示继续执行扩缩容活动 ABANDON: 针对扩容挂钩，挂钩超时或 LifecycleCommand 执行失败的 CVM 实例会直接释放或移出；而针对缩容挂钩，会继续执行缩容活动。", "example": "CONTINUE" }, { "name": "HeartbeatTimeout", "type": "integer", "required": false, "description": "生命周期挂钩超时之前可以经过的最长时间（以秒为单位），范围从30到7200秒，默认值为300秒", "example": "300" }, { "name": "NotificationMetadata", "type": "string", "required": false, "description": "弹性伸缩向通知目标发送的附加信息，配置通知时使用，默认值为空字符串，最长不超过 1024 字符。NotificationMetadata 和 LifecycleCommand参数互斥，二者不可同时指定。", "example": "addtional-info" }, { "name": "NotificationTarget", "type": "object", "required": false, "description": "通知目标。NotificationTarget和LifecycleCommand参数互斥，二者不可同时指定。", "example": "{\"QueueName\": \"as-pool\", \"TargetType\": \"TDMQ_CMQ_QUEUE\"}", "children": [ { "name": "TargetType", "type": "string", "required": true, "description": "目标类型，取值范围包括`CMQ_QUEUE`、`CMQ_TOPIC`、`TDMQ_CMQ_QUEUE`、`TDMQ_CMQ_TOPIC`。 CMQ_QUEUE，指腾讯云消息队列-队列模型，对应产品已下线，[建议切换](https://cloud.tencent.com/document/product/1496/83970) TDMQ_CMQ_QUEUE 使用。 CMQ_TOPIC，指腾讯云消息队列-主题模型，对应产品已下线，[建议切换](https://cloud.tencent.com/document/product/1496/83970) TDMQ_CMQ_TOPIC 使用。 TDMQ_CMQ_QUEUE，指腾讯云 TDMQ 消息队列-队列模\ufffd...", "example": "TDMQ_CMQ_QUEUE" }, { "name": "QueueName", "type": "string", "required": false, "description": "队列名称，如果`TargetType`取值为`CMQ_QUEUE` 或 `TDMQ_CMQ_QUEUE`，则本字段必填。", "example": "test-queue" }, { "name": "TopicName", "type": "string", "required": false, "description": "主题名称，如果`TargetType`取值为`CMQ_TOPIC` 或 `TDMQ_CMQ_TOPIC`，则本字段必填。", "example": "test-topic" } ] }, { "name": "LifecycleTransitionType", "type": "string", "required": false, "description": "进行生命周期挂钩的场景类型，取值范围包括 NORMAL 和 EXTENSION，默认值为 NORMAL。 说明：设置为EXTENSION值，在 [AttachInstances](https://cloud.tencent.com/document/api/377/20441)、[DetachInstances](https://cloud.tencent.com/document/api/377/20436)、[RemoveInstaces](https://cloud.tencent.com/document/api/377/20431)、[StopAutoScalingInstances](https://cloud.tencent.com/document/api/377/40286)、[StartAutoScalingInstances](https://cloud.tencent.com/document/api/3...", "example": "NORMAL" }, { "name": "LifecycleCommand", "type": "object", "required": false, "description": "远程命令执行对象。通知相关参数（NotificationTarget、NotificationMetadata）与该参数互斥，二者不可同时指定。", "example": "{\"CommandId\": \"cmd-am4e3hd8\", \"Parameters\": \"{123: 222}\"}", "children": [ { "name": "CommandId", "type": "string", "required": true, "description": "远程命令ID。若选择执行命令，则此项必填。", "example": "cmd-gt5dre32" }, { "name": "Parameters", "type": "string", "required": false, "description": "自定义参数。字段类型为 json encoded string。如：{\"varA\": \"222\"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 进行替换。 自定义参数最多20个。自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。", "example": "{\"varA\": \"222\"}" } ] } ], "required": [ "AutoScalingGroupId", "LifecycleHookName", "LifecycleTransition" ] }, { "name": "CreateNotificationConfiguration", "description": "本接口（CreateNotificationConfiguration）用于创建通知。 通知到 CMQ 主题或队列时，消息内容如下： ``` { \"Service\": \"Tencent Cloud Auto Scaling\", \"CreatedTime\": \"2021-10-11T10:15:11Z\", // 活动创建时间 \"AppId\": \"100000000\", \"ActivityId\": \"asa-fznnvrja\", // 伸缩活动ID \"AutoScalingGroupId\": \"asg-pc2oqu2z\", // 伸缩组ID \"ActivityType\": \"SCALE_OUT\", // 伸缩活动类型 \"StatusCode\": \"SUCCESSFUL\", // 伸缩活动结果 \"Description\": \"Activity was launched in re...", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-12wjuh0s" }, { "name": "NotificationTypes", "type": "array", "required": true, "description": "通知类型，即为需要订阅的通知类型集合，取值范围如下： SCALE_OUT_SUCCESSFUL：扩容成功 SCALE_OUT_FAILED：扩容失败 SCALE_IN_SUCCESSFUL：缩容成功 SCALE_IN_FAILED：缩容失败 REPLACE_UNHEALTHY_INSTANCE_SUCCESSFUL：替换不健康子机成功 REPLACE_UNHEALTHY_INSTANCE_FAILED：替换不健康子机失败", "example": "[\"SCALE_OUT_SUCCESSFUL\",\"SCALE_OUT_FAILED\"]", "item_type": "string" }, { "name": "NotificationUserGroupIds", "type": "array", "required": false, "description": "通知组ID，即为用户组ID集合，用户组ID可以通过[ListGroups](https://cloud.tencent.com/document/product/598/34589)查询。该参数仅在 TargetType 为 USER_GROUP 时生效。", "example": "[\"1678\"]", "item_type": "string" }, { "name": "TargetType", "type": "string", "required": false, "description": "通知接收端类型，取值如下： USER_GROUP：用户组 TDMQ_CMQ_TOPIC：TDMQ CMQ 主题 TDMQ_CMQ_QUEUE：TDMQ CMQ 队列 CMQ_QUEUE：CMQ 队列，[CMQ已下线](https://cloud.tencent.com/document/product/1496/83970)，目前仅推荐使用 TDMQ CMQ。 CMQ_TOPIC：CMQ 主题，[CMQ已下线](https://cloud.tencent.com/document/product/1496/83970)，目前仅推荐使用 TDMQ CMQ。 默认值为：`USER_GROUP`。", "example": "USER_GROUP" }, { "name": "QueueName", "type": "string", "required": false, "description": "TDMQ CMQ 队列名，如 TargetType 取值为 `TDMQ_CMQ_QUEUE` ，该字段必填。", "example": "queue" }, { "name": "TopicName", "type": "string", "required": false, "description": "TDMQ CMQ 主题名，如 TargetType 取值为 `TDMQ_CMQ_TOPIC` ，该字段必填。", "example": "topic" } ], "required": [ "AutoScalingGroupId", "NotificationTypes" ] }, { "name": "CreateScalingPolicy", "description": "本接口（CreateScalingPolicy）用于创建告警触发策略。 - 目标追踪策略触发扩容的条件为，指定类型指标连续 3 个周期高于阈值（目标值），每个周期 1 分钟；触发缩容的条件为，指定类型指标连续 15 个周期低于阈值（目标值的80%），每个周期 1 分钟。", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-12wjuh0s" }, { "name": "ScalingPolicyName", "type": "string", "required": true, "description": "告警策略名称，在您账号中必须唯一。名称长度不能超过60，名称仅支持中文、英文、数字、下划线、分隔符\"-\"、小数点。", "example": "cpu_policy_test" }, { "name": "ScalingPolicyType", "type": "string", "required": false, "description": "告警触发策略类型，默认类型为SIMPLE。取值范围： SIMPLE：简单策略 TARGET_TRACKING：目标追踪策略", "example": "SIMPLE" }, { "name": "AdjustmentType", "type": "string", "required": false, "description": "告警触发后，期望实例数修改方式，仅适用于简单策略，在简单策略场景下必填。取值范围： CHANGE_IN_CAPACITY：增加或减少若干期望实例数 EXACT_CAPACITY：调整至指定期望实例数 PERCENT_CHANGE_IN_CAPACITY：按百分比调整期望实例数", "example": "CHANGE_IN_CAPACITY" }, { "name": "AdjustmentValue", "type": "integer", "required": false, "description": "告警触发后，期望实例数的调整值，仅适用于简单策略，在简单策略场景下必填。 当 AdjustmentType 为 CHANGE_IN_CAPACITY 时，AdjustmentValue 为正数表示告警触发后增加实例，为负数表示告警触发后减少实例 当 AdjustmentType 为 EXACT_CAPACITY 时，AdjustmentValue 的值即为告警触发后新的期望实例数，需要大于或等于0 当 AdjustmentType 为 PERCENT_CHANGE_IN_CAPACITY 时，AdjusmentValue 为正数表示告警触发后按\ufffd...", "example": "1" }, { "name": "Cooldown", "type": "integer", "required": false, "description": "冷却时间，单位为秒，仅适用于简单策略。默认冷却时间300秒。", "example": "60" }, { "name": "MetricAlarm", "type": "object", "required": false, "description": "告警监控指标，仅适用于简单策略，在简单策略场景下必填。", "example": "无", "children": [ { "name": "ComparisonOperator", "type": "string", "required": true, "description": "比较运算符，可选值：GREATER_THAN：大于GREATER_THAN_OR_EQUAL_TO：大于或等于LESS_THAN：小于 LESS_THAN_OR_EQUAL_TO：小于或等于 EQUAL_TO：等于 NOT_EQUAL_TO：不等于", "example": "GREATER_THAN" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标名称，可选字段如下：CPU_UTILIZATION：CPU利用率MEM_UTILIZATION：内存利用率LAN_TRAFFIC_OUT：内网出带宽LAN_TRAFFIC_IN：内网入带宽WAN_TRAFFIC_OUT：外网出带宽WAN_TRAFFIC_IN：外网入带宽TCP_CURR_ESTAB：TCP连接数当前外网出入带宽属于 CLB 类指标，其他指标属于 CVM 类指标。修改指标名称时不允许跨类别修改。", "example": "CPU_UTILIZATION" }, { "name": "Threshold", "type": "integer", "required": true, "description": "告警阈值：CPU_UTILIZATION：[1, 100]，单位：%MEM_UTILIZATION：[1, 100]，单位：%LAN_TRAFFIC_OUT：\u0026gt;0，单位：Mbps LAN_TRAFFIC_IN：\u0026gt;0，单位：MbpsWAN_TRAFFIC_OUT：\u0026gt;0，单位：MbpsWAN_TRAFFIC_IN：\u0026gt;0，单位：MbpsTCP_CURR_ESTAB：\u0026gt;0, 单位：Count", "example": "10" }, { "name": "Period", "type": "integer", "required": true, "description": "时间周期，单位：秒，取值枚举值为60、300。", "example": "60" }, { "name": "ContinuousTime", "type": "integer", "required": true, "description": "重复次数。取值范围 [1, 10]", "example": "3" }, { "name": "Statistic", "type": "string", "required": false, "description": "统计类型，可选字段如下：AVERAGE：平均值MAXIMUM：最大值MINIMUM：最小值 默认取值：AVERAGE", "example": "AVERAGE" }, { "name": "PreciseThreshold", "type": "float", "required": false, "description": "精确告警阈值，本参数不作为入参输入，仅用作查询接口出参：CPU_UTILIZATION：(0, 100]，单位：%MEM_UTILIZATION：(0, 100]，单位：%LAN_TRAFFIC_OUT：\u0026gt;0，单位：Mbps LAN_TRAFFIC_IN：\u0026gt;0，单位：MbpsWAN_TRAFFIC_OUT：\u0026gt;0，单位：MbpsWAN_TRAFFIC_IN：\u0026gt;0，单位：MbpsTCP_CURR_ESTAB：\u0026gt;0, 单位：Count", "example": "10.123" } ] }, { "name": "PredefinedMetricType", "type": "string", "required": false, "description": "预定义监控项，仅适用于目标追踪策略，在目标追踪策略场景下必填。取值范围： 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：平均外网入带宽", "example": "ASG_AVG_CPU_UTILIZATION" }, { "name": "TargetValue", "type": "integer", "required": false, "description": "目标值，仅适用于目标追踪策略，在目标追踪策略场景下必填。 ASG_AVG_CPU_UTILIZATION：[1, 100)，单位：% ASG_AVG_LAN_TRAFFIC_OUT：\u003e0，单位：Mbps ASG_AVG_LAN_TRAFFIC_IN：\u003e0，单位：Mbps ASG_AVG_WAN_TRAFFIC_OUT：\u003e0，单位：Mbps ASG_AVG_WAN_TRAFFIC_IN：\u003e0，单位：Mbps", "example": "10" }, { "name": "EstimatedInstanceWarmup", "type": "integer", "required": false, "description": "实例预热时间，单位为秒，仅适用于目标追踪策略。取值范围为0-3600，默认预热时间300秒。", "example": "300" }, { "name": "DisableScaleIn", "type": "boolean", "required": false, "description": "是否禁用缩容，仅适用于目标追踪策略，默认值为 false。取值范围： true：目标追踪策略仅触发扩容 false：目标追踪策略触发扩容和缩容", "example": "false" }, { "name": "NotificationUserGroupIds", "type": "array", "required": false, "description": "此参数已不再生效，请使用[创建通知](https://cloud.tencent.com/document/api/377/33185)。 通知组ID，即为用户组ID集合。", "example": "[\"1678\"]", "item_type": "string" } ], "required": [ "AutoScalingGroupId", "ScalingPolicyName" ] }, { "name": "CreateScheduledAction", "description": "本接口（CreateScheduledAction）用于创建定时任务。", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可以通过如下方式获取可用的伸缩组ID: 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-2nr9xh8h" }, { "name": "ScheduledActionName", "type": "string", "required": true, "description": "定时任务名称。名称仅支持中文、英文、数字、下划线、分隔符\"-\"、小数点，最大长度不能超60个字节。同一伸缩组下必须唯一。", "example": "scheduled-action-0" }, { "name": "MinSize", "type": "integer", "required": true, "description": "当定时任务触发时，设置的伸缩组最小实例数。", "example": "4" }, { "name": "StartTime", "type": "string", "required": true, "description": "定时任务的首次触发时间，取值为`北京时间`（UTC+8），按照`ISO8601`标准，格式：`YYYY-MM-DDThh:mm:ss+08:00`。", "example": "2018-08-28T23:00:00+08:00" }, { "name": "DesiredCapacity", "type": "integer", "required": true, "description": "当定时任务触发时，设置的伸缩组期望实例数。", "example": "6" }, { "name": "MaxSize", "type": "integer", "required": true, "description": "当定时任务触发时，设置的伸缩组最大实例数。", "example": "10" }, { "name": "EndTime", "type": "string", "required": false, "description": "定时任务的结束时间，取值为`北京时间`（UTC+8），按照`ISO8601`标准，格式：`YYYY-MM-DDThh:mm:ss+08:00`。此参数与`Recurrence`需要同时指定，到达结束时间之后，定时任务将不再生效。", "example": "2019-01-01T00:00:00+08:00" }, { "name": "Recurrence", "type": "string", "required": false, "description": "定时任务的重复方式。为标准 Cron 格式。定时任务中的 [Recurrence参数限制](https://cloud.tencent.com/document/product/377/88119) 为5个字段，由空格分开，结构为：分，小时，日期，月份，星期。此参数与`EndTime`需要同时指定。", "example": "0 14 */1 * *" }, { "name": "DisableUpdateDesiredCapacity", "type": "boolean", "required": false, "description": "停用期望数更新。默认值为 False，表示定时任务触发时期望实例数正常更新。 该值为 True 时，定时任务触发时不会主动修改期望实例数，但可能会因最大最小值机制修改期望实例数。 以下案例的前提都是停用期望数更新为 True： - 定时任务触发时，原期望数为 5，定时任务将最小值改为 10，最大值改为 20，期望数改为 15，由于停用期望数更新，15不生效，但原期望数 5 小于最小...", "example": "false" } ], "required": [ "AutoScalingGroupId", "ScheduledActionName", "MinSize", "StartTime", "DesiredCapacity", "MaxSize" ] }, { "name": "DeleteAutoScalingGroup", "description": "本接口（DeleteAutoScalingGroup）用于删除指定伸缩组，删除前提是伸缩组内无运行中（IN_SERVICE）状态的实例且当前未在执行伸缩活动。删除伸缩组后，创建失败（CREATION_FAILED）、中止失败（TERMINATION_FAILED）、解绑失败（DETACH_FAILED）等非运行中状态的实例不会被销毁。", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-nvnlpbb8" } ], "required": [ "AutoScalingGroupId" ] }, { "name": "DeleteLaunchConfiguration", "description": "本接口（DeleteLaunchConfiguration）用于删除启动配置。 * 若启动配置在伸缩组中属于生效状态，则该启动配置不允许删除。", "status": "online", "parameters": [ { "name": "LaunchConfigurationId", "type": "string", "required": true, "description": "需要删除的启动配置ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/config) 或调用接口 [DescribeLaunchConfigurations](https://cloud.tencent.com/document/api/377/20445) ，取返回信息中的 LaunchConfigurationId 获取启动配置ID。", "example": "asc-deuy6tre" } ], "required": [ "LaunchConfigurationId" ] }, { "name": "DeleteLifecycleHook", "description": "本接口（DeleteLifecycleHook）用于删除生命周期挂钩。", "status": "online", "parameters": [ { "name": "LifecycleHookId", "type": "string", "required": true, "description": "生命周期挂钩ID。可以通过调用接口 [DescribeLifecycleHooks](https://cloud.tencent.com/document/api/377/34452) ，取返回信息中的 LifecycleHookId 获取生命周期挂钩ID。", "example": "ash-5rynk2n5" } ], "required": [ "LifecycleHookId" ] }, { "name": "DeleteNotificationConfiguration", "description": "本接口（DeleteNotificationConfiguration）用于删除特定的通知。", "status": "online", "parameters": [ { "name": "AutoScalingNotificationId", "type": "string", "required": false, "description": "待删除的通知ID，目前为必填参数。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeNotificationConfigurations](https://cloud.tencent.com/document/api/377/33183) ，取返回信息中的 AutoScalingNotificationId 获取通知ID。", "example": "asn-2sestqbr" } ], "required": [] }, { "name": "DeleteScalingPolicy", "description": "本接口（DeleteScalingPolicy）用于删除告警触发策略。", "status": "online", "parameters": [ { "name": "AutoScalingPolicyId", "type": "string", "required": true, "description": "待删除的告警策略ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeScalingPolicies](https://cloud.tencent.com/document/api/377/33178) ，取返回信息中的 AutoScalingPolicyId 获取告警策略ID。", "example": "asp-lnfqbsoq" } ], "required": [ "AutoScalingPolicyId" ] }, { "name": "DeleteScheduledAction", "description": "本接口（DeleteScheduledAction）用于删除特定的定时任务。", "status": "online", "parameters": [ { "name": "ScheduledActionId", "type": "string", "required": true, "description": "待删除的定时任务ID。可以通过调用接口 [DescribeScheduledActions](https://cloud.tencent.com/document/api/377/20450) ，取返回信息中的 ScheduledActionId 获取定时任务ID。", "example": "asst-chwbkq4c" } ], "required": [ "ScheduledActionId" ] }, { "name": "DescribeAccountLimits", "description": "本接口（DescribeAccountLimits）用于查询用户账户在弹性伸缩中的资源限制。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeAutoScalingActivities", "description": "本接口（DescribeAutoScalingActivities）用于查询伸缩组的伸缩活动记录。当前仅保存近两年的伸缩活动。", "status": "online", "parameters": [ { "name": "ActivityIds", "type": "array", "required": false, "description": "按照一个或者多个伸缩活动ID查询。伸缩活动ID形如：`asa-5l2ejpfo`。每次请求的上限为100。参数不支持同时指定`ActivityIds`和`Filters`。", "example": "[\"asa-i8d6y5r4\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。过滤字段取值范围如下： auto-scaling-group-id按照【伸缩组ID】进行过滤。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。类型：String必选：否示例值: asg-kiju7yt5activity-status-code按照【伸缩活动状态】进行过滤类型：String必选：否可选项: INI...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "ap-guangzhou-6", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" }, { "name": "StartTime", "type": "string", "required": false, "description": "伸缩活动最早的开始时间，如果指定了ActivityIds，此参数将被忽略。取值为`UTC`时间，按照`ISO8601`标准，格式：`YYYY-MM-DDThh:mm:ssZ`。注意：当前仅保存近两年的伸缩活动。", "example": "2024-11-11T15:29:59Z" }, { "name": "EndTime", "type": "string", "required": false, "description": "伸缩活动最晚的结束时间，如果指定了ActivityIds，此参数将被忽略。取值为`UTC`时间，按照`ISO8601`标准，格式：`YYYY-MM-DDThh:mm:ssZ`。", "example": "2024-11-11T15:29:59Z" } ], "required": [] }, { "name": "DescribeAutoScalingAdvices", "description": "此接口用于查询伸缩组配置建议。", "status": "online", "parameters": [ { "name": "AutoScalingGroupIds", "type": "array", "required": true, "description": "待查询的伸缩组列表，上限100。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "[\"asg-2pvrsyog\", \"asg-4wtj6aeq\"]", "item_type": "string" } ], "required": [ "AutoScalingGroupIds" ] }, { "name": "DescribeAutoScalingGroupLastActivities", "description": "本接口（DescribeAutoScalingGroupLastActivities）用于查询伸缩组的最新一次伸缩活动记录。", "status": "online", "parameters": [ { "name": "AutoScalingGroupIds", "type": "array", "required": true, "description": "伸缩组ID列表。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "[\"asg-2umy3jbd\"]", "item_type": "string" }, { "name": "ExcludeCancelledActivity", "type": "boolean", "required": false, "description": "查询时排除取消类型活动。默认值为 false，表示不排除取消类型活动。", "example": "false" } ], "required": [ "AutoScalingGroupIds" ] }, { "name": "DescribeAutoScalingGroups", "description": "本接口（DescribeAutoScalingGroups）用于查询伸缩组信息。 * 可以根据伸缩组ID、伸缩组名称或者启动配置ID等信息来查询伸缩组的详细信息。过滤信息详细请见过滤器`Filter`。 * 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的伸缩组。", "status": "online", "parameters": [ { "name": "AutoScalingGroupIds", "type": "array", "required": false, "description": "按照一个或者多个伸缩组ID查询。伸缩组ID形如：`asg-nkdwoui0`。每次请求的上限为100。参数不支持同时指定`AutoScalingGroupIds`和`Filters`。", "example": "[\"asg-nkdwoui0\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 auto-scaling-group-id - String - 是否必填：否 -（过滤条件）按照伸缩组ID过滤。 可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。 auto-scaling-group-name - String - 是否必填：否 -（过滤条件）按照伸缩组名称过滤。 vague-auto-scaling-group-name - String - \ufffd...", "example": "[{\"Name\": \"auto-scaling-group-name\", \"Values\": [\"production-as\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "ap-guangzhou-6", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" } ], "required": [] }, { "name": "DescribeAutoScalingInstances", "description": "本接口（DescribeAutoScalingInstances）用于查询弹性伸缩关联实例的信息。 * 可以根据实例ID、伸缩组ID等信息来查询实例的详细信息。过滤信息详细请见过滤器`Filter`。 * 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的实例。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": false, "description": "待查询云服务器（CVM）的实例ID列表，列表长度上限为100，不支持同时指定 InstanceIds 和 Filters。 可以通过以下方式获取可用的实例ID： 通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。 通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ，取返回信息中的 `InstanceId` 获取实例ID。", "example": "[\"ins-1fswxz1m\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 instance-id - String - 是否必填：否 -（过滤条件）按照实例ID过滤。可通过登录[控制台](https://console.cloud.tencent.com/cvm/index)或调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ，取返回信息中的 `InstanceId` 获取实例ID。 auto-scaling-group-id - String - 是否必填：否 -（过滤条件）按照伸缩组ID过滤。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用...", "example": "[{\"Name\": \"auto-scaling-group-id\", \"Values\": [\"asg-ewdpp04x\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "ap-guangzhou-6", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "20" } ], "required": [] }, { "name": "DescribeLaunchConfigurations", "description": "本接口（DescribeLaunchConfigurations）用于查询启动配置的信息。 * 可以根据启动配置ID、启动配置名称等信息来查询启动配置的详细信息。过滤信息详细请见过滤器`Filter`。 * 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的启动配置。", "status": "online", "parameters": [ { "name": "LaunchConfigurationIds", "type": "array", "required": false, "description": "按照一个或者多个启动配置ID查询。启动配置ID形如：`asc-ouy1ax38`。每次请求的上限为100。参数不支持同时指定`LaunchConfigurationIds`和`Filters`", "example": "[\"asc-fa28v4in\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 launch-configuration-id - String - 是否必填：否 -（过滤条件）按照启动配置ID过滤。 launch-configuration-name - String - 是否必填：否 -（过滤条件）按照启动配置名称过滤。 vague-launch-configuration-name - String - 是否必填：否 -（过滤条件）按照启动配置名称模糊搜索。 tag-key - String - 是否必填：否 -（过滤条件）按照标签键进行过滤。 tag-value - String - 是否必填：否 -（过滤条件）按\ufffd...", "example": "[{\"Name\": \"launch-configuration-name\", \"Values\": [\"DataEngine123\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "ap-guangzhou-6", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" } ], "required": [] }, { "name": "DescribeLifecycleHooks", "description": "本接口（DescribeLifecycleHooks）用于查询生命周期挂钩信息。 * 可以根据伸缩组ID、生命周期挂钩ID或者生命周期挂钩名称等信息来查询生命周期挂钩的详细信息。过滤信息详细请见过滤器`Filter`。 * 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的生命周期挂钩。", "status": "online", "parameters": [ { "name": "LifecycleHookIds", "type": "array", "required": false, "description": "按照一个或者多个生命周期挂钩ID查询。生命周期挂钩ID形如：`ash-8azjzxcl`。每次请求的上限为100。参数不支持同时指定`LifecycleHookIds`和`Filters`。", "example": "[\"ash-mzdlwrbt\"],", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 lifecycle-hook-id - String - 是否必填：否 -（过滤条件）按照生命周期挂钩ID过滤。 lifecycle-hook-name - String - 是否必填：否 -（过滤条件）按照生命周期挂钩名称过滤。 auto-scaling-group-id - String - 是否必填：否 -（过滤条件）按照伸缩组ID过滤。 每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`LifecycleHookIds `和`Filters`。", "example": "[{\"Name\": \"auto-scaling-group-id\", \"Values\": [\"asg-0xrkdurh\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "ap-guangzhou-6", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" } ], "required": [] }, { "name": "DescribeNotificationConfigurations", "description": "本接口 (DescribeNotificationConfigurations) 用于查询一个或多个通知的详细信息。 可以根据通知ID、伸缩组ID等信息来查询通知的详细信息。过滤信息详细请见过滤器`Filter`。 如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的通知。", "status": "online", "parameters": [ { "name": "AutoScalingNotificationIds", "type": "array", "required": false, "description": "按照一个或者多个通知ID查询，列表长度上限为100。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 获取通知ID。参数不支持同时指定`AutoScalingNotificationIds`和`Filters`。", "example": "[\"asn-9bhwvxqh\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 auto-scaling-notification-id - String - 是否必填：否 -（过滤条件）按照通知ID过滤。 auto-scaling-group-id - String - 是否必填：否 -（过滤条件）按照伸缩组ID过滤。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。 每次请求的`Filters`的上限为10，`Fil...", "example": "[{\"Name\": \"auto-scaling-group-id\", \"Values\": [\"asg-hyfg539t\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "ap-guangzhou-6", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" } ], "required": [] }, { "name": "DescribeRefreshActivities", "description": "本接口（DescribeRefreshActivities）用于查询伸缩组的实例刷新活动记录。", "status": "online", "parameters": [ { "name": "RefreshActivityIds", "type": "array", "required": false, "description": "刷新活动ID列表。ID形如：`asr-5l2ejpfo`。每次请求的上限为100。参数不支持同时指定`RefreshActivityIds`和`Filters`。", "example": "[\"asr-aaaabbbb\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 auto-scaling-group-id - String - 是否必填：否 -（过滤条件）按照伸缩组ID过滤。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。 refresh-activity-status-code - String - 是否必填：否 -（过滤条件）按照刷新活动状态过滤。（INIT：初始化中 | RUNNING：\ufffd...", "example": "[{\"Name\": \"auto-scaling-group-id\", \"Values\": [\"asg-ewdpp04x\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "ap-guangzhou-6", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" } ], "required": [] }, { "name": "DescribeScalingPolicies", "description": "本接口（DescribeScalingPolicies）用于查询告警触发策略。", "status": "online", "parameters": [ { "name": "AutoScalingPolicyIds", "type": "array", "required": false, "description": "按照一个或者多个告警策略ID查询。告警策略ID形如：asp-i9vkg894。每次请求的实例的上限为100。参数不支持同时指定`AutoScalingPolicyIds`和`Filters`。", "example": "[\"asp-5zffv598\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 auto-scaling-policy-id - String - 是否必填：否 -（过滤条件）按照告警策略ID过滤。 auto-scaling-group-id - String - 是否必填：否 -（过滤条件）按照伸缩组ID过滤。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。 scaling-policy-name - String - 是否必填\ufffd\ufffd...", "example": "[{\"Name\": \"auto-scaling-group-id\", \"Values\": [\"asg-ewdpp04x\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "ap-guangzhou-6", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" } ], "required": [] }, { "name": "DescribeScheduledActions", "description": "本接口 (DescribeScheduledActions) 用于查询一个或多个定时任务的详细信息。 * 可以根据定时任务ID、定时任务名称或者伸缩组ID等信息来查询定时任务的详细信息。过滤信息详细请见过滤器`Filter`。 * 如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的定时任务。", "status": "online", "parameters": [ { "name": "ScheduledActionIds", "type": "array", "required": false, "description": "按照一个或者多个定时任务ID查询。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 获取定时任务 ID。每次请求的实例的上限为100。参数不支持同时指定ScheduledActionIds和Filters。", "example": "[\"asst-caa5ha40\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 获取定时任务 ID，定时任务名称，伸缩组 ID。 scheduled-action-id - String - 是否必填：否 -（过滤条件）按照定时任务ID过滤。 scheduled-action-name - String - 是否必填：否 - （过滤条件） 按照定时任务名称过滤。 auto-scaling-group-id - String - 是否必填：否 - （过滤条件） 按照伸缩组ID过滤。", "example": "[{\"Name\": \"auto-scaling-group-name\", \"Values\": [\"production-as\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "ap-guangzhou-6", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "20" } ], "required": [] }, { "name": "DetachInstances", "description": "本接口（DetachInstances）用于从伸缩组移出 CVM 实例，本接口不会销毁实例。 * 如果移出指定实例后，伸缩组内处于`IN_SERVICE`状态的实例数量小于伸缩组最小值，接口将报错 * 如果伸缩组处于`DISABLED`状态，移出操作不校验`IN_SERVICE`实例数量和最小值的关系 * 对于伸缩组配置的 CLB，实例在离开伸缩组时，AS 会进行解挂载动作", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可以通过如下方式获取可用的伸缩组ID: 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-boz1qhnk" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "CVM实例ID列表。可以通过以下方式获取可用的实例ID： 通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。 通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ，取返回信息中的 `InstanceId` 获取实例ID。", "example": "[\"ins-cri8d02t\",\"ins-osckfnm7\"]", "item_type": "string" } ], "required": [ "AutoScalingGroupId", "InstanceIds" ] }, { "name": "DetachLoadBalancers", "description": "本接口（DetachLoadBalancers）用于从伸缩组移出负载均衡器，本接口不会销毁负载均衡器。", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-12wjuh0s" }, { "name": "LoadBalancerIds", "type": "array", "required": false, "description": "传统负载均衡器ID列表，列表长度上限为20，LoadBalancerIds 和 ForwardLoadBalancerIdentifications 二者同时最多只能指定一个。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "[\"lb-crhgatrf\"]", "item_type": "string" }, { "name": "ForwardLoadBalancerIdentifications", "type": "array", "required": false, "description": "负载均衡器标识信息列表，列表长度上限为100，LoadBalancerIds 和 ForwardLoadBalancerIdentifications二者同时最多只能指定一个。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "[{\"ListenerId\": \"lbl-mqnrswr0\", \"LoadBalancerId\": \"lb-k7cs98bu\", \"LocationId\": \"loc-ivbajssu\"}]", "item_type": "object", "children": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡器ID", "example": "lb-ceqnq5xk" }, { "name": "ListenerId", "type": "string", "required": true, "description": "应用型负载均衡监听器 ID", "example": "lbl-lqf523ih" }, { "name": "LocationId", "type": "string", "required": false, "description": "转发规则ID，注意：针对七层监听器此参数必填", "example": "loc-0xbavbfi" }, { "name": "PortList", "type": "array", "required": false, "description": "监听器或转发路径需解绑的端口号列表。取值范围：[1, 65535]不传递该参数时，默认解绑指定监听器或转发路径关联的所有端口。", "example": "[223]", "item_type": "integer" } ] } ], "required": [ "AutoScalingGroupId" ] }, { "name": "DisableAutoScalingGroup", "description": "本接口（DisableAutoScalingGroup）用于停用指定伸缩组。 * 停用伸缩组后，自动触发的伸缩活动不再进行，包括： - 告警策略触发的伸缩活动 - 匹配期望实例数的伸缩活动 - 不健康实例替换活动 - 定时任务 * 停用伸缩组后，手动触发的伸缩活动允许进行，包括： - 指定数量扩容实例（ScaleOutInstances） - 指定数量缩容实例（ScaleInInstances） - 从伸缩组中移出 CVM 实例（DetachInstances） - 从\ufffd...", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-nvnlpbb8" } ], "required": [ "AutoScalingGroupId" ] }, { "name": "EnableAutoScalingGroup", "description": "本接口（EnableAutoScalingGroup）用于启用指定伸缩组。", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-nvnlpbb8" } ], "required": [ "AutoScalingGroupId" ] }, { "name": "EnterStandby", "description": "伸缩组内实例进入备用中状态。 * 备用中状态实例的 CLB 权重值为 0，不会被自动缩容、不健康替换、实例刷新操作选中 * 调用弹性伸缩开关机接口会使得备用中状态发生变化，而云服务器开关机接口不会影响 * 实例进入备用中状态后，伸缩组会尝试下调期望实例数，新期望数不会小于最小值", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组 ID。可以通过如下方式获取可用的伸缩组ID: 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-boz1qhnk" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "运行中状态实例列表，不支持传入非运行中状态实例。可以通过以下方式获取可用的实例ID： 通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。 通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ，取返回信息中的 `InstanceId` 获取实例ID。", "example": "[\"ins-cri8d02t\",\"ins-osckfnm7\"]", "item_type": "string" } ], "required": [ "AutoScalingGroupId", "InstanceIds" ] }, { "name": "ExecuteScalingPolicy", "description": "本接口（ExecuteScalingPolicy）用于执行伸缩策略。 * 可以根据伸缩策略ID执行伸缩策略。 * 伸缩策略所属伸缩组处于伸缩活动时，会拒绝执行伸缩策略。 * 本接口不支持执行目标追踪策略。", "status": "online", "parameters": [ { "name": "AutoScalingPolicyId", "type": "string", "required": true, "description": "告警伸缩策略ID，不支持目标追踪策略。可通过 DescribeScalingPolicies 接口返回的 ScalingPolicyType 参数获取告警策略类型。", "example": "asp-f59pppuh" }, { "name": "HonorCooldown", "type": "boolean", "required": false, "description": "是否检查伸缩组活动处于冷却时间内，默认值为false", "example": "false" }, { "name": "TriggerSource", "type": "string", "required": false, "description": "执行伸缩策略的触发来源，取值包括 API 和 CLOUD_MONITOR，默认值为 API。CLOUD_MONITOR 专门供云监控触发调用。", "example": "API" } ], "required": [ "AutoScalingPolicyId" ] }, { "name": "ExitStandby", "description": "伸缩组内实例退出备用中状态。 * 退出备用中状态后，实例会进入运行中状态，CLB 权重值恢复为预设值 * 调用弹性伸缩开关机接口会使得备用中状态发生变化，而云服务器开关机接口不会影响 * 实例退出备用中状态后，伸缩组会上调期望实例数，新期望数不能大于最大值", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组 ID。可以通过如下方式获取可用的伸缩组ID: 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-boz1qhnk" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "备用中状态 CVM 实例列表。可以通过以下方式获取可用的实例ID： 通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。 通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ，取返回信息中的 `InstanceId` 获取实例ID。", "example": "[\"ins-cri8d02t\",\"ins-osckfnm7\"]", "item_type": "string" } ], "required": [ "AutoScalingGroupId", "InstanceIds" ] }, { "name": "ModifyAutoScalingGroup", "description": "本接口（ModifyAutoScalingGroup）用于修改伸缩组。", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可以通过如下方式获取可用的伸缩组ID:通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-gf5r6t7u" }, { "name": "AutoScalingGroupName", "type": "string", "required": false, "description": "伸缩组名称，在您账号中必须唯一。名称仅支持中文、英文、数字、下划线、分隔符\u0026quot;-\u0026quot;、小数点，最大长度不能超55个字节。", "example": "asgname" }, { "name": "DefaultCooldown", "type": "integer", "required": false, "description": "默认冷却时间，单位秒，取值范围 [0,3600]，默认值为300。", "example": "300" }, { "name": "DesiredCapacity", "type": "integer", "required": false, "description": "期望实例数，取值范围 [0,2000]。需满足最大值大于等于期望值，期望值大于等于最小值。", "example": "1" }, { "name": "LaunchConfigurationId", "type": "string", "required": false, "description": "启动配置ID。可以通过如下方式获取可用的启动配置ID:通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/config) 查询启动配置ID。通过调用接口 [DescribeLaunchConfigurations](https://cloud.tencent.com/document/api/377/20445) ，取返回信息中的 LaunchConfigurationId 获取启动配置ID。", "example": "asc-gf5r6t7u" }, { "name": "MaxSize", "type": "integer", "required": false, "description": "最大实例数，取值范围为 [0,2000]。需满足最大值大于等于期望值，期望值大于等于最小值。", "example": "1" }, { "name": "MinSize", "type": "integer", "required": false, "description": "最小实例数，取值范围为 [0,2000]。需满足最大值大于等于期望值，期望值大于等于最小值。", "example": "1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID。该参数可以通过调用 DescribeProject 的返回值中的 ProjectId 字段来获取。默认值为 0，表示使用默认项目。", "example": "1" }, { "name": "SubnetIds", "type": "array", "required": false, "description": "子网ID列表。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 DescribeSubnets ，从接口返回中的SubnetId字段获取。", "example": "[\"subnet-gf5r6t7u\"]", "item_type": "string" }, { "name": "TerminationPolicies", "type": "array", "required": false, "description": "销毁策略，目前长度上限为1。取值包括 OLDEST_INSTANCE 和 NEWEST_INSTANCE。 OLDEST_INSTANCE 优先销毁伸缩组中最旧的实例。 NEWEST_INSTANCE，优先销毁伸缩组中最新的实例。", "example": "[\"OLDEST_INSTANCE\"]", "item_type": "string" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络ID。修改私有网络时，需将 SubnetIds 参数同步修改为该私有网络的子网。有效的 VpcId 可通过登录控制台查询；也可以调用接口 DescribeVpc ，从接口返回中的 VpcId 字段获取。", "example": "vpc-gf5r6t7u" }, { "name": "Zones", "type": "array", "required": false, "description": "可用区列表", "example": "[\"ap-beijing-1\"]", "item_type": "string" }, { "name": "RetryPolicy", "type": "string", "required": false, "description": "重试策略，取值包括 IMMEDIATE_RETRY、 INCREMENTAL_INTERVALS、NO_RETRY，默认取值为 IMMEDIATE_RETRY。部分成功的伸缩活动判定为一次失败活动。IMMEDIATE_RETRY，立即重试，在较短时间内快速重试，连续失败超过一定次数（5次）后不再重试。INCREMENTAL_INTERVALS，间隔递增重试，随着连续失败次数的增加，重试间隔逐渐增大，重试间隔从秒级到1天不等。 NO_RETRY，不进行重试，直到再次收到用户调\ufffd...", "example": "IMMEDIATE_RETRY" }, { "name": "ZonesCheckPolicy", "type": "string", "required": false, "description": "可用区校验策略，取值包括 ALL 和 ANY，默认取值为ANY。在伸缩组实际变更资源相关字段时（启动配置、可用区、子网）发挥作用。 ALL，所有可用区（Zone）或子网（SubnetId）都可用则通过校验，否则校验报错。 ANY，存在任何一个可用区（Zone）或子网（SubnetId）可用则通过校验，否则校验报错。可用区或子网不可用的常见原因包括该可用区CVM实例类型售罄、该可用区CBS云盘售罄、...", "example": "ALL" }, { "name": "ServiceSettings", "type": "object", "required": false, "description": "服务设置，包括云监控不健康替换等服务设置。", "example": "无", "children": [ { "name": "ReplaceMonitorUnhealthy", "type": "boolean", "required": false, "description": "开启监控不健康替换服务。若开启则对于云监控标记为不健康的实例，弹性伸缩服务会进行替换。若不指定该参数，则默认为 False。", "example": "false" }, { "name": "ScalingMode", "type": "string", "required": false, "description": "取值范围： CLASSIC_SCALING：经典方式，使用创建、销毁实例来实现扩缩容； WAKE_UP_STOPPED_SCALING：扩容优先开机。扩容时优先对已关机的实例执行开机操作，若开机后实例数仍低于期望实例数，则创建实例，缩容仍采用销毁实例的方式。用户可以使用StopAutoScalingInstances接口来关闭伸缩组内的实例。监控告警触发的扩容仍将创建实例 默认取值：CLASSIC_SCALING", "example": "CLASSIC_SCALING" }, { "name": "ReplaceLoadBalancerUnhealthy", "type": "boolean", "required": false, "description": "开启负载均衡不健康替换服务。若开启则对于负载均衡健康检查判断不健康的实例，弹性伸缩服务会进行替换。若不指定该参数，则默认为 False。", "example": "false" }, { "name": "ReplaceMode", "type": "string", "required": false, "description": "不健康替换服务的替换模式。取值范围： RECREATE：重建实例替代原有不健康实例； RESET：对原有不健康实例进行重装系统操作，可保持数据盘、内网IP、实例id等信息不发生变化，实例登录设置、主机名、增强服务和 UserData 与当前启动配置保持一致。 默认取值：RECREATE", "example": "RECREATE" }, { "name": "AutoUpdateInstanceTags", "type": "boolean", "required": false, "description": "自动更新实例标签。默认取值为 False，配置后如伸缩组标签发生更新，会同步更新（同步更新仅支持新增、修改标签，暂不支持删除标签）伸缩组内运行中状态实例的标签，同步更新非立即生效，存在一定延迟。", "example": "false" }, { "name": "DesiredCapacitySyncWithMaxMinSize", "type": "boolean", "required": false, "description": "期望实例数同步最大最小值。默认值为 False。该参数仅对修改伸缩组接口未传入期望数的场景生效。 True: 修改最大值或最小值时，如与当前期望数存在冲突，则同步调整期望数。例如修改时传入最小值 2，当前期望数为 1，则同步调整期望数为 2。 False: 修改最大值或最小值时，如与当前期望数存在冲突，报错提示不允许修改。", "example": "false" }, { "name": "PriorityScaleInUnhealthy", "type": "boolean", "required": false, "description": "优先缩容不健康实例。若开启，缩容时会优先选择不健康实例。默认值为 False。", "example": "false" } ] }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "实例具有IPv6地址数量的配置，取值包括0、1。默认值为 0，表示实例不分配 IPv6 地址。需使用支持 IPv6 的私有网络，需在子网中开启 IPv6 CIDR，其他使用限制可参考 IPv6使用限制。", "example": "1" }, { "name": "MultiZoneSubnetPolicy", "type": "string", "required": false, "description": "多可用区/子网策略，取值包括 PRIORITY 和 EQUALITY，默认为 PRIORITY。 PRIORITY，按照可用区/子网列表的顺序，作为优先级来尝试创建实例，如果优先级最高的可用区/子网可以创建成功，则总在该可用区/子网创建。 EQUALITY：扩容出的实例会打散到多个可用区/子网，保证扩容后的各个可用区/子网实例数相对均衡。 与本策略相关的注意点： 当伸缩组为基础网络时，本策略适用于多可\ufffd\ufffd...", "example": "PRIORITY" }, { "name": "HealthCheckType", "type": "string", "required": false, "description": "伸缩组实例健康检查类型，取值如下：CVM：根据实例网络状态判断实例是否处于不健康状态，不健康的网络状态即发生实例 PING 不可达事件，详细判断标准可参考[实例健康检查](https://cloud.tencent.com/document/product/377/8553)CLB：根据 CLB 的健康检查状态判断实例是否处于不健康状态，CLB健康检查原理可参考[健康检查](https://cloud.tencent.com/document/product/214/6097)", "example": "CLB" }, { "name": "LoadBalancerHealthCheckGracePeriod", "type": "integer", "required": false, "description": "CLB健康检查宽限期，单位为秒。取值范围：[0, 7200]默认值：0", "example": "0" }, { "name": "InstanceAllocationPolicy", "type": "string", "required": false, "description": "实例分配策略，取值包括 LAUNCH_CONFIGURATION 和 SPOT_MIXED。 LAUNCH_CONFIGURATION，代表传统的按照启动配置模式。 SPOT_MIXED，代表竞价混合模式。目前仅支持启动配置为按量计费模式时使用混合模式，混合模式下，伸缩组将根据设定扩容按量或竞价机型。使用混合模式时，关联的启动配置的计费类型不可被修改。", "example": "LAUNCH_CONFIGURATION" }, { "name": "SpotMixedAllocationPolicy", "type": "object", "required": false, "description": "竞价混合模式下，各计费类型实例的分配策略。仅当 InstanceAllocationPolicy 取 SPOT_MIXED 时可用。", "example": "无", "children": [ { "name": "BaseCapacity", "type": "integer", "required": false, "description": "混合模式下，基础容量的大小，基础容量部分固定为按量计费实例。默认值 0，最大不可超过伸缩组的最大实例数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "OnDemandPercentageAboveBaseCapacity", "type": "integer", "required": false, "description": "超出基础容量部分，按量计费实例所占的比例。取值范围 [0, 100]，0 代表超出基础容量的部分仅生产竞价实例，100 代表仅生产按量实例，默认值为 70。按百分比计算按量实例数时，向上取整。 比如，总期望实例数取 3，基础容量取 1，超基础部分按量百分比取 1，则最终按量 2 台（1 台来自基础容量，1 台按百分比向上取整得到），竞价 1台。 注意：此字段可能返回 null，表示取\ufffd...", "example": "0" }, { "name": "SpotAllocationStrategy", "type": "string", "required": false, "description": "混合模式下，竞价实例的分配策略。取值包括 COST_OPTIMIZED 和 CAPACITY_OPTIMIZED，默认取 COST_OPTIMIZED。 COST_OPTIMIZED，成本优化策略。对于启动配置内的所有机型，按照各机型在各可用区的每核单价由小到大依次尝试。优先尝试购买每核单价最便宜的，如果购买失败则尝试购买次便宜的，以此类推。 CAPACITY_OPTIMIZED，容量优化策略。对于启动配置内的所有机型，按照各机型在各可用区\ufffd\ufffd...", "example": "COST_OPTIMIZED" }, { "name": "CompensateWithBaseInstance", "type": "boolean", "required": false, "description": "按量实例替补功能。取值范围： TRUE，开启该功能，当所有竞价机型因库存不足等原因全部购买失败后，尝试购买按量实例。 FALSE，不开启该功能，伸缩组在需要扩容竞价实例时仅尝试所配置的竞价机型。 默认取值： TRUE。 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "CapacityRebalance", "type": "boolean", "required": false, "description": "容量重平衡功能，仅对伸缩组内的竞价实例有效。取值范围： TRUE，开启该功能，当伸缩组内的竞价实例即将被竞价实例服务自动回收前，AS 主动发起竞价实例销毁流程，如果有配置过缩容 hook，则销毁前 hook 会生效。销毁流程启动后，AS 会异步开启一个扩容活动，用于补齐期望实例数。 FALSE，不开启该功能，则 AS 等待竞价实例被销毁后才会去扩容补齐伸缩组期望实例数。", "example": "false" }, { "name": "InstanceNameIndexSettings", "type": "object", "required": false, "description": "实例名称序号相关设置。开启后为伸缩组内自动创建的实例名称添加递增的数字序号。", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启实例创建序号，默认不开启。取值范围：TRUE：表示开启实例创建序号; FALSE：表示不开启实例创建序号 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "BeginIndex", "type": "integer", "required": false, "description": "初始序号。取值范围与 IndexLength 参数有关：- IndexLength 为 0 时，取值范围为 [0, 99999999]。- IndexLength 为 [1, 8] 时，取值范围为 [0, 10^IndexLength-1]，最大值即为指定位数的最大数字。初始序号默认值如下：- 首次启用递增序号：初始序号默认值为 0 （ 展示位数与 IndexLength 有关，例如 IndexLength 为 4，展示值为 0000）- 非首次开启递增序号：顺延之前的递增序号，例如上次使用递增至序\ufffd\ufffd...", "example": "0" }, { "name": "IndexLength", "type": "integer", "required": false, "description": "递增序号长度，默认为0，表示不指定序号长度。 取值范围：0-8，最大为整数8。 - 长度设置为3，序号展示形式为：000、001、002 ... 010、011 ... 100 ... 999，序号上限为999- 长度设置为0，序号展示形式为：0、1、2 ... 10、11 ... 100 ... 1000 ...10000 ... 99999999，序号上限为99999999注意：递增序号持续超出上限会导致扩容失败，请不要设置过小的递增序号长度。", "example": "0" } ] }, { "name": "HostNameIndexSettings", "type": "object", "required": false, "description": "实例主机名序号相关设置。开启后为伸缩组内自动创建的实例主机名添加递增的数字序号。", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启实例主机名创建序号，默认不开启。取值范围：TRUE：表示开启实例主机名创建序号FALSE：表示不开启实例主机名创建序号", "example": "false" }, { "name": "BeginIndex", "type": "integer", "required": false, "description": "初始序号。取值范围与 IndexLength 参数有关：- IndexLength 为 0 时，取值范围为 [0, 99999999]。- IndexLength 为 [1, 8] 时，取值范围为 [0, 10^IndexLength-1]，最大值即为指定位数的最大数字。初始序号默认值如下：- 首次启用递增序号：初始序号默认值为 0 （ 展示位数与 IndexLength 有关，例如 IndexLength 为 4，展示值为 0000）- 非首次开启递增序号：顺延之前的递增序号，例如上次使用递增至序\ufffd\ufffd...", "example": "0" }, { "name": "IndexLength", "type": "integer", "required": false, "description": "递增序号长度，默认为0，表示不指定序号长度。 取值范围：0-8，最大为整数8。 - 长度设置为3，序号展示形式为：000、001、002 ... 010、011 ... 100 ... 999，序号上限为999- 长度设置为0，序号展示形式为：0、1、2 ... 10、11 ... 100 ... 1000 ...10000 ... 99999999，序号上限为99999999注意：递增序号持续超出上限会导致扩容失败，请不要设置过小的递增序号长度。", "example": "0" } ] }, { "name": "ConcurrentScaleOutForDesiredCapacity", "type": "boolean", "required": false, "description": "匹配期望数并发扩容功能，不能在InstanceAllocationPolicy为竞价混合模式时设置，也不能在ScalingMode为扩容优先开机模式时设置。目前仅支持两个匹配期望数扩容活动并发进行，不支持指定数量扩容、缩容等其他类型活动并发。设置为FALSE表示不开启。", "example": "false" } ], "required": [ "AutoScalingGroupId" ] }, { "name": "ModifyDesiredCapacity", "description": "本接口（ModifyDesiredCapacity）用于修改指定伸缩组的期望实例数", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-nvnlpbb8" }, { "name": "DesiredCapacity", "type": "integer", "required": true, "description": "期望实例数，取值范围 [0,2000]，同时需满足 MaxSize \u003e= DesiredCapacity \u003e= MinSize 。", "example": "2" }, { "name": "MinSize", "type": "integer", "required": false, "description": "最小实例数，取值范围为 [0,2000]，同时需满足 MaxSize \u003e= DesiredCapacity \u003e= MinSize 。", "example": "0" }, { "name": "MaxSize", "type": "integer", "required": false, "description": "最大实例数，取值范围为 [0,2000]，同时需满足 MaxSize \u003e= DesiredCapacity \u003e= MinSize 。", "example": "20" } ], "required": [ "AutoScalingGroupId", "DesiredCapacity" ] }, { "name": "ModifyLaunchConfigurationAttributes", "description": "本接口（ModifyLaunchConfigurationAttributes）用于修改启动配置部分属性。 * 修改启动配置后，已经使用该启动配置扩容的存量实例不会发生变更，此后使用该启动配置的新增实例会按照新的配置进行扩容。", "status": "online", "parameters": [ { "name": "LaunchConfigurationId", "type": "string", "required": true, "description": "启动配置ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/config) 或调用接口 [DescribeLaunchConfigurations](https://cloud.tencent.com/document/api/377/20445) ，取返回信息中的 LaunchConfigurationId 获取启动配置ID。", "example": "asc-aaaabbbb" }, { "name": "ImageId", "type": "string", "required": false, "description": "指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID，格式形如`img-8toqc6s3`。镜像类型分为四种：公共镜像自定义镜像共享镜像服务市场镜像可通过以下方式获取可用的镜像ID：`公共镜像`、`自定义镜像`、`共享镜像`的镜像ID可通过登录[控制台](https://console.cloud.tencent.com/cvm/image?rid=1\u0026imageType=PUBLIC_IMAGE)查询；`服务镜像市场`的镜像ID可通过[云市场](https://market.cloud.tencent.com/lis...", "example": "img-8toqc6s3" }, { "name": "InstanceTypes", "type": "array", "required": false, "description": "实例类型列表，不同实例机型指定了不同的资源规格，最多支持10种实例机型。 InstanceType 指定单一实例类型，通过设置 InstanceTypes可以指定多实例类型，并使原有的InstanceType失效。具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格描述](https://cloud.tencent.com/document/product/213/11518)。", "example": "[\"S5.SMALL2\"]", "item_type": "string" }, { "name": "InstanceTypesCheckPolicy", "type": "string", "required": false, "description": "实例类型校验策略，在实际修改 InstanceTypes 时发挥作用，取值包括 ALL 和 ANY，默认取值为ANY。 ALL，所有实例类型（InstanceType）都可用则通过校验，否则校验报错。 ANY，存在任何一个实例类型（InstanceType）可用则通过校验，否则校验报错。 实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。 如果 InstanceTypes 中一款机型不存在或者已下线，则无论 InstanceTypesCheckPol...", "example": "ALL" }, { "name": "LaunchConfigurationName", "type": "string", "required": false, "description": "启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符\"-\"、小数点，最大长度不能超60个字节。", "example": "myascname" }, { "name": "UserData", "type": "string", "required": false, "description": "经过 Base64 编码后的自定义数据，最大长度不超过16KB。如果要清空UserData，则指定其为空字符串。", "example": "IyEvYmluL2Jhc2gKZWNobyAxMjMKCg==" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的`SecurityGroupId`字段来获取。 若指定该参数，请至少提供一个安全组，列表顺序有先后。", "example": "[\"sg-aaaabbbb\"]", "item_type": "string" }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置。 当公网出带宽上限为0Mbps时，不支持修改为开通分配公网IP；相应的，当前为开通分配公网IP时，修改的公网出带宽上限值必须大于0Mbps。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型。取值范围：BANDWIDTH_PREPAID：预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费BANDWIDTH_PACKAGE：带宽包用户默认取值：TRAFFIC_POSTPAID_BY_HOUR。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/509)。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "PublicIpAssigned", "type": "boolean", "required": false, "description": "是否分配公网IP。取值范围：TRUE：表示分配公网IPFALSE：表示不分配公网IP当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID。可通过[DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bwp-dss86yt5" }, { "name": "InternetServiceProvider", "type": "string", "required": false, "description": "线路类型。各种线路类型及支持地区详情可参考：[EIP 的 IP 地址类型](https://cloud.tencent.com/document/product/1199/41646)。默认值：BGP。 BGP：常规 BGP 线路 已开通静态单线IP白名单的用户，可选值： CMCC：中国移动 CTCC：中国电信 CUCC：中国联通 注意：仅部分地域支持静态单线IP。", "example": "BGP" }, { "name": "IPv4AddressType", "type": "string", "required": false, "description": "公网 IP 类型。 WanIP：普通公网IP。 HighQualityEIP：精品 IP。仅新加坡和中国香港支持精品IP。 AntiDDoSEIP：高防 IP。仅部分地域支持高防IP，详情可见[弹性公网IP产品概述](https://cloud.tencent.com/document/product/1199/41646) 。 如需为资源分配弹性公网IPv4地址，请指定弹性公网IPv4地址类型。如只使用WanIP，不需要设置此字段。 精品IP 高防IP功能仅部分地区灰度开放，如需使用[请提交工单咨询]...", "example": "WanIP" }, { "name": "AntiDDoSPackageId", "type": "string", "required": false, "description": "高防包唯一ID，申请高防IP时，该字段必传。", "example": "bgp-00000000" }, { "name": "IsKeepEIP", "type": "boolean", "required": false, "description": "实例销毁时是否一并销毁绑定的弹性IP。 取值范围： TRUE：表示保留EIP FALSE：表示不保留 请注意，当IPv4AddressType字段指定EIP类型时，默认不保留EIP。WanIP不受此字段影响始终随实例销毁。 变更配置此字段，已绑定伸缩组会立刻生效。", "example": "false" } ] }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "实例计费类型。具体取值范围如下： POSTPAID_BY_HOUR：按小时后付费 SPOTPAID：竞价付费 PREPAID：预付费，即包年包月 CDCPAID：专用集群付费", "example": "POSTPAID_BY_HOUR" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。 若修改实例的付费模式为预付费，则该参数必传；从预付费修改为其他付费模式时，本字段原信息会自动丢弃。 当新增该字段时，必须传递购买实例的时长，其它未传递字段会设置为默认值。 当修改本字段时，当前付费模式必须为预付费。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "NOTIFY_AND_MANUAL_RENEW" } ] }, { "name": "InstanceMarketOptions", "type": "object", "required": false, "description": "实例的市场相关选项，如竞价实例相关参数。 若修改实例的付费模式为竞价付费，则该参数必传；从竞价付费修改为其他付费模式时，本字段原信息会自动丢弃。 当新增该字段时，必须传递竞价相关选项下的竞价出价，其它未传递字段会设置为默认值。 当修改本字段时，当前付费模式必须为竞价付费。", "example": "无", "children": [ { "name": "SpotOptions", "type": "object", "required": true, "description": "竞价相关选项", "example": "{\"SpotInstanceType\": \"one-time\", \"MaxPrice\": 1000}", "children": [ { "name": "MaxPrice", "type": "string", "required": true, "description": "竞价出价，例如“1.05”", "example": "1.05" }, { "name": "SpotInstanceType", "type": "string", "required": false, "description": "竞价请求类型，当前仅支持类型：one-time，默认值为one-time", "example": "one-time" } ] }, { "name": "MarketType", "type": "string", "required": false, "description": "市场选项类型，当前只支持取值：spot", "example": "spot" } ] }, { "name": "DiskTypePolicy", "type": "string", "required": false, "description": "云盘类型选择策略，取值范围： ORIGINAL：使用设置的云盘类型。 AUTOMATIC：自动选择当前可用的云盘类型。", "example": "ORIGINAL" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "实例系统盘配置信息。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见[云硬盘类型](https://cloud.tencent.com/document/product/362/2353)。取值范围 LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_BSSD：通用型SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 默认取值：CLOUD_PREMIUM。", "example": "CLOUD_PREMIUM" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GB。默认值为 50", "example": "50" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "实例数据盘配置信息。 最多支持指定11块数据盘。采取整体修改，因此请提供修改后的全部值。 数据盘类型默认与系统盘类型保持一致。", "example": "无", "item_type": "object", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[云硬盘类型](https://cloud.tencent.com/document/product/362/2353)。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 CLOUD_BSSD：通用型SSD云硬盘 默认取值与系统盘类型（SystemDisk.DiskType）保持一致。", "example": "CLOUD_PREMIUM" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "数据盘大小，单位：GB。不同数据盘类型取值范围不同，具体限制详见：[CVM实例配置](https://cloud.tencent.com/document/product/213/2177)。默认值为0，表示不购买数据盘。更多限制详见[产品文档](https://cloud.tencent.com/document/product/362/5145)。", "example": "0" }, { "name": "SnapshotId", "type": "string", "required": false, "description": "数据盘快照 ID，可通过 [DescribeSnapshots](https://cloud.tencent.com/document/product/362/15647) 接口获取该参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "snap-l8psqwnt" }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "数据盘是否随子机销毁。取值范围： TRUE：子机销毁时，销毁数据盘，只支持按小时后付费云盘 FALSE：子机销毁时，保留数据盘 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "Encrypt", "type": "boolean", "required": false, "description": "数据盘是否加密。取值范围： TRUE：加密 FALSE：不加密 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "ThroughputPerformance", "type": "integer", "required": false, "description": "云硬盘性能，单位：MB/s。使用此参数可给云硬盘购买额外的性能，功能介绍和类型限制详见：[增强型 SSD 云硬盘额外性能说明](https://cloud.tencent.com/document/product/362/51896#.E5.A2.9E.E5.BC.BA.E5.9E.8B-ssd-.E4.BA.91.E7.A1.AC.E7.9B.98.E9.A2.9D.E5.A4.96.E6.80.A7.E8.83.BD)。 当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD）且 需容量 \u003e 460GB。 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "BurstPerformance", "type": "boolean", "required": false, "description": "突发性能。是否开启突发性能，默认取值为 false。当前该参数仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD）且需容量 \u003e 460GB。 注：内测中，需提单申请后使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "HostNameSettings", "type": "object", "required": false, "description": "云服务器主机名（HostName）的相关设置。 不支持windows实例设置主机名。 新增该属性时，必须传递云服务器的主机名，其它未传递字段会设置为默认值。 会校验主机名(如果存在后缀则加上后缀)是否超过最大位数46。", "example": "无", "children": [ { "name": "HostName", "type": "string", "required": true, "description": "云服务器的主机名。 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。 不支持 Windows 实例。 其他类型（Linux 等）实例：字符长度为[2, 42]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。不允许为纯数字。 注意：此字段可能返回 null，表示取不到有效值。", "example": "product-as-host-0" }, { "name": "HostNameStyle", "type": "string", "required": false, "description": "云服务器主机名的风格，取值范围包括 ORIGINAL 和 UNIQUE，默认为 ORIGINAL。 ORIGINAL，AS 直接将入参中所填的 HostName 传递给 CVM，CVM 可能会对 HostName 追加序列号，伸缩组中实例的 HostName 会出现冲突的情况。 UNIQUE，入参所填的 HostName 相当于主机名前缀，AS 和 CVM 会对其进行拓展，伸缩组中实例的 HostName 可以保证唯一。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ORIGINAL" }, { "name": "HostNameSuffix", "type": "string", "required": false, "description": "云服务器的主机名后缀。 点号（.）和短横线（-）不能作为 HostNameSuffix 的尾字符，不能连续使用。 不支持 Windows 实例。 其他类型（Linux 等）实例：字符长度为[1, 39]，且与 HostName 的长度和不能超过 41，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。 注意：此字段可能返回 null，表示取不到有效值。", "example": "suffix" }, { "name": "HostNameDelimiter", "type": "string", "required": false, "description": "云服务器的主机名分隔符。默认的分隔符是点号（.），可选短横线（-）或空字符串。 分隔符用于拼接主机名，递增序号，后缀。假设主机名为 testGpu4090 ，递增序号为 0007，后缀为 server： - 分隔符为英文点号（.），最终拼接为 testGpu4090.007.server - 分隔符为短横线（-），最终拼接为 testGpu4090-007-server - 分隔符为空字符串，最终拼接为 testGpu4090007server", "example": "." } ] }, { "name": "InstanceNameSettings", "type": "object", "required": false, "description": "云服务器（InstanceName）实例名的相关设置。 如果用户在启动配置中设置此字段，则伸缩组创建出的实例 InstanceName 参照此字段进行设置，并传递给 CVM；如果用户未在启动配置中设置此字段，则伸缩组创建出的实例 InstanceName 按照“as-{{ 伸缩组AutoScalingGroupName }}”进行设置，并传递给 CVM。 新增该属性时，必须传递云服务器的实例名称，其它未传递字段会设置为默认值。 会校验实...", "example": "无", "children": [ { "name": "InstanceName", "type": "string", "required": true, "description": "云服务器的实例名。字符长度为[2, 108]。", "example": "product-as-ins-0" }, { "name": "InstanceNameStyle", "type": "string", "required": false, "description": "云服务器实例名的风格，取值范围包括 ORIGINAL 和 UNIQUE，默认为 ORIGINAL。 ORIGINAL，AS 直接将入参中所填的 InstanceName 传递给 CVM，CVM 可能会对 InstanceName 追加序列号，伸缩组中实例的 InstanceName 会出现冲突的情况。 UNIQUE，入参所填的 InstanceName 相当于实例名前缀，AS 和 CVM 会对其进行拓展，伸缩组中实例的 InstanceName 可以保证唯一。", "example": "ORIGINAL" }, { "name": "InstanceNameSuffix", "type": "string", "required": false, "description": "云服务器实例名后缀。字符长度为[1,105]，且与 InstanceName 的长度和不能超过107。 注意：此字段可能返回 null，表示取不到有效值。", "example": "testsuffix" }, { "name": "InstanceNameDelimiter", "type": "string", "required": false, "description": "云服务器的实例名分隔符。默认的分隔符是点号（.），可选短横线（-）或空字符串。 分隔符用于拼接实例名，递增序号，后缀。假设实例名为 testGpu4090 ，递增序号为 0007，后缀为 server： - 分隔符为英文点号（.），最终拼接为 testGpu4090.007.server - 分隔符为短横线（-），最终拼接为 testGpu4090-007-server - 分隔符为空字符串，最终拼接为 testGpu4090007server", "example": "." } ] }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务。通过该参数可以指定是否开启云安全、云监控等服务。", "example": "无", "children": [ { "name": "SecurityService", "type": "object", "required": false, "description": "开启云安全服务。若不指定该参数，则默认开启云安全服务。", "example": "{\"Enabled\": True}", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云安全](https://cloud.tencent.com/document/product/296)服务。取值范围： TRUE：表示开启云安全服务 FALSE：表示不开启云安全服务 默认取值：TRUE。", "example": "{\"Enabled\": true}" } ] }, { "name": "MonitorService", "type": "object", "required": false, "description": "开启云监控服务。若不指定该参数，则默认开启云监控服务。", "example": "{\"Enabled\": True}", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[可观测平台（原名云监控）](https://cloud.tencent.com/document/product/248)服务。取值范围： TRUE：表示开启云监控服务 FALSE：表示不开启云监控服务 默认取值：TRUE。", "example": "{\"Enabled\": true}" } ] }, { "name": "AutomationToolsService", "type": "object", "required": false, "description": "开启自动化助手服务。若不指定该参数，则默认逻辑与CVM保持一致。注意：此字段可能返回 null，表示取不到有效值。", "example": "{\"Enabled\": True}", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[自动化助手](https://cloud.tencent.com/document/product/1340)服务。取值范围：TRUE：表示开启自动化助手服务FALSE：表示不开启自动化助手服务 注意：此字段可能返回 null，表示取不到有效值。", "example": "True" } ] } ] }, { "name": "CamRoleName", "type": "string", "required": false, "description": "CAM角色名称。可通过[DescribeRoleList](https://cloud.tencent.com/document/product/598/36223)接口返回值中的roleName获取。", "example": "TestRole" }, { "name": "HpcClusterId", "type": "string", "required": false, "description": "高性能计算集群ID。可通过调用[DescribeHpcClusters](https://cloud.tencent.com/document/product/213/83220)接口获取该参数。 注意：此字段默认为空。", "example": "hpc-acbd1324" }, { "name": "IPv6InternetAccessible", "type": "object", "required": false, "description": "IPv6公网带宽相关信息设置。若新建实例包含IPv6地址，该参数可为新建实例的IPv6地址分配公网带宽。关联启动配置的伸缩组Ipv6AddressCount参数为0时，该参数不会生效。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费模式。取值包括TRAFFIC_POSTPAID_BY_HOUR、BANDWIDTH_PACKAGE，默认取值为TRAFFIC_POSTPAID_BY_HOUR。查看当前账户类型可参考[账户类型说明](https://cloud.tencent.com/document/product/1199/49090#judge)。 IPv6对标准账户类型支持TRAFFIC_POSTPAID_BY_HOUR。 IPv6对传统账户类型支持BANDWIDTH_PACKAGE。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0，此时不为IPv6分配公网带宽。不同机型、可用区、计费模式的带宽上限范围不一致，具体限制详见[公网带宽上限](https://cloud.tencent.com/document/product/213/12523)。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID。可通过[DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bwp-jfio9i0p" } ] }, { "name": "DisasterRecoverGroupIds", "type": "array", "required": false, "description": "置放群组id，仅支持指定一个。可通过调用[DescribeDisasterRecoverGroups](https://cloud.tencent.com/document/product/213/17810)接口获取该参数。", "example": "[\"ps-fy7e0ml0\"]", "item_type": "string" }, { "name": "LoginSettings", "type": "object", "required": false, "description": "实例登录设置，包括密码、密钥或保持镜像的原始登录设置。请注意，指定新的登录设置会覆盖原有登录设置。例如，如果您之前使用密码登录，使用该参数将登录设置修改为密钥，则原有密码被清除。", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下： - Linux实例密码必须8到30位，至少包括四项（小写字母、大写字母、数字和特殊符号）中的两项。 - Windows实例密码必须12到30位，至少包括包括四项（小写字母、大写字母、数字和特殊符号）中的三项。 - 若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到用户。 特殊符号的取值范围： [( ) ` ~...", "example": "passExam@!7862543" }, { "name": "KeyIds", "type": "array", "required": false, "description": "密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。", "example": "[\"skey-ju7fy6t5\"]", "item_type": "string" }, { "name": "KeepImageLogin", "type": "boolean", "required": false, "description": "保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围： TRUE：表示保持镜像的登录设置 FALSE：表示不保持镜像的登录设置默认取值：FALSE。", "example": "false" } ] }, { "name": "InstanceTags", "type": "array", "required": false, "description": "实例标签列表。通过指定该参数，可以为扩容的实例绑定标签。最多支持指定10个标签。 该参数会覆盖原有的实例标签列表，如需新增标签，需将新标签和原有标签一并传入。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "as-tag-key-app0" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "as-tag-value-app0" } ] }, { "name": "ImageFamily", "type": "string", "required": false, "description": "镜像族名称。可通过调用[DescribeImages](https://cloud.tencent.com/document/product/213/15715)接口获取该参数。", "example": "test-family" }, { "name": "DedicatedClusterId", "type": "string", "required": false, "description": "本地专用集群ID。", "example": "cluster-gbo27yc4" }, { "name": "Metadata", "type": "object", "required": false, "description": "自定义metadata。", "example": "无", "children": [ { "name": "Items", "type": "array", "required": false, "description": "自定义 Metadata 键值对列表", "example": "[{\"Key\": \"Key123_4-5\", \"Value\": \"valueExam\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "自定义 MetaData 键", "example": "keyA-123_4" }, { "name": "Value", "type": "string", "required": true, "description": "自定义 MetaData 值", "example": "Value123" } ] } ] } ], "required": [ "LaunchConfigurationId" ] }, { "name": "ModifyLifecycleHook", "description": "此接口用于修改生命周期挂钩。", "status": "online", "parameters": [ { "name": "LifecycleHookId", "type": "string", "required": true, "description": "生命周期挂钩ID。可以通过调用接口 [DescribeLifecycleHooks](https://cloud.tencent.com/document/api/377/34452) ，取返回信息中的 LifecycleHookId 获取生命周期挂钩ID。", "example": "ash-je1esoo9" }, { "name": "LifecycleHookName", "type": "string", "required": false, "description": "生命周期挂钩名称。名称仅支持中文、英文、数字、下划线（_）、短横线（-）、小数点（.），最大长度不能超128。", "example": "hook-test" }, { "name": "LifecycleTransition", "type": "string", "required": false, "description": "进入生命周期挂钩场景，取值范围如下: * INSTANCE_LAUNCHING: 扩容生命周期挂钩 * INSTANCE_TERMINATING: 缩容生命周期挂钩", "example": "INSTANCE_LAUNCHING" }, { "name": "DefaultResult", "type": "string", "required": false, "description": "定义伸缩组在生命周期挂钩超时或 LifecycleCommand 执行失败时应采取的操作，取值范围如下： * CONTINUE: 默认值，表示继续执行扩缩容活动 * ABANDON: 针对扩容挂钩，挂钩超时或 LifecycleCommand 执行失败的 CVM 实例会直接释放或移出；而针对缩容挂钩，会继续执行缩容活动。", "example": "CONTINUE" }, { "name": "HeartbeatTimeout", "type": "integer", "required": false, "description": "生命周期挂钩超时之前可以经过的最长时间（以秒为单位），范围从 30 到 7200 秒。", "example": "30" }, { "name": "NotificationMetadata", "type": "string", "required": false, "description": "弹性伸缩向通知目标发送的附加信息。NotificationMetadata 与 LifecycleCommand互斥，二者不可同时指定。", "example": "addtional-info" }, { "name": "LifecycleTransitionType", "type": "string", "required": false, "description": "进行生命周期挂钩的场景类型，取值范围包括`NORMAL`和 `EXTENSION`。说明：设置为`EXTENSION`值，在AttachInstances、DetachInstances、RemoveInstances 接口时会触发生命周期挂钩操作，值为`NORMAL`则不会在这些接口中触发生命周期挂钩。", "example": "NORMAL" }, { "name": "NotificationTarget", "type": "object", "required": false, "description": "通知目标信息。NotificationTarget 与 LifecycleCommand互斥，二者不可同时指定。", "example": "{\"QueueName\": \"as-pool\", \"TargetType\": \"TDMQ_CMQ_QUEUE\"}", "children": [ { "name": "TargetType", "type": "string", "required": true, "description": "目标类型，取值范围包括`CMQ_QUEUE`、`CMQ_TOPIC`、`TDMQ_CMQ_QUEUE`、`TDMQ_CMQ_TOPIC`。 CMQ_QUEUE，指腾讯云消息队列-队列模型，对应产品已下线，[建议切换](https://cloud.tencent.com/document/product/1496/83970) TDMQ_CMQ_QUEUE 使用。 CMQ_TOPIC，指腾讯云消息队列-主题模型，对应产品已下线，[建议切换](https://cloud.tencent.com/document/product/1496/83970) TDMQ_CMQ_TOPIC 使用。 TDMQ_CMQ_QUEUE，指腾讯云 TDMQ 消息队列-队列模\ufffd...", "example": "TDMQ_CMQ_QUEUE" }, { "name": "QueueName", "type": "string", "required": false, "description": "队列名称，如果`TargetType`取值为`CMQ_QUEUE` 或 `TDMQ_CMQ_QUEUE`，则本字段必填。", "example": "test-queue" }, { "name": "TopicName", "type": "string", "required": false, "description": "主题名称，如果`TargetType`取值为`CMQ_TOPIC` 或 `TDMQ_CMQ_TOPIC`，则本字段必填。", "example": "test-topic" } ] }, { "name": "LifecycleCommand", "type": "object", "required": false, "description": "远程命令执行对象。通知参数 NotificationMetadata、NotificationTarget 与 LifecycleCommand互斥，不可同时指定。", "example": "{\"CommandId\": \"cmd-am4e3hd8\", \"Parameters\": \"{123: 222}\"}", "children": [ { "name": "CommandId", "type": "string", "required": true, "description": "远程命令ID。若选择执行命令，则此项必填。", "example": "cmd-gt5dre32" }, { "name": "Parameters", "type": "string", "required": false, "description": "自定义参数。字段类型为 json encoded string。如：{\"varA\": \"222\"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 进行替换。 自定义参数最多20个。自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。", "example": "{\"varA\": \"222\"}" } ] } ], "required": [ "LifecycleHookId" ] }, { "name": "ModifyLoadBalancerTargetAttributes", "description": "本接口（ModifyLoadBalancerTargetAttributes）用于修改伸缩组内负载均衡器的目标规则属性。", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-12wjuh0s" }, { "name": "ForwardLoadBalancers", "type": "array", "required": true, "description": "需修改目标规则属性的负载均衡器列表，列表长度上限为100。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "无", "item_type": "object", "children": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡器ID。作为入参时，该参数必填。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "lb-fy6te4r5" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器 ID。作为入参时，该参数必填。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "lbl-dhyt56rf" }, { "name": "TargetAttributes", "type": "array", "required": true, "description": "目标规则属性列表。作为入参时，该参数必填。", "example": "[{\"Port\": 80, \"Weight\": 10}]", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "端口。取值范围为 [1,65535]。作为入参时，该参数必填。", "example": "80" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重。取值范围为 [0,100]。作为入参时，该参数必填。", "example": "10" } ] }, { "name": "LocationId", "type": "string", "required": false, "description": "转发规则ID，注意：针对七层监听器此参数必填。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "loc-sj8y6tr4" }, { "name": "Region", "type": "string", "required": false, "description": "负载均衡实例所属地域，默认取AS服务所在地域。格式与公共参数Region相同，如：\"ap-guangzhou\"。", "example": "ap-guangzhou" } ] } ], "required": [ "AutoScalingGroupId", "ForwardLoadBalancers" ] }, { "name": "ModifyLoadBalancers", "description": "本接口（ModifyLoadBalancers）用于修改伸缩组的负载均衡器。 * 本接口用于为伸缩组指定新的负载均衡器配置，采用`完全覆盖`风格，无论之前配置如何，`统一按照接口参数配置为新的负载均衡器`。 * 如果要为伸缩组清空负载均衡器，则在调用本接口时仅指定伸缩组ID，不指定具体负载均衡器。 * 本接口会立即修改伸缩组的负载均衡器，并生成一个伸缩活动，异步修改存量实例的\ufffd...", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-12wjuh0s" }, { "name": "LoadBalancerIds", "type": "array", "required": false, "description": "传统负载均衡器ID列表，目前长度上限为20，LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "[\"lb-crhgatrf\"]", "item_type": "string" }, { "name": "ForwardLoadBalancers", "type": "array", "required": false, "description": "负载均衡器列表，目前长度上限为100，LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "[{\"LoadBalancerId\": \"lb-af8li2kn\", \"ListenerId\": \"lbl-akw1lgo7\", \"TargetAttributes\": [{\"Port\": 80, \"Weight\": 10}]}]", "item_type": "object", "children": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡器ID。作为入参时，该参数必填。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "lb-fy6te4r5" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器 ID。作为入参时，该参数必填。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "lbl-dhyt56rf" }, { "name": "TargetAttributes", "type": "array", "required": true, "description": "目标规则属性列表。作为入参时，该参数必填。", "example": "[{\"Port\": 80, \"Weight\": 10}]", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": true, "description": "端口。取值范围为 [1,65535]。作为入参时，该参数必填。", "example": "80" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重。取值范围为 [0,100]。作为入参时，该参数必填。", "example": "10" } ] }, { "name": "LocationId", "type": "string", "required": false, "description": "转发规则ID，注意：针对七层监听器此参数必填。可以通过 [DescribeLoadBalancers](https://cloud.tencent.com/document/product/214/30685) 接口获取。", "example": "loc-sj8y6tr4" }, { "name": "Region", "type": "string", "required": false, "description": "负载均衡实例所属地域，默认取AS服务所在地域。格式与公共参数Region相同，如：\"ap-guangzhou\"。", "example": "ap-guangzhou" } ] }, { "name": "LoadBalancersCheckPolicy", "type": "string", "required": false, "description": "负载均衡器校验策略，取值包括 ALL 和 DIFF，默认取值为 ALL。 ALL，所有负载均衡器都合法则通过校验，否则校验报错。 DIFF，仅校验负载均衡器参数中实际变化的部分，如果合法则通过校验，否则校验报错。", "example": "ALL" } ], "required": [ "AutoScalingGroupId" ] }, { "name": "ModifyNotificationConfiguration", "description": "本接口（ModifyNotificationConfiguration）用于修改通知。 * 通知的接收端类型不支持修改。", "status": "online", "parameters": [ { "name": "AutoScalingNotificationId", "type": "string", "required": true, "description": "待修改的通知ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeNotificationConfigurations](https://cloud.tencent.com/document/api/377/33183) ，取返回信息中的 AutoScalingNotificationId 获取通知ID。", "example": "asn-2sestqbr" }, { "name": "NotificationTypes", "type": "array", "required": false, "description": "通知类型，即为需要订阅的通知类型集合，取值范围如下： SCALE_OUT_SUCCESSFUL：扩容成功 SCALE_OUT_FAILED：扩容失败 SCALE_IN_SUCCESSFUL：缩容成功 SCALE_IN_FAILED：缩容失败 REPLACE_UNHEALTHY_INSTANCE_SUCCESSFUL：替换不健康子机成功 REPLACE_UNHEALTHY_INSTANCE_FAILED：替换不健康子机失败", "example": "[\"SCALE_IN_SUCCESSFUL\",\"SCALE_IN_FAILED\"]", "item_type": "string" }, { "name": "NotificationUserGroupIds", "type": "array", "required": false, "description": "通知组ID，即为用户组ID集合，用户组ID可以通过[ListGroups](https://cloud.tencent.com/document/product/598/34589)查询。该参数仅在 `TargetType ` 为 `USER_GROUP ` 时生效。", "example": "[\"1678\"]", "item_type": "string" }, { "name": "QueueName", "type": "string", "required": false, "description": "TDMQ CMQ 队列名。[原CMQ已下线](https://cloud.tencent.com/document/product/1496/83970)，目前仅推荐使用 TDMQ CMQ。该参数仅在 `TargetType ` 为 `TDMQ_CMQ_QUEUE ` 时生效。", "example": "queue" }, { "name": "TopicName", "type": "string", "required": false, "description": "TDMQ CMQ 主题名。[原CMQ已下线](https://cloud.tencent.com/document/product/1496/83970)，目前仅推荐使用 TDMQ CMQ。该参数仅在 `TargetType ` 为 `TDMQ_CMQ_TOPIC ` 时生效。", "example": "topic" } ], "required": [ "AutoScalingNotificationId" ] }, { "name": "ModifyScalingPolicy", "description": "本接口（ModifyScalingPolicy）用于修改告警触发策略。", "status": "online", "parameters": [ { "name": "AutoScalingPolicyId", "type": "string", "required": true, "description": "告警策略ID。可通过登录 控制台 或调用接口 DescribeScalingPolicies ，取返回信息中的 AutoScalingPolicyId 获取告警策略ID。", "example": "asp-iir70sxv" }, { "name": "ScalingPolicyName", "type": "string", "required": false, "description": "告警策略名称，在您账号中必须唯一。名称长度不能超过60，名称仅支持中文、英文、数字、下划线、分隔符\"-\"、小数点。", "example": "cpu_policy_test" }, { "name": "AdjustmentType", "type": "string", "required": false, "description": "告警触发后，期望实例数修改方式，仅适用于简单策略。取值范围：CHANGE_IN_CAPACITY：增加或减少若干期望实例数EXACT_CAPACITY：调整至指定期望实例数 PERCENT_CHANGE_IN_CAPACITY：按百分比调整期望实例数", "example": "CHANGE_IN_CAPACITY" }, { "name": "AdjustmentValue", "type": "integer", "required": false, "description": "告警触发后，期望实例数的调整值，仅适用于简单策略。当 AdjustmentType 为 CHANGE_IN_CAPACITY 时，AdjustmentValue 为正数表示告警触发后增加实例，为负数表示告警触发后减少实例 当 AdjustmentType 为 EXACT_CAPACITY 时，AdjustmentValue 的值即为告警触发后新的期望实例数，需要大于或等于0 当 AdjustmentType 为 PERCENT_CHANGE_IN_CAPACITY 时，AdjusmentValue 为正数表示告警触发后按百分比增加实例，为负数\ufffd\ufffd...", "example": "1" }, { "name": "Cooldown", "type": "integer", "required": false, "description": "冷却时间，仅适用于简单策略，单位为秒。", "example": "60" }, { "name": "MetricAlarm", "type": "object", "required": false, "description": "告警监控指标，仅适用于简单策略。", "example": "无", "children": [ { "name": "ComparisonOperator", "type": "string", "required": true, "description": "比较运算符，可选值：GREATER_THAN：大于GREATER_THAN_OR_EQUAL_TO：大于或等于LESS_THAN：小于 LESS_THAN_OR_EQUAL_TO：小于或等于 EQUAL_TO：等于 NOT_EQUAL_TO：不等于", "example": "GREATER_THAN" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标名称，可选字段如下：CPU_UTILIZATION：CPU利用率MEM_UTILIZATION：内存利用率LAN_TRAFFIC_OUT：内网出带宽LAN_TRAFFIC_IN：内网入带宽WAN_TRAFFIC_OUT：外网出带宽WAN_TRAFFIC_IN：外网入带宽TCP_CURR_ESTAB：TCP连接数当前外网出入带宽属于 CLB 类指标，其他指标属于 CVM 类指标。修改指标名称时不允许跨类别修改。", "example": "CPU_UTILIZATION" }, { "name": "Threshold", "type": "integer", "required": true, "description": "告警阈值：CPU_UTILIZATION：[1, 100]，单位：%MEM_UTILIZATION：[1, 100]，单位：%LAN_TRAFFIC_OUT：\u0026gt;0，单位：Mbps LAN_TRAFFIC_IN：\u0026gt;0，单位：MbpsWAN_TRAFFIC_OUT：\u0026gt;0，单位：MbpsWAN_TRAFFIC_IN：\u0026gt;0，单位：MbpsTCP_CURR_ESTAB：\u0026gt;0, 单位：Count", "example": "10" }, { "name": "Period", "type": "integer", "required": true, "description": "时间周期，单位：秒，取值枚举值为60、300。", "example": "60" }, { "name": "ContinuousTime", "type": "integer", "required": true, "description": "重复次数。取值范围 [1, 10]", "example": "3" }, { "name": "Statistic", "type": "string", "required": false, "description": "统计类型，可选字段如下：AVERAGE：平均值MAXIMUM：最大值MINIMUM：最小值 默认取值：AVERAGE", "example": "AVERAGE" }, { "name": "PreciseThreshold", "type": "float", "required": false, "description": "精确告警阈值，本参数不作为入参输入，仅用作查询接口出参：CPU_UTILIZATION：(0, 100]，单位：%MEM_UTILIZATION：(0, 100]，单位：%LAN_TRAFFIC_OUT：\u0026gt;0，单位：Mbps LAN_TRAFFIC_IN：\u0026gt;0，单位：MbpsWAN_TRAFFIC_OUT：\u0026gt;0，单位：MbpsWAN_TRAFFIC_IN：\u0026gt;0，单位：MbpsTCP_CURR_ESTAB：\u0026gt;0, 单位：Count", "example": "10.123" } ] }, { "name": "PredefinedMetricType", "type": "string", "required": false, "description": "预定义监控项，仅适用于目标追踪策略。取值范围：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：平均外网出带宽当前外网出入带宽属于 CLB 类指标，其他指标属于 CVM 类指标。修改指标名称时不允许跨类别修改。枚举值： ASG_AVG_CPU_UTILIZATION： 平均CPU使用率", "example": "ASG_AVG_CPU_UTILIZATION" }, { "name": "TargetValue", "type": "integer", "required": false, "description": "目标值，仅适用于目标追踪策略。ASG_AVG_CPU_UTILIZATION：[1, 100)，单位：%ASG_AVG_LAN_TRAFFIC_OUT：\u0026gt;0，单位：MbpsASG_AVG_LAN_TRAFFIC_IN：\u0026gt;0，单位：MbpsASG_AVG_WAN_TRAFFIC_OUT：\u0026gt;0，单位：MbpsASG_AVG_WAN_TRAFFIC_IN：\u0026gt;0，单位：Mbps", "example": "10" }, { "name": "EstimatedInstanceWarmup", "type": "integer", "required": false, "description": "实例预热时间，单位为秒，仅适用于目标追踪策略。取值范围为0-3600。", "example": "300" }, { "name": "DisableScaleIn", "type": "boolean", "required": false, "description": "是否禁用缩容，仅适用于目标追踪策略。取值范围：true：目标追踪策略仅触发扩容false：目标追踪策略触发扩容和缩容", "example": "false" }, { "name": "NotificationUserGroupIds", "type": "array", "required": false, "description": "此参数已不再生效，请使用创建通知。通知组ID，即为用户组ID集合。", "example": "[\"1678\"]", "item_type": "string" } ], "required": [ "AutoScalingPolicyId" ] }, { "name": "ModifyScheduledAction", "description": "本接口（ModifyScheduledAction）用于修改定时任务。", "status": "online", "parameters": [ { "name": "ScheduledActionId", "type": "string", "required": true, "description": "待修改的定时任务ID。可以通过调用接口 [DescribeScheduledActions](https://cloud.tencent.com/document/api/377/20450) ，取返回信息中的 ScheduledActionId 获取定时任务ID。", "example": "asst-chwbkq4c" }, { "name": "ScheduledActionName", "type": "string", "required": false, "description": "定时任务名称。名称仅支持中文、英文、数字、下划线、分隔符\"-\"、小数点，最大长度不能超60个字节。同一伸缩组下必须唯一。", "example": "scheduled-action-0" }, { "name": "MaxSize", "type": "integer", "required": false, "description": "当定时任务触发时，设置的伸缩组最大实例数。", "example": "5" }, { "name": "MinSize", "type": "integer", "required": false, "description": "当定时任务触发时，设置的伸缩组最小实例数。", "example": "0" }, { "name": "DesiredCapacity", "type": "integer", "required": false, "description": "当定时任务触发时，设置的伸缩组期望实例数。", "example": "3" }, { "name": "StartTime", "type": "string", "required": false, "description": "定时任务的首次触发时间，取值为`北京时间`（UTC+8），按照`ISO8601`标准，格式：`YYYY-MM-DDThh:mm:ss+08:00`。", "example": "2018-08-28T23:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "定时任务的结束时间，取值为`北京时间`（UTC+8），按照`ISO8601`标准，格式：`YYYY-MM-DDThh:mm:ss+08:00`。此参数与`Recurrence`需要同时指定，到达结束时间之后，定时任务将不再生效。", "example": "2019-01-01T00:00:00+08:00" }, { "name": "Recurrence", "type": "string", "required": false, "description": "定时任务的重复方式。为标准 Cron 格式，[Recurrence参数限制](https://cloud.tencent.com/document/product/377/88119)为5个字段，由空格分开，结构为：分，小时，日期，月份，星期。此参数与`EndTime`需要同时指定。", "example": "0 18 * * 1,2,3,4,5" }, { "name": "DisableUpdateDesiredCapacity", "type": "boolean", "required": false, "description": "停用期望数更新。默认值为 False，表示定时任务触发时期望实例数正常更新。 该值为 True 时，定时任务触发时不会主动修改期望实例数，但可能会因最大最小值机制修改期望实例数。 以下案例的前提都是停用期望数更新为 True： - 定时任务触发时，原期望数为 5，定时任务将最小值改为 10，最大值改为 20，期望数改为 15，由于停用期望数更新，15不生效，但原期望数 5 小于最小...", "example": "false" } ], "required": [ "ScheduledActionId" ] }, { "name": "RemoveInstances", "description": "本接口（RemoveInstances）用于从伸缩组删除 CVM 实例。根据当前的产品逻辑，如果实例由弹性伸缩自动创建，则实例会被销毁；如果实例系创建后加入伸缩组的，则会从伸缩组中移除，保留实例。 * 如果删除指定实例后，伸缩组内处于`IN_SERVICE`状态的实例数量小于伸缩组最小值，接口将报错 * 如果伸缩组处于`DISABLED`状态，删除操作不校验`IN_SERVICE`实例数量和最小值的关系 * 对于\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可以通过如下方式获取可用的伸缩组ID: 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-boz1qhnk" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "CVM实例ID列表。可以通过以下方式获取可用的实例ID： 通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。 通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ，取返回信息中的 `InstanceId` 获取实例ID。", "example": "[\"ins-cri8d02t\",\"ins-osckfnm7\"]", "item_type": "string" } ], "required": [ "AutoScalingGroupId", "InstanceIds" ] }, { "name": "ResumeInstanceRefresh", "description": "恢复暂停状态的实例刷新活动，使其重试当前批次刷新失败实例或继续刷新后续批次，非暂停状态下调用该接口无效。 - 使用 MaxSurge 参数时活动可能会处于扩容或缩容失败导致的暂停状态，也可以使用该接口重试扩缩容。", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可通过如下方式获取： 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-u7dy6t5r" }, { "name": "RefreshActivityId", "type": "string", "required": true, "description": "刷新活动ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ，取返回信息中的 RefreshActivityId 获取实例刷新活动ID。", "example": "asr-dhwt6r54" }, { "name": "ResumeMode", "type": "string", "required": false, "description": "当前批次刷新失败实例的恢复方式，如不存在失败实例，该参数无效。默认值为RETRY，取值范围如下：RETRY: 重试当前批次刷新失败实例CONTINUE: 跳过当前批次刷新失败实例", "example": "RETRY" } ], "required": [ "AutoScalingGroupId", "RefreshActivityId" ] }, { "name": "RollbackInstanceRefresh", "description": "回滚操作会生成一个新的实例刷新活动，该活动也支持分批次刷新以及暂停、恢复、取消操作，接口返回回滚活动的 RefreshActivityId。 * 原活动中待刷新实例变更为已取消，忽略不存在实例，其他状态实例进入回滚流程 * 原活动中正在刷新的实例不会立刻终止，刷新结束后再执行回滚活动 * 暂停状态或最近一次成功的刷新活动支持回滚，其他状态不支持回滚 * 原活动刷新方式为\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可以通过以下方式获取可用的伸缩组ID： 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-12yqet78" }, { "name": "RefreshSettings", "type": "object", "required": true, "description": "刷新设置。", "example": "{\"RollingUpdateSettings\": {\"BatchNumber\": 1, \"BatchPause\": \"AUTOMATIC\"}, \"CheckInstanceTargetHealth\": true}", "children": [ { "name": "RollingUpdateSettings", "type": "object", "required": true, "description": "滚动更新设置参数。RefreshMode 为滚动更新该参数必须填写。", "example": "{\"BatchNumber\": 1, \"MaxSurge\": 1, \"BatchPause\": \"AUTOMATIC\"}", "children": [ { "name": "BatchNumber", "type": "integer", "required": true, "description": "批次数量。批次数量为大于 0 的正整数，但不能大于待刷新实例数量。", "example": "1" }, { "name": "BatchPause", "type": "string", "required": false, "description": "批次间暂停策略。默认值为 Automatic，取值范围如下： FIRST_BATCH_PAUSE：第一批次更新完成后暂停 BATCH_INTERVAL_PAUSE：批次间暂停 AUTOMATIC：不暂停", "example": "AUTOMATIC" }, { "name": "MaxSurge", "type": "integer", "required": false, "description": "最大额外数量。设置该参数后，在滚动更新开始前根据启动配置创建一批按量计费的额外实例，滚动更新完成后销毁额外实例。 该参数用于保证滚动更新过程中可用实例的数量，最大额外数量不能超过滚动更新单个批次的刷新实例数。回滚流程暂不支持该参数。", "example": "1" }, { "name": "FailProcess", "type": "string", "required": false, "description": "失败处理策略。默认值为 AUTO_PAUSE，取值范围如下： AUTO_PAUSE：刷新失败后暂停 AUTO_ROLLBACK：刷新失败后回滚。回滚时每批次回滚一台实例，CheckInstanceTargetHealth 参数值与原刷新活动一致。MaxSurge参数引入的扩缩容流程失败无需回滚，会用取消动作代替回滚 AUTO_CANCEL：刷新失败后取消", "example": "AUTO_PAUSE" } ] }, { "name": "CheckInstanceTargetHealth", "type": "boolean", "required": false, "description": "实例后端服务健康状态检查，默认为 FALSE。仅针对绑定应用型负载均衡器的伸缩组生效，开启该检查后，如刷新后实例未通过检查，负载均衡器端口权重始终为 0，且标记为刷新失败。取值范围如下：TRUE：开启检查FALSE：不开启检查", "example": "TRUE" }, { "name": "CheckInstanceTargetHealthTimeout", "type": "integer", "required": false, "description": "实例后端服务健康状态检查的超时时间，单位为秒，取值范围[60,7200]，默认时间1800秒。仅在CheckInstanceTargetHealth参数开启后生效，若实例健康检查超时，则标记为刷新失败。", "example": "600" } ] }, { "name": "OriginRefreshActivityId", "type": "string", "required": true, "description": "原始刷新活动 ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ，取返回信息中的 OriginRefreshActivityId 获取原始刷新活动ID。", "example": "asr-fdsf8u6b" }, { "name": "RefreshMode", "type": "string", "required": false, "description": "刷新模式，目前仅支持滚动更新，默认值为 ROLLING_UPDATE_RESET。", "example": "ROLLING_UPDATE_RESET" } ], "required": [ "AutoScalingGroupId", "RefreshSettings", "OriginRefreshActivityId" ] }, { "name": "ScaleInInstances", "description": "为伸缩组指定数量缩容实例，返回缩容活动的 ActivityId。 * 伸缩组需要未处于活动中 * 伸缩组处于停用状态时，该接口也会生效，可参考[停用伸缩组](https://cloud.tencent.com/document/api/377/20435)文档查看伸缩组停用状态的影响范围 * 根据伸缩组的`TerminationPolicies`策略，选择被缩容的实例，可参考[缩容处理](https://cloud.tencent.com/document/product/377/8563) * 接口只会选择`IN_SERVICE`实例缩容，如\ufffd...", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可以通过如下方式获取可用的伸缩组ID: 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-12yqet78" }, { "name": "ScaleInNumber", "type": "integer", "required": true, "description": "希望缩容的实例数量。该参数的静态取值范围是 [1,2000]，同时该参数不得大于期望数与最小值的差值。例如伸缩组期望数为 100，最小值为 20，此时可取值范围为 [1,80]。", "example": "1" } ], "required": [ "AutoScalingGroupId", "ScaleInNumber" ] }, { "name": "ScaleOutInstances", "description": "为伸缩组指定数量扩容实例，返回扩容活动的 ActivityId。 * 伸缩组需要未处于活动中 * 伸缩组处于停用状态时，该接口也会生效，可参考[停用伸缩组](https://cloud.tencent.com/document/api/377/20435)文档查看伸缩组停用状态的影响范围 * 接口会增加期望实例数，新的期望实例数需要小于等于最大实例数 * 扩容如果失败或者部分成功，最后期望实例数只会增加实际成功的实例数量 * 竞价混\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可以通过如下方式获取可用的伸缩组ID: 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-12yqet78" }, { "name": "ScaleOutNumber", "type": "integer", "required": true, "description": "希望扩容的实例数量。该参数的静态取值范围是 [1,2000]，同时该参数不得大于期望数与最大值的差值。例如伸缩组期望数为 20，最大值为 100，此时可取值范围为 [1,80]。", "example": "1" } ], "required": [ "AutoScalingGroupId", "ScaleOutNumber" ] }, { "name": "SetInstancesProtection", "description": "本接口（SetInstancesProtection）用于设置实例保护。 实例设置保护之后，当发生不健康替换、报警策略、期望值变更等自动缩容时，将不对此实例缩容操作；对于 [DetachInstances](https://cloud.tencent.com/document/api/377/20436) 和 [RemoveInstances](https://cloud.tencent.com/document/api/377/20431) 接口，允许指定移出被保护的实例。", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可以通过如下方式获取可用的伸缩组ID:通过登录 控制台 查询伸缩组ID。通过调用接口 DescribeAutoScalingGroups ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-2umy3jbd" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID。可以通过以下方式获取可用的实例ID：通过登录控制台查询实例ID。通过调用接口 DescribeInstances ，取返回信息中的 InstanceId 获取实例ID。", "example": "[\"ins-b2d33ywt\"]", "item_type": "string" }, { "name": "ProtectedFromScaleIn", "type": "boolean", "required": true, "description": "实例是否需要设置保护。", "example": "true" } ], "required": [ "AutoScalingGroupId", "InstanceIds", "ProtectedFromScaleIn" ] }, { "name": "StartAutoScalingInstances", "description": "本接口（StartAutoScalingInstances）用于开启伸缩组内 CVM 实例。 * 开机成功，实例转为`IN_SERVICE`状态后，会增加期望实例数，期望实例数不可超过设置的最大值 * 本接口支持批量操作，每次请求开机实例的上限为100", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可以通过如下方式获取可用的伸缩组ID: 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-boz1qhnk" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "待开启的CVM实例ID列表。可以通过以下方式获取可用的实例ID： 通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。 通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ，取返回信息中的 `InstanceId` 获取实例ID。", "example": "[\"ins-cri8d02t\",\"ins-osckfnm7\"]", "item_type": "string" } ], "required": [ "AutoScalingGroupId", "InstanceIds" ] }, { "name": "StartInstanceRefresh", "description": "根据启动配置中参数，刷新伸缩组内运行中状态 CVM 实例，返回实例刷新活动的 RefreshActivityId。 * 对于重装实例的刷新方式（目前仅支持重装），重装时仅会从启动配置中获取 ImageId、UserData、EnhancedService、 HostName、LoginSettings 参数进行刷新，实例的其他参数不会刷新 * 实例刷新期间（包括暂停状态），伸缩组会被停用。不建议刷新期间修改关联启动配置，否则会影响刷新参数，...", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 或调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-12yqet78" }, { "name": "RefreshSettings", "type": "object", "required": true, "description": "刷新设置。", "example": "无", "children": [ { "name": "RollingUpdateSettings", "type": "object", "required": true, "description": "滚动更新设置参数。RefreshMode 为滚动更新该参数必须填写。", "example": "{\"BatchNumber\": 1, \"MaxSurge\": 1, \"BatchPause\": \"AUTOMATIC\"}", "children": [ { "name": "BatchNumber", "type": "integer", "required": true, "description": "批次数量。批次数量为大于 0 的正整数，但不能大于待刷新实例数量。", "example": "1" }, { "name": "BatchPause", "type": "string", "required": false, "description": "批次间暂停策略。默认值为 Automatic，取值范围如下： FIRST_BATCH_PAUSE：第一批次更新完成后暂停 BATCH_INTERVAL_PAUSE：批次间暂停 AUTOMATIC：不暂停", "example": "AUTOMATIC" }, { "name": "MaxSurge", "type": "integer", "required": false, "description": "最大额外数量。设置该参数后，在滚动更新开始前根据启动配置创建一批按量计费的额外实例，滚动更新完成后销毁额外实例。 该参数用于保证滚动更新过程中可用实例的数量，最大额外数量不能超过滚动更新单个批次的刷新实例数。回滚流程暂不支持该参数。", "example": "1" }, { "name": "FailProcess", "type": "string", "required": false, "description": "失败处理策略。默认值为 AUTO_PAUSE，取值范围如下： AUTO_PAUSE：刷新失败后暂停 AUTO_ROLLBACK：刷新失败后回滚。回滚时每批次回滚一台实例，CheckInstanceTargetHealth 参数值与原刷新活动一致。MaxSurge参数引入的扩缩容流程失败无需回滚，会用取消动作代替回滚 AUTO_CANCEL：刷新失败后取消", "example": "AUTO_PAUSE" } ] }, { "name": "CheckInstanceTargetHealth", "type": "boolean", "required": false, "description": "实例后端服务健康状态检查，默认为 FALSE。仅针对绑定应用型负载均衡器的伸缩组生效，开启该检查后，如刷新后实例未通过检查，负载均衡器端口权重始终为 0，且标记为刷新失败。取值范围如下：TRUE：开启检查FALSE：不开启检查", "example": "TRUE" }, { "name": "CheckInstanceTargetHealthTimeout", "type": "integer", "required": false, "description": "实例后端服务健康状态检查的超时时间，单位为秒，取值范围[60,7200]，默认时间1800秒。仅在CheckInstanceTargetHealth参数开启后生效，若实例健康检查超时，则标记为刷新失败。", "example": "600" } ] }, { "name": "RefreshMode", "type": "string", "required": false, "description": "刷新模式。默认值为 ROLLING_UPDATE_RESET，取值范围： ROLLING_UPDATE_RESET：重装系统进行滚动更新 ROLLING_UPDATE_REPLACE：新建实例替换进行滚动更新，该模式暂不支持回滚接口", "example": "ROLLING_UPDATE_RESET" } ], "required": [ "AutoScalingGroupId", "RefreshSettings" ] }, { "name": "StopAutoScalingInstances", "description": "本接口（StopAutoScalingInstances）用于关闭伸缩组内 CVM 实例。 * 关机方式采用`SOFT_FIRST`方式，表示在正常关闭失败后进行强制关闭 * 关闭`IN_SERVICE`状态的实例，会减少期望实例数，期望实例数不可低于设置的最小值 * 使用`STOP_CHARGING`选项关机，待关机的实例需要满足[关机不收费条件](https://cloud.tencent.com/document/product/213/19918) * 本接口支持批量操作，每次请求关机实例的上限为100", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可以通过如下方式获取可用的伸缩组ID: 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-boz1qhnk" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "待关闭的CVM实例ID列表。可以通过以下方式获取可用的实例ID： 通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。 通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ，取返回信息中的 `InstanceId` 获取实例ID。", "example": "[\"ins-cri8d02t\",\"ins-osckfnm7\"]", "item_type": "string" }, { "name": "StoppedMode", "type": "string", "required": false, "description": "关闭的实例是否收费，取值为： KEEP_CHARGING：关机继续收费 STOP_CHARGING：关机停止收费 默认为 KEEP_CHARGING", "example": "STOP_CHARGING" } ], "required": [ "AutoScalingGroupId", "InstanceIds" ] }, { "name": "StopInstanceRefresh", "description": "暂停正在执行的实例刷新活动。 * 暂停状态下，伸缩组也会处于停用中状态 * 当前正在更新或扩容的实例不会暂停，待更新的实例会暂停更新 * 进行缩容时，所有实例都已经更新完成，此时无法暂停", "status": "online", "parameters": [ { "name": "AutoScalingGroupId", "type": "string", "required": true, "description": "伸缩组ID。可以通过以下方式获取可用的伸缩组ID： 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。", "example": "asg-u7dy6t5r" }, { "name": "RefreshActivityId", "type": "string", "required": true, "description": "刷新活动ID。可以通过调用接口 [DescribeRefreshActivities](https://cloud.tencent.com/document/api/377/99175) ，取返回信息中的 RefreshActivityId 获取实例刷新活动ID。", "example": "asr-dhwt6r54" } ], "required": [ "AutoScalingGroupId", "RefreshActivityId" ] }, { "name": "UpgradeLaunchConfiguration", "description": "已有替代接口ModifyLaunchConfiguration。该接口存在覆盖参数风险，目前官网已隐藏 本接口（UpgradeLaunchConfiguration）用于升级启动配置。 * 本接口用于升级启动配置，采用“完全覆盖”风格，无论之前参数如何，统一按照接口参数设置为新的配置。对于非必填字段，不填写则按照默认值赋值。 * 升级修改启动配置后，已经使用该启动配置扩容的存量实例不会发生变更，此后使用该启\ufffd...", "status": "deprecated", "parameters": [ { "name": "LaunchConfigurationId", "type": "string", "required": true, "description": "启动配置ID。", "example": "asc-aaaabbbb" }, { "name": "ImageId", "type": "string", "required": true, "description": "指定有效的镜像ID，格式形如img-8toqc6s3。镜像类型分为四种：公共镜像自定义镜像共享镜像服务市场镜像可通过以下方式获取可用的镜像ID：公共镜像、自定义镜像、共享镜像的镜像ID可通过登录控制台查询；服务镜像市场的镜像ID可通过云市场查询。通过调用接口 DescribeImages ，取返回信息中的ImageId字段。", "example": "img-aaaabbbb" }, { "name": "InstanceTypes", "type": "array", "required": true, "description": "实例机型列表，不同实例机型指定了不同的资源规格，最多支持5种实例机型。", "example": "[\"S5.SMALL2\"]", "item_type": "string" }, { "name": "LaunchConfigurationName", "type": "string", "required": true, "description": "启动配置显示名称。名称仅支持中文、英文、数字、下划线、分隔符\"-\"、小数点，最大长度不能超60个字节。", "example": "myascname" }, { "name": "DataDisks", "type": "array", "required": false, "description": "实例数据盘配置信息。若不指定该参数，则默认不购买数据盘，最多支持指定11块数据盘。", "example": "无", "item_type": "object", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[云硬盘类型](https://cloud.tencent.com/document/product/362/2353)。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 CLOUD_BSSD：通用型SSD云硬盘 默认取值与系统盘类型（SystemDisk.DiskType）保持一致。", "example": "CLOUD_PREMIUM" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "数据盘大小，单位：GB。不同数据盘类型取值范围不同，具体限制详见：[CVM实例配置](https://cloud.tencent.com/document/product/213/2177)。默认值为0，表示不购买数据盘。更多限制详见[产品文档](https://cloud.tencent.com/document/product/362/5145)。", "example": "0" }, { "name": "SnapshotId", "type": "string", "required": false, "description": "数据盘快照 ID，可通过 [DescribeSnapshots](https://cloud.tencent.com/document/product/362/15647) 接口获取该参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "snap-l8psqwnt" }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "数据盘是否随子机销毁。取值范围： TRUE：子机销毁时，销毁数据盘，只支持按小时后付费云盘 FALSE：子机销毁时，保留数据盘 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "Encrypt", "type": "boolean", "required": false, "description": "数据盘是否加密。取值范围： TRUE：加密 FALSE：不加密 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "ThroughputPerformance", "type": "integer", "required": false, "description": "云硬盘性能，单位：MB/s。使用此参数可给云硬盘购买额外的性能，功能介绍和类型限制详见：[增强型 SSD 云硬盘额外性能说明](https://cloud.tencent.com/document/product/362/51896#.E5.A2.9E.E5.BC.BA.E5.9E.8B-ssd-.E4.BA.91.E7.A1.AC.E7.9B.98.E9.A2.9D.E5.A4.96.E6.80.A7.E8.83.BD)。 当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD）且 需容量 \u003e 460GB。 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "BurstPerformance", "type": "boolean", "required": false, "description": "突发性能。是否开启突发性能，默认取值为 false。当前该参数仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD）且需容量 \u003e 460GB。 注：内测中，需提单申请后使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认开启云监控、云安全服务。", "example": "无", "children": [ { "name": "SecurityService", "type": "object", "required": false, "description": "开启云安全服务。若不指定该参数，则默认开启云安全服务。", "example": "{\"Enabled\": True}", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云安全](https://cloud.tencent.com/document/product/296)服务。取值范围： TRUE：表示开启云安全服务 FALSE：表示不开启云安全服务 默认取值：TRUE。", "example": "{\"Enabled\": true}" } ] }, { "name": "MonitorService", "type": "object", "required": false, "description": "开启云监控服务。若不指定该参数，则默认开启云监控服务。", "example": "{\"Enabled\": True}", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[可观测平台（原名云监控）](https://cloud.tencent.com/document/product/248)服务。取值范围： TRUE：表示开启云监控服务 FALSE：表示不开启云监控服务 默认取值：TRUE。", "example": "{\"Enabled\": true}" } ] }, { "name": "AutomationToolsService", "type": "object", "required": false, "description": "开启自动化助手服务。若不指定该参数，则默认逻辑与CVM保持一致。注意：此字段可能返回 null，表示取不到有效值。", "example": "{\"Enabled\": True}", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[自动化助手](https://cloud.tencent.com/document/product/1340)服务。取值范围：TRUE：表示开启自动化助手服务FALSE：表示不开启自动化助手服务 注意：此字段可能返回 null，表示取不到有效值。", "example": "True" } ] } ] }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "实例计费类型，CVM默认值按照POSTPAID_BY_HOUR处理。POSTPAID_BY_HOUR：按小时后付费SPOTPAID：竞价付费PREPAID：预付费，即包年包月", "example": "POSTPAID_BY_HOUR" }, { "name": "InstanceMarketOptions", "type": "object", "required": false, "description": "实例的市场相关选项，如竞价实例相关参数，若指定实例的付费模式为竞价付费则该参数必传。", "example": "无", "children": [ { "name": "SpotOptions", "type": "object", "required": true, "description": "竞价相关选项", "example": "{\"SpotInstanceType\": \"one-time\", \"MaxPrice\": 1000}", "children": [ { "name": "MaxPrice", "type": "string", "required": true, "description": "竞价出价，例如“1.05”", "example": "1.05" }, { "name": "SpotInstanceType", "type": "string", "required": false, "description": "竞价请求类型，当前仅支持类型：one-time，默认值为one-time", "example": "one-time" } ] }, { "name": "MarketType", "type": "string", "required": false, "description": "市场选项类型，当前只支持取值：spot", "example": "spot" } ] }, { "name": "InstanceTypesCheckPolicy", "type": "string", "required": false, "description": "实例类型校验策略，取值包括 ALL 和 ANY，默认取值为ANY。 ALL，所有实例类型（InstanceType）都可用则通过校验，否则校验报错。 ANY，存在任何一个实例类型（InstanceType）可用则通过校验，否则校验报错。实例类型不可用的常见原因包括该实例类型售罄、对应云盘售罄等。如果 InstanceTypes 中一款机型不存在或者已下线，则无论 InstanceTypesCheckPolicy 采用何种取值，都会校验报错。", "example": "ALL" }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型。取值范围：BANDWIDTH_PREPAID：预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费BANDWIDTH_PACKAGE：带宽包用户默认取值：TRAFFIC_POSTPAID_BY_HOUR。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/509)。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "PublicIpAssigned", "type": "boolean", "required": false, "description": "是否分配公网IP。取值范围：TRUE：表示分配公网IPFALSE：表示不分配公网IP当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID。可通过[DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bwp-dss86yt5" }, { "name": "InternetServiceProvider", "type": "string", "required": false, "description": "线路类型。各种线路类型及支持地区详情可参考：[EIP 的 IP 地址类型](https://cloud.tencent.com/document/product/1199/41646)。默认值：BGP。 BGP：常规 BGP 线路 已开通静态单线IP白名单的用户，可选值： CMCC：中国移动 CTCC：中国电信 CUCC：中国联通 注意：仅部分地域支持静态单线IP。", "example": "BGP" }, { "name": "IPv4AddressType", "type": "string", "required": false, "description": "公网 IP 类型。 WanIP：普通公网IP。 HighQualityEIP：精品 IP。仅新加坡和中国香港支持精品IP。 AntiDDoSEIP：高防 IP。仅部分地域支持高防IP，详情可见[弹性公网IP产品概述](https://cloud.tencent.com/document/product/1199/41646) 。 如需为资源分配弹性公网IPv4地址，请指定弹性公网IPv4地址类型。如只使用WanIP，不需要设置此字段。 精品IP 高防IP功能仅部分地区灰度开放，如需使用[请提交工单咨询]...", "example": "WanIP" }, { "name": "AntiDDoSPackageId", "type": "string", "required": false, "description": "高防包唯一ID，申请高防IP时，该字段必传。", "example": "bgp-00000000" }, { "name": "IsKeepEIP", "type": "boolean", "required": false, "description": "实例销毁时是否一并销毁绑定的弹性IP。 取值范围： TRUE：表示保留EIP FALSE：表示不保留 请注意，当IPv4AddressType字段指定EIP类型时，默认不保留EIP。WanIP不受此字段影响始终随实例销毁。 变更配置此字段，已绑定伸缩组会立刻生效。", "example": "false" } ] }, { "name": "LoginSettings", "type": "object", "required": false, "description": "该参数已失效，请勿使用。升级启动配置接口无法修改或覆盖 LoginSettings 参数，升级后 LoginSettings 不会发生变化。", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下： - Linux实例密码必须8到30位，至少包括四项（小写字母、大写字母、数字和特殊符号）中的两项。 - Windows实例密码必须12到30位，至少包括包括四项（小写字母、大写字母、数字和特殊符号）中的三项。 - 若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到用户。 特殊符号的取值范围： [( ) ` ~...", "example": "passExam@!7862543" }, { "name": "KeyIds", "type": "array", "required": false, "description": "密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。", "example": "[\"skey-ju7fy6t5\"]", "item_type": "string" }, { "name": "KeepImageLogin", "type": "boolean", "required": false, "description": "保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围： TRUE：表示保持镜像的登录设置 FALSE：表示不保持镜像的登录设置默认取值：FALSE。", "example": "false" } ] }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。不填为默认项目。", "example": "1222" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的SecurityGroupId字段来获取。若不指定该参数，则默认不绑定安全组。", "example": "[\"sg-aaaabbbb\"]", "item_type": "string" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "实例系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见[云硬盘类型](https://cloud.tencent.com/document/product/362/2353)。取值范围 LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_BSSD：通用型SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 默认取值：CLOUD_PREMIUM。", "example": "CLOUD_PREMIUM" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GB。默认值为 50", "example": "50" } ] }, { "name": "UserData", "type": "string", "required": false, "description": "经过 Base64 编码后的自定义数据，最大长度不超过16KB。", "example": "IyEvYmluL2Jhc2gKZWNobyAx" }, { "name": "InstanceTags", "type": "array", "required": false, "description": "标签列表。通过指定该参数，可以为扩容的实例绑定标签。最多支持指定10个标签。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "as-tag-key-app0" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "as-tag-value-app0" } ] }, { "name": "CamRoleName", "type": "string", "required": false, "description": "CAM角色名称。可通过DescribeRoleList接口返回值中的roleName获取。", "example": "myrolename" }, { "name": "HostNameSettings", "type": "object", "required": false, "description": "云服务器主机名（HostName）的相关设置。", "example": "无", "children": [ { "name": "HostName", "type": "string", "required": true, "description": "云服务器的主机名。 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。 不支持 Windows 实例。 其他类型（Linux 等）实例：字符长度为[2, 42]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。不允许为纯数字。 注意：此字段可能返回 null，表示取不到有效值。", "example": "product-as-host-0" }, { "name": "HostNameStyle", "type": "string", "required": false, "description": "云服务器主机名的风格，取值范围包括 ORIGINAL 和 UNIQUE，默认为 ORIGINAL。 ORIGINAL，AS 直接将入参中所填的 HostName 传递给 CVM，CVM 可能会对 HostName 追加序列号，伸缩组中实例的 HostName 会出现冲突的情况。 UNIQUE，入参所填的 HostName 相当于主机名前缀，AS 和 CVM 会对其进行拓展，伸缩组中实例的 HostName 可以保证唯一。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ORIGINAL" }, { "name": "HostNameSuffix", "type": "string", "required": false, "description": "云服务器的主机名后缀。 点号（.）和短横线（-）不能作为 HostNameSuffix 的尾字符，不能连续使用。 不支持 Windows 实例。 其他类型（Linux 等）实例：字符长度为[1, 39]，且与 HostName 的长度和不能超过 41，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。 注意：此字段可能返回 null，表示取不到有效值。", "example": "suffix" }, { "name": "HostNameDelimiter", "type": "string", "required": false, "description": "云服务器的主机名分隔符。默认的分隔符是点号（.），可选短横线（-）或空字符串。 分隔符用于拼接主机名，递增序号，后缀。假设主机名为 testGpu4090 ，递增序号为 0007，后缀为 server： - 分隔符为英文点号（.），最终拼接为 testGpu4090.007.server - 分隔符为短横线（-），最终拼接为 testGpu4090-007-server - 分隔符为空字符串，最终拼接为 testGpu4090007server", "example": "." } ] }, { "name": "InstanceNameSettings", "type": "object", "required": false, "description": "云服务器实例名（InstanceName）的相关设置。", "example": "无", "children": [ { "name": "InstanceName", "type": "string", "required": true, "description": "云服务器的实例名。字符长度为[2, 108]。", "example": "product-as-ins-0" }, { "name": "InstanceNameStyle", "type": "string", "required": false, "description": "云服务器实例名的风格，取值范围包括 ORIGINAL 和 UNIQUE，默认为 ORIGINAL。 ORIGINAL，AS 直接将入参中所填的 InstanceName 传递给 CVM，CVM 可能会对 InstanceName 追加序列号，伸缩组中实例的 InstanceName 会出现冲突的情况。 UNIQUE，入参所填的 InstanceName 相当于实例名前缀，AS 和 CVM 会对其进行拓展，伸缩组中实例的 InstanceName 可以保证唯一。", "example": "ORIGINAL" }, { "name": "InstanceNameSuffix", "type": "string", "required": false, "description": "云服务器实例名后缀。字符长度为[1,105]，且与 InstanceName 的长度和不能超过107。 注意：此字段可能返回 null，表示取不到有效值。", "example": "testsuffix" }, { "name": "InstanceNameDelimiter", "type": "string", "required": false, "description": "云服务器的实例名分隔符。默认的分隔符是点号（.），可选短横线（-）或空字符串。 分隔符用于拼接实例名，递增序号，后缀。假设实例名为 testGpu4090 ，递增序号为 0007，后缀为 server： - 分隔符为英文点号（.），最终拼接为 testGpu4090.007.server - 分隔符为短横线（-），最终拼接为 testGpu4090-007-server - 分隔符为空字符串，最终拼接为 testGpu4090007server", "example": "." } ] }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "NOTIFY_AND_MANUAL_RENEW" } ] }, { "name": "DiskTypePolicy", "type": "string", "required": false, "description": "云盘类型选择策略，取值范围：ORIGINAL：使用设置的云盘类型AUTOMATIC：自动选择当前可用的云盘类型", "example": "ORIGINAL" }, { "name": "IPv6InternetAccessible", "type": "object", "required": false, "description": "IPv6公网带宽相关信息设置。若新建实例包含IPv6地址，该参数可为新建实例的IPv6地址分配公网带宽。关联启动配置的伸缩组Ipv6AddressCount参数为0时，该参数不会生效。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费模式。取值包括TRAFFIC_POSTPAID_BY_HOUR、BANDWIDTH_PACKAGE，默认取值为TRAFFIC_POSTPAID_BY_HOUR。查看当前账户类型可参考[账户类型说明](https://cloud.tencent.com/document/product/1199/49090#judge)。 IPv6对标准账户类型支持TRAFFIC_POSTPAID_BY_HOUR。 IPv6对传统账户类型支持BANDWIDTH_PACKAGE。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0，此时不为IPv6分配公网带宽。不同机型、可用区、计费模式的带宽上限范围不一致，具体限制详见[公网带宽上限](https://cloud.tencent.com/document/product/213/12523)。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID。可通过[DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bwp-jfio9i0p" } ] } ], "required": [ "LaunchConfigurationId", "ImageId", "InstanceTypes", "LaunchConfigurationName" ] }, { "name": "UpgradeLifecycleHook", "description": "本接口（UpgradeLifecycleHook）用于升级生命周期挂钩。 * 本接口用于升级生命周期挂钩，采用“完全覆盖”风格，无论之前参数如何，统一按照接口参数设置为新的配置。对于非必填字段，不填写则按照默认值赋值。", "status": "online", "parameters": [ { "name": "LifecycleHookId", "type": "string", "required": true, "description": "生命周期挂钩ID。可以通过调用接口 DescribeLifecycleHooks ，取返回信息中的 LifecycleHookId 获取生命周期挂钩ID。", "example": "ash-8azjzxj9" }, { "name": "LifecycleHookName", "type": "string", "required": true, "description": "生命周期挂钩名称。名称仅支持中文、英文、数字、下划线（_）、短横线（-）、小数点（.），最大长度不能超128个字符。", "example": "hook-updated" }, { "name": "LifecycleTransition", "type": "string", "required": true, "description": "进行生命周期挂钩的场景，取值范围如下: INSTANCE_LAUNCHING: 扩容生命周期挂钩 INSTANCE_TERMINATING: 缩容生命周期挂钩", "example": "INSTANCE_LAUNCHING" }, { "name": "DefaultResult", "type": "string", "required": false, "description": "定义伸缩组在生命周期挂钩超时或 LifecycleCommand 执行失败时应采取的操作，取值范围是如下： CONTINUE: 默认值，表示继续执行扩缩容活动 ABANDON: 针对扩容挂钩，挂钩超时或 LifecycleCommand 执行失败的 CVM 实例会直接释放或移出；而针对缩容挂钩，会继续执行缩容活动。", "example": "CONTINUE" }, { "name": "HeartbeatTimeout", "type": "integer", "required": false, "description": "生命周期挂钩超时之前可以经过的最长时间（以秒为单位），范围从30到7200秒，默认值为300秒", "example": "240" }, { "name": "NotificationMetadata", "type": "string", "required": false, "description": "弹性伸缩向通知目标发送的附加信息，配置通知时使用，默认值为空字符串。NotificationMetadata 和 LifecycleCommand参数互斥，二者不可同时指定。", "example": "as-meta-0" }, { "name": "NotificationTarget", "type": "object", "required": false, "description": "通知目标。NotificationTarget和LifecycleCommand参数互斥，二者不可同时指定。", "example": "无", "children": [ { "name": "TargetType", "type": "string", "required": true, "description": "目标类型，取值范围包括`CMQ_QUEUE`、`CMQ_TOPIC`、`TDMQ_CMQ_QUEUE`、`TDMQ_CMQ_TOPIC`。 CMQ_QUEUE，指腾讯云消息队列-队列模型，对应产品已下线，[建议切换](https://cloud.tencent.com/document/product/1496/83970) TDMQ_CMQ_QUEUE 使用。 CMQ_TOPIC，指腾讯云消息队列-主题模型，对应产品已下线，[建议切换](https://cloud.tencent.com/document/product/1496/83970) TDMQ_CMQ_TOPIC 使用。 TDMQ_CMQ_QUEUE，指腾讯云 TDMQ 消息队列-队列模\ufffd...", "example": "TDMQ_CMQ_QUEUE" }, { "name": "QueueName", "type": "string", "required": false, "description": "队列名称，如果`TargetType`取值为`CMQ_QUEUE` 或 `TDMQ_CMQ_QUEUE`，则本字段必填。", "example": "test-queue" }, { "name": "TopicName", "type": "string", "required": false, "description": "主题名称，如果`TargetType`取值为`CMQ_TOPIC` 或 `TDMQ_CMQ_TOPIC`，则本字段必填。", "example": "test-topic" } ] }, { "name": "LifecycleTransitionType", "type": "string", "required": false, "description": "进行生命周期挂钩的场景类型，取值范围包括NORMAL 和 EXTENSION。说明：设置为EXTENSION值，在AttachInstances、DetachInstances、RemoveInstaces接口时会触发生命周期挂钩操作，值为NORMAL则不会在这些接口中触发生命周期挂钩。", "example": "NORMAL" }, { "name": "LifecycleCommand", "type": "object", "required": false, "description": "远程命令执行对象。通知参数 NotificationMetadata、NotificationTarget 与 LifecycleCommand 互斥，不可同时指定。", "example": "无", "children": [ { "name": "CommandId", "type": "string", "required": true, "description": "远程命令ID。若选择执行命令，则此项必填。", "example": "cmd-gt5dre32" }, { "name": "Parameters", "type": "string", "required": false, "description": "自定义参数。字段类型为 json encoded string。如：{\"varA\": \"222\"}。 key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。 如果未提供该参数取值，将使用 Command 的 DefaultParameters 进行替换。 自定义参数最多20个。自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。", "example": "{\"varA\": \"222\"}" } ] } ], "required": [ "LifecycleHookId", "LifecycleHookName", "LifecycleTransition" ] } ] }