ALIYUN::ECS::InstanceGroupClone类型用于克隆一组ECS实例。
语法
{
"Type": "ALIYUN::ECS::InstanceGroupClone",
"Properties": {
"BackendServerWeight": Integer,
"SystemDiskAutoSnapshotPolicyId": String,
"DiskMappings": List,
"Period": Number,
"LaunchTemplateName": String,
"RamRoleName": String,
"ResourceGroupId": String,
"KeyPairName": String,
"SystemDiskDiskName": String,
"PeriodUnit": String,
"Description": String,
"Tags": List,
"AutoRenewPeriod": Number,
"ImageId": String,
"AutoRenew": String,
"SpotStrategy": String,
"SourceInstanceId": String,
"EniMappings": List,
"Password": String,
"PasswordInherit": Boolean,
"MaxAmount": Integer,
"AutoReleaseTime": String,
"SystemDiskCategory": String,
"LoadBalancerIdToAttach": String,
"LaunchTemplateId": String,
"LaunchTemplateVersion": String,
"ZoneId": String,
"InternetMaxBandwidthOut": Integer,
"InstanceName": String,
"DeletionProtection": Boolean,
"DeploymentSetId": String,
"Ipv6AddressCount": Integer,
"SecurityGroupId": String,
"SecurityGroupIds": List,
"SpotPriceLimit": String,
"HpcClusterId": String,
"SystemDiskDescription": String,
"Ipv6Addresses": List,
"SystemDiskProvisionedIops": Integer,
"SystemDiskBurstingEnabled": Boolean,
"SystemDiskKMSKeyId": String,
"SystemDiskStorageClusterId": String,
"InternetMaxBandwidthIn": Integer,
"UpdatePolicy": String,
"SystemDiskEncryptAlgorithm": String,
"SystemDiskEncrypted": String
}
}
属性
属性名称 | 类型 | 必须 | 允许更新 | 描述 | 约束 |
ResourceGroupId | String | 否 | 否 | 实例所在的资源组ID。 | 无 |
HpcClusterId | String | 否 | 是 | 实例所属的EHPC集群ID。 | 无 |
SourceInstanceId | String | 是 | 否 | 需要克隆的ECS实例ID。 | 克隆实例规格、镜像、带宽收费方式、带宽限制、网络类型等。如果源ECS实例加入多个安全组,新的安全组会加入源实例的首个安全组。 |
MaxAmount | Integer | 是 | 是 | 一次性创建ECS实例的个数。 | 取值范围:1~100。 |
BackendServerWeight | Integer | 否 | 否 | ECS实例在负载均衡器实例中的权重。 | 取值范围:0~100。 默认值:100。 |
LoadBalancerIdToAttach | String | 否 | 否 | ECS实例将加入到的负载均衡实例的ID。 | 无 |
Description | String | 否 | 是 | 描述信息。 | 最长256个字符。 |
ImageId | String | 否 | 是 | 用于启动ECS实例的镜像ID,包括公共镜像、自定义镜像和云市场镜像。 | 支持通过模糊的方式指定公共镜像ID,无需指定一个完整的公共镜像ID。例如:
|
InternetMaxBandwidthOut | Integer | 否 | 否 | 公网最大出网带宽。 | 单位:Mbps。 取值范围:
|
SecurityGroupId | String | 否 | 否 | 实例所属的安全组。 | 不支持同时指定SecurityGroupId和SecurityGroupIds。 |
SecurityGroupIds | List | 否 | 否 | 实例所属的安全组列表。 | 更多信息,请参见安全组。 不支持同时指定SecurityGroupId和SecurityGroupIds。 |
InstanceName | String | 否 | 否 | 实例名称。 | 最长为128个字符。可包含英文字母、汉字、数字、下划线(_)、半角句号(.)和短划线(-)。 |
Password | String | 否 | 是 | ECS实例登录密码。 | 长度为8~30个字符。必须同时包含英文字母、数字和特殊字符,支持特殊字符: 如果指定此参数,请使用HTTPS协议调用API,以避免密码泄露。 |
PasswordInherit | Boolean | 否 | 否 | 是否使用镜像预设的密码。 | 取值:
说明 使用该参数时,Password参数必须为空,同时您需要确保使用的镜像已经设置了密码。 |
DiskMappings | List | 否 | 是 | 需要挂载的磁盘。 | 最多支持16块磁盘。 更多信息,请参见DiskMappings属性。 |
Period | Number | 否 | 是 | 付费周期。 | 取值:1~9、12、24、36。 单位:月。 当InstanceChargeType取值为PrePaid时,此参数为必选参数;当InstanceChargeType取值为PostPaid时,此参数为可选参数。 |
Tags | List | 否 | 是 | 用户自定义标签。 | 最多支持20个标签,格式: 更多信息,请参见Tags属性。 |
ZoneId | String | 否 | 否 | 可用区ID。 | 无 |
KeyPairName | String | 否 | 是 | ECS实例绑定的密钥对名称。 | 如果是Windows ECS实例,则忽略该参数。如果已填写KeyPairName,Password的内容仍会被设置到实例中,但是Linux系统中的密码登录方式会被禁止。 |
RamRoleName | String | 否 | 是 | 实例RAM角色名称。 | 您可以调用ListRoles查询实例RAM角色名称,更多信息,请参见CreateRole - 创建角色和ListRoles - 获取角色列表。 |
SpotPriceLimit | String | 否 | 否 | 实例的每小时最高价格。 | 最大支持3位小数。当SpotStrategy为SpotWithPriceLimit时,SpotPriceLimit生效。 |
SpotStrategy | String | 否 | 否 | 后付费实例的竞价策略。 | 当InstanceChargeType取值为PostPaid时,此参数为必选参数。 取值:
|
SystemDiskDiskName | String | 否 | 是 | 系统盘名称。 | 长度为2~128个字符。必须以英文字母或汉字开头,不能以 |
PeriodUnit | String | 否 | 是 | 购买资源的时长。 | 取值:
|
AutoRenewPeriod | Number | 否 | 是 | 每次自动续费的时长。 | 当AutoRenew为true时,该参数为必填参数。 取值:
|
AutoRenew | String | 否 | 是 | 是否自动续费。 | 取值:
当InstanceChargeType取值PrePaid时,此参数为必选参数。 |
EniMappings | List | 否 | 是 | 附加到实例的弹性网卡。 | 附加到实例的弹性网卡个数最多为1个。 更多信息,请参见EniMappings属性。 |
AutoReleaseTime | String | 否 | 否 | ECS实例自动释放的时间。 | 时间格式必须遵守ISO8601规范,例如: |
SystemDiskCategory | String | 否 | 是 | 系统盘类型。 | 取值:
|
SystemDiskProvisionedIops | Integer | 否 | 是 | 系统盘预配的 IOPS。 | 无 |
SystemDiskBurstingEnabled | Boolean | 否 | 是 | 系统盘是否启用突发。 | 取值:
|
LaunchTemplateName | String | 否 | 是 | 启动模板的名称。 | 无 |
LaunchTemplateVersion | String | 否 | 是 | 启动模板的版本。 | 如果没有指定版本,则使用默认版本。 |
LaunchTemplateId | String | 否 | 是 | 启动模板ID。 | 无 |
SystemDiskDescription | String | 否 | 是 | 系统盘描述信息。 | 无 |
DeletionProtection | Boolean | 否 | 否 | 实例释放保护属性,指定是否支持通过控制台或DeleteInstance接口释放实例。 | 取值:
|
DeploymentSetId | String | 否 | 是 | 部署集ID。 | 无 |
Ipv6AddressCount | Integer | 否 | 是 | 为弹性网卡指定随机生成的IPv6地址数量。 | 不能同时指定Ipv6Addresses和Ipv6AddressCount。 |
Ipv6Addresses | List | 否 | 是 | 为弹性网卡指定的一个或多个IPv6地址。 | 列表最大长度为1。属性的更改不影响现有实例。不能同时指定Ipv6Addresses和Ipv6AddressCount。 |
SystemDiskAutoSnapshotPolicyId | String | 否 | 是 | 系统盘自动快照策略ID。 | 无 |
SystemDiskKMSKeyId | String | 否 | 是 | 系统盘使用的KMS密钥ID。 | 无 |
SystemDiskStorageClusterId | String | 否 | 是 | 系统盘专属块存储集群ID。 | 无 |
InternetMaxBandwidthIn | Integer | 否 | 否 | 最大互联网输出带宽设置。 | 单位为Mbps(兆比特每秒)。 取值范围为0~200。 默认值为200。 |
UpdatePolicy | String | 否 | 是 | 指定更新时的策略。 | 取值:
|
SystemDiskEncryptAlgorithm | String | 否 | 是 | 系统盘采用的加密算法。 | 取值:
|
SystemDiskEncrypted | String | 否 | 是 | 系统盘是否加密。 | 取值:
|
DiskMappings语法
"DiskMappings": [
{
"Category": String,
"DiskName": String,
"Description": String,
"Encrypted": String,
"KMSKeyId": String,
"Device": String,
"SnapshotId": String,
"Size": String,
"PerformanceLevel": String,
"AutoSnapshotPolicyId": String,
"ProvisionedIops": Integer,
"BurstingEnabled": Boolean
}
]
DiskMappings属性
属性名称 | 类型 | 必须 | 允许更新 | 描述 | 约束 |
Size | String | 是 | 否 | 数据盘大小。 | 单位:GB。 |
Category | String | 否 | 否 | 数据盘的类型。 | 取值:
|
DiskName | String | 否 | 否 | 数据盘的名称。 | 最长128个字符。可包含英文字母、汉字、数字、下划线(_)、半角句号(.)和短划线(-)。 |
Description | String | 否 | 否 | 数据盘的描述。 | 长度为2~256个字符。不能以 |
Device | String | 否 | 否 | 数据盘在ECS中的名称。 | 取值示例: |
SnapshotId | String | 否 | 否 | 快照ID。 | 无 |
Encrypted | String | 否 | 否 | 数据盘是否加密。 | 取值:
|
KMSKeyId | String | 否 | 否 | 数据盘对应的KMS密钥ID。 | 无 |
AutoSnapshotPolicyId | String | 否 | 否 | 自动快照策略ID。 | 无 |
PerformanceLevel | String | 否 | 否 | 创建ESSD云盘作为系统盘使用时,设置云盘的性能等级。 | 取值:
关于如何选择ESSD性能等级,请参见ESSD云盘。 |
ProvisionedIops | Integer | 否 | 否 | 预配的IOPS。 | 无 |
BurstingEnabled | Boolean | 否 | 否 | 是否启用突发。 | 取值:
|
EniMappings语法
"EniMappings": [
{
"SecurityGroupId": String,
"VSwitchId": String,
"Description": String,
"NetworkInterfaceName": String,
"PrimaryIpAddress": String,
"InstanceType": String,
"Ipv6AddressCount": Integer,
"NetworkInterfaceTrafficMode": String,
"Ipv6Addresses": List,
"QueueNumber": Integer,
"SecurityGroupIds": List
}
]
EniMappings属性
属性名称 | 类型 | 必须 | 允许更新 | 描述 | 约束 |
SecurityGroupId | String | 否 | 是 | 安全组ID。 | 所属的安全组ID必须是同一个专有网络下的安全组。 |
VSwitchId | String | 是 | 否 | 交换机ID。 | 无 |
Description | String | 否 | 是 | 弹性网卡的描述信息。 | 长度为2~256个字符,不能以 |
NetworkInterfaceName | String | 否 | 是 | 弹性网卡名称。 | 长度为2~128个字符。必须以英文字母或汉字开头,不能以 |
PrimaryIpAddress | String | 否 | 否 | 弹性网卡的主私有IP地址。 | 指定的IP必须是在所属交换机的地址段内的空闲地址。 如果不指定IP,则默认随机分配该交换机中的空闲地址。 |
InstanceType | String | 否 | 否 | 弹性网卡类型。 | 最多设置2个网卡,设置1个弹性网卡时,支持设置1个主网卡或1个辅助网卡。设置2个弹性网卡时,仅支持同时设置1个主网卡和1个辅助网卡。 取值:
|
Ipv6AddressCount | Integer | 否 | 否 | 为主网卡指定随机生成的IPv6地址数量。 | 取值范围:1~10。 注意事项:
|
NetworkInterfaceTrafficMode | String | 否 | 否 | 网卡的通讯模式。 | 取值:
说明 RDMA模式的弹性网卡数量不能超过该实例规格族的限制。更多信息,请参见实例规格族。 |
Ipv6Addresses | List | 否 | 否 | 为主网卡指定一个或多个IPv6地址。 | 支持设置最多10个IPv6地址。 注意事项:
|
QueueNumber | Integer | 否 | 否 | 弹性网卡队列数。 | 注意事项:
|
SecurityGroupIds | List | 否 | 否 | 弹性网卡所属的一个或多个安全组ID。 | 注意事项:
|
Tags语法
"Tags": [
{
"Value": String,
"Key": String
}
]
Tags属性
属性名称 | 类型 | 必须 | 允许更新 | 描述 | 约束 |
Key | String | 是 | 否 | 标签键。 | 长度为1~128个字符,不能以 |
Value | String | 否 | 否 | 标签值。 | 长度为0~128个字符,不能以 |
返回值
Fn::GetAtt
InstanceIds:实例ID,是访问实例的唯一标识。由系统生成,全局唯一。
PrivateIps:VPC类型实例的私网IP列表。当NetworkType为
vpc
时,此参数生效。例如:一个带有格式的JSON Array: [“172.16.XX.XX”, “172.16.XX.XX”, … “172.16.XX.XX”],最多100个IP,用半角逗号(,)隔开。InnerIps:Classic类型实例的私网IP列表。当NetworkType为
classic
时,此参数生效。例如:一个带有格式的JSON Array: [“10.1.XX.XX”, “10.1.XX.XX”, … “10.1.XX.XX”],最多100个IP,用半角逗号(,)隔开。PublicIps:Classic类型实例的公网IP列表。当NetworkType为
classic
时,此参数生效。例如:一个带有格式的JSON Array: [“42.1.XX.XX”, “42.1.XX.XX”, … “42.1.XX.XX”],最多100个IP,用半角逗号(,)隔开。HostNames:所有实例的主机名称列表。
OrderId:实例的订单ID列表。
ZoneIds:可用区ID。
Ipv6AddressIds:已创建ECS实例的IPv6地址ID列表。注意:返回类型是两层列表。如果实例没有任何IPv6地址,则列表中相应位置的元素为空。如果所有实例都没有任何IP地址,则将返回null。
Ipv6Addresses:已创建ECS实例的IPv6地址列表。注意:返回类型是两层列表。如果实例没有任何IPv6地址,则列表中相应位置的元素为null。如果所有实例都没有任何IP地址,则将返回null。
示例
更多示例,请参见创建一组相同配置的ECS实例、克隆一个ECS实例、新建云助手命令和为一台或多台ECS实例触发一条云助手命令的组合示例:JSON示例和YAML示例。
- 本页导读 (1)