云服务器
云服务器
文档指南
请输入
- 文档首页
云服务器云服务器ECSAPI参考实例CreateScheduledInstances - 创建弹性预约实例
复制全文
下载 pdfCreateScheduledInstances - 创建弹性预约实例
文档反馈
问问助手调用 CreateScheduledInstances 接口创建弹性预约实例。
使用说明
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：CreateScheduledInstances
要执行的操作，取值：CreateScheduledInstances。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
AutoReleaseAt string 可选 示例值：2023-03-29T18:50:00+08:00
实例自动释放时间，必须为10分钟整点。
当ElasticScheduledInstanceType取值为Segmented时，需传入该参数，取值范围：
- 当DeliveryType取值为Reserve时，实例最早释放时间为预约的交付时间段+1小时。
- DeliveryType取值为Immediate时，实例最早释放时间为当前时间的下一个整十分钟时间点。例如当前时间5:02，则最早自动释放时间为5:20。
ClientToken string 可选 示例值：333456899ff****
保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。
取值：仅支持ASCII字符，且不能超过64个字符。
Count integer 可选 示例值：1
实例创建数量，取值范围：
- 若ElasticScheduledInstanceType传入Esi，取值范围1～500。
- 若ElasticScheduledInstanceType传入Segmented，且：
- DeliveryType为Reserve，取值范围1～500。
- DeliveryType为Immediate，取值范围1～100。
说明
传入0时，会默认为1。
CpuMaxFrequency float 可选 示例值：2.8
指定CPU最大频率，单位：GHz，取值范围：CPU的主频到睿频之间。
说明
- 当前仅g3al（4xlarge、8xlarge、16xlarge、32xlarge）、c3al（4xlarge、8xlarge、16xlarge、32xlarge）、r3al（4xlarge、8xlarge、16xlarge）、g4i、c4i、r4i、g4ie、c4ie、r4ie实例支持设置该参数。规格的主频/睿频及更多信息，请参见实例规格介绍。
- 该功能正在邀测中，如需使用，请联系客户经理申请。
DeletionProtection boolean 可选 示例值：true
实例删除保护属性，指定是否支持通过控制台或API删除实例。取值：
- true：开启实例删除保护。
- false（默认）：关闭实例删除保护。
DeliveryType string 可选 示例值：Reserve
弹性预约实例-时段型交付类型，取值：
- Reserve（默认）：预约交付
- Immediate：立即交付
说明
- 仅ElasticScheduledInstanceType取值为Segmented时，需传入该参数。
- 弹性预约实例-时段型正在邀测中，如需试用，请联系客户经理申请。
Description string 可选 示例值：ECS instance for testing.
实例的描述，默认值为空字符串。
- 必须以字母或中文开头。
- 只能包含中文、字母、数字、点号“.”、空格、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、中文逗号“，”和中文句号“。”
- 长度限制在255个字符以内。
DryRun boolean 可选 示例值：false
是否只预检此次请求。取值：
- true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和ECS库存。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
说明
当DryRun取值为true时，若传入了Count或Mincount参数，则取值必须为1。
- false（默认）：发送正常请求，通过检查后直接创建实例。
EipAddress.BandwidthMbps integer 可选 示例值：5
公网IP的带宽上限，默认值为1，单位：Mbps。
- ChargeType传入PayByBandwidth：取值范围1～500。
- ChargeType传入PayByTraffic：取值范围1～200。
EipAddress.BandwidthPackageId string 可选 示例值：bwp-2zeo05qre24nhrqpy****
共享带宽包的ID，表示将公网IP加入到共享带宽包。
- 您可以调用DescribeBandwidthPackages接口，查询共享带宽包的ID。
- 公网IP加入到共享带宽包必须同时满足如下条件：
- 二者的安全防护类型相同。
- 二者的地域相同。
- 公网IP的计费方式必须是按量计费。
- 共享带宽包为IPv4类型。
EipAddress.ChargeType string 可选 示例值：PayByBandwidth
公网IP的计费方式，取值：
- PayByBandwidth（默认）：按量计费-按带宽上限计费。
- PayByTraffic：按量计费-按实际流量计费。
- PrePaid：包年包月。
说明
实例的计费类型InstanceChargeType取值为PostPaid时，该参数取值不能为PrePaid。
EipAddress.ISP string 可选 示例值：BGP
公网IP的线路类型，默认为BGP。取值：
- BGP：BGP（多线）。
- 若您的账号已申请并开通了静态单线权限，则可传入如下取值：
- ChinaMobile：中国移动静态单线。
- ChinaTelecom：中国电信静态单线。
- ChinaUnicom：中国联通静态单线。
- 若您的账号已申请并开通了BGP单线权限，则可传入SingleLine_BGP。
- 若您的账号已申请并开通了静态BGP权限，则可传入Static_BGP。
EipAddress.ReleaseWithInstance boolean 可选 示例值：false
公网IP是否随实例删除，取值：
- true：公网IP随实例删除。
- false（默认）：公网IP不随实例删除。
EipAddress.SecurityProtectionInstanceId integer 可选 示例值：20
DDoS原生防护（企业版）ID。
- 您可以调用DescInstanceList接口，查询DDoS原生防护（企业版）的ID。
- 当SecurityProtectionTypes传入AntiDDoS_Enhanced时，此参数必须传入。
EipAddress.SecurityProtectionTypes.N string[] 可选 示例值：SecurityProtectionTypes.1 =AntiDDoS_Enhanced
公网IP的安全防护类型。
- 参数 - N：表示安全防护类型的序号，当前仅支持取1。
- 取值：
- AntiDDoS_Enhanced：申请增强防护类型的公网IP，可加入到DDoS原生防护（企业版）实例。
说明
- 若EipAddress.SecurityProtectionTypes.N传入AntiDDoS_Enhanced，则EipAddress.ChargeType不能为PrePaid，且EipAddress.ISP必须传入BGP。
- 增强防护类型公网IP正在邀测中，如需试用，请联系客户经理申请。
- 不填则表示申请默认防护类型的公网IP。
ElasticScheduledInstanceType string 可选 示例值：Esi
弹性预约实例类型，取值：
- Esi（默认）：弹性预约实例
- Segmented：弹性预约实例-时段型
说明
弹性预约实例-时段型正在邀测中，如需试用，请联系客户经理申请。
EndDeliveryAt string 可选 示例值：2023-03-29T18:10:00+08:00
实例结束交付时间，必须为10分钟整点，且与StartDeliveryAt的间隔时间为10分钟。
- ElasticScheduledInstanceType取值为Esi时，实例结束交付时间为预约后的4～8小时范围内。
- ElasticScheduledInstanceType取值为Segmented时：
- 若DeliveryType为Reserve，实例结束交付时间为预约后的24小时内。
- 若DeliveryType为Immediate，无需传入该参数。
Hostname string 可选 示例值：instance-host-name
实例主机名，即实例操作系统内部的计算机名。
- Linux实例：
- 允许使用字母、数字、点号“.”或中划线“-”。
- 不能以中划线、点号开头或结尾，且不能连续使用中划线和点号。
- Linux系统长度限制在2～63个字符之间。
- Windows实例：
- 允许使用字母、数字或中划线“-”，不能完全是数字。
- 不能以中划线开头或结尾，且不能连续使用中划线。
- Windows系统长度限制在2～15个字符之间。
说明
- 如不填，则遵循 iv- + 初始主机名 规则自动生成，例如
- iv-3tigy72q3u3vj0******。
- 初始主机名生成逻辑：
- Linux：提取实例IDi-之后的全部字符。
- Windows：提取实例IDi-之后的后12位字符。
- 批量创建实例时，支持使用name_prefix[begin_number,bits]name_suffix格式自定义设置有序主机名，具体操作请参见批量设置有序的实例名称或主机名称。
HpcClusterId string 可选 示例值：hpcCluster-l8u24ovdmoab6opf****
当创建高性能计算GPU型实例时，请指定高性能计算集群ID。
HttpTokens string 可选 示例值：optional
实例元数据的访问模式，是否强制使用加固模式。取值：
- optional（默认）：不强制使用（兼容模式），指既可以通过普通方式直接访问实例元数据，也可以通过基于token鉴权的加固方式进行访问。
- required：强制使用（仅加固模式），即仅支持基于token鉴权的加固方式访问实例元数据。
InstallRunCommandAgent boolean 可选 示例值：false
创建实例时是否安装云助手Agent，取值：
- true：创建时安装。
- false（默认）：创建时不安装。
说明
InstanceName string 必选 示例值：instance-test
实例的名称。
- 以字母或中文开头。
- 只能包含中文、字母、数字、下划线“_”、中划线“-”和点号“.”。
- 长度限制为1～128个字符。
说明
- 若实例已设置SuffixIndex有序后缀，则实例名称长度包含有序后缀。
- 批量创建实例时，支持使用name_prefix[begin_number,bits]name_suffix格式自定义设置有序实例名称，具体操作请参见批量设置有序的实例名称或主机名称。
InstanceTypeId string 必选 示例值：ecs.g1ie.xlarge
实例规格。
- 支持预约购买的实例规格请参见弹性预约实例概述。
- 您可以调用DescribeAvailableResource查询可用区中计算资源的库存信息。
KeepImageCredential boolean 可选 示例值：true
是否保留镜像设置，取值：
- true：保留镜像设置，保留后将使用镜像预设的密码或密钥对登录实例。
- false（默认）：不保留镜像设置。
说明
- 仅自定义镜像、共享镜像支持该功能。
- 该参数取值为true时，请勿传入PassWord和KeyPairName。
KeyPairName string 可选 示例值：kp-test-123
如需使用“SSH密钥”方式登录实例，请指定已创建密钥对的名称。
说明
- Windows实例不支持SSH密钥方式，即使传入了该参数，仍旧只生效密码Password。
- Linux实例支持密码或密钥对登录。调用该接口时如果同时设置了密钥对KeyPairName和密码Password，则仅生效密钥对KeyPairName。
MinCount integer 可选 示例值：2
指定弹性预约实例最小创建数量，取值范围：
- ESI-通用型、ESI-时段型（预约交付）：1～500
- ESI-时段型（立即交付）：1～100
说明
- 实例最小创建数量MinCount ≤ 创建数量Count。
- 当库存数量 > 创建数量Count，按Count创建。
- 当最小创建数量MinCount ≤ 库存数量 ≤ 创建数量Count，按库存数量创建。
- 当库存数量 < 最小创建数量MinCount，会因库存不足而创建失败。
NetworkInterfaces.N.SecurityGroupIds.N string[] 必选 示例值：NetworkInterfaces.1.SecurityGroupIds.1=sg-3ti78x9h8t4bw*****& NetworkInterfaces.2.SecurityGroupIds.1=sg-3cj59ih2v9hj46c6rr******
网卡关联的安全组ID。
- 第一个N：表示网卡的序号，N = 1表示主网卡；N ≥ 2表示辅助网卡。
- 第二个N：表示网卡关联的安全组的序号，取值范围：1～5。
- 多个安全组ID之间用&分隔。
NetworkInterfaces.N.SubnetId string[] 必选 示例值：NetworkInterfaces.1.SubnetId=subnet-3tispp1nai4e8i******& NetworkInterfaces.2.SubnetId=subnet-2ff1nczrx2lts5oxru******
实例的私有网络子网ID，创建实例时，支持同时绑定辅助网卡。
- 参数 - N：表示网卡的序号，N = 1表示主网卡；N ≥ 2表示辅助网卡。
- 多个私有网络子网ID之间用&分隔。
NetworkInterfaces.N.PrimaryIpAddress string[] 可选 示例值：NetworkInterfaces.1.PrimaryIpAddress=192.168.XX.XX
指定网卡的主IP地址，当前仅支持为主网卡或辅助网卡指定一个主IP地址。
- 参数 - N：表示网卡的序号，N = 1表示主网卡；N ≥ 2表示辅助网卡。
- 多个网卡之间用&分隔。
NetworkInterfaces.N.PrivateIpAddresses.N string[] 可选 示例值：NetworkInterfaces.1.PrivateIpAddresses.1=172.16.XX.XX&NetworkInterfaces.1.PrivateIpAddresses.2=172.16.XX.XX
指定主网卡的辅助IP地址，当前只支持主网卡指定辅助IP。
- 第一个N：表示主网卡的序号，当前仅支持绑定一张主网卡。
- 第二个N：表示主网卡的辅助IP序号，最多可分配的辅助IP地址的数量为该实例规格的单网卡私有IP数减去一个主私网IP。
- 多个辅助IP之间用&分隔。
Password string 可选 示例值：password@123
如需使用“密码”方式登录实例，请通过该参数指定实例的管理员账号初始登录密码。其中Linux管理员账号为root，Windows管理员账号为Administrator。
密码复杂度要求如下：
- 长度限制在8～30之间。
- 密码只能由大写字母、小写字母、数字和特殊字符组成，且必须包含至少三项。
- 特殊字符可以使用：`~!@#$%^&*()_-+=|{}[]:;'<>,.?/
- 不能以“/”和“$6$”开头。
说明
登录凭证支持“密码”、“密钥对”、“保留镜像设置”三种方式，使用“密码”方式登录实例时，建议增加密码复杂度以提高安全性。
ProjectName string 可选 示例值：project_a
资源所属项目，一个资源只能归属于一个项目。
- 只能包含字母、数字、下划线“_”、点“.”和中划线“-”。
- 长度限制在64个字符以内。
ScheduledInstanceDescription string 可选 示例值：ScheduledInstance for testing.
弹性预约单的描述，默认值为空字符串。
- 必须以字母或中文开头。
- 只能包含中文、字母、数字、点“.”、空格、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、中文逗号“，”和中文句号“。”
- 长度限制在255个字符以内。
ScheduledInstanceName string 必选 示例值：ESI-Name
弹性预约单的名称，取值：
- 不能以数字、中划线、下划线开头。
- 只能包含中文、字母、数字、下划线和中划线。
- 长度限制为1～128个字符。
- 暂不支持特殊字符。
SecurityEnhancementStrategy string 可选 示例值：Active
是否开启安全加固，取值：
- Active：开启安全加固，仅对公共镜像生效。
- InActive：关闭安全加固，对所有镜像类型生效。
StartDeliveryAt string 可选 示例值：2023-03-29T17:50:00+08:00
实例开始交付时间，必须为10分钟整点。
- ElasticScheduledInstanceType取值为Esi时，实例交付时间为预约后的4～8小时范围内。
- 若DeliveryType为Reserve，实例交付时间为预约后的24小时内。
- DeliveryType为Immediate，无需传入该参数。
SuffixIndex integer 可选 示例值：1
有序后缀的起始序号，取值范围：1～999，默认值为1。
Tags.N.Key string[] 可选 示例值：Tags.1.Key=k1&Tags.2.Key=k2
用户标签的标签键。
- 参数 - N：表示标签键的序号，取值范围：1～20。
- 多个标签键之间用&分隔。
- 命名规则如下：
- 不能以volc:或sys:的任意大小写组合开头。
- 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。
- 长度限制在1～128个字符之间。
说明
同一资源的标签键不允许重复。
Tags.N.Value string[] 可选 示例值：Tags.1.Value=v1&Tags.2.Value=v2
用户标签的标签值。
- 参数 - N：表示标签值的序号，取值范围：1～20。
- 多个标签值之间用&分隔。
- 命名规则如下：
- 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。
- 允许为空，长度限制在0～256个字符之间。
说明
如果传入该参数，则必须先传入Tags.N.Key。
UniqueSuffix boolean 可选 示例值：false
表示当创建多台实例时，是否为Hostname和InstanceName自动添加有序后缀，取值：
- true：开启有序后缀。
- false（默认）：关闭有序后缀。
说明
- 开启有序后缀时，若Hostname为空，系统将自动生成主机名，主机名后无有序后缀。
- 开启有序后缀时，若为Hostname、InstanceName指定了[begin_number,bits]命名格式，则最终生效情况请参见批量设置有序的实例名称或主机名称。
UserData string 可选 示例值：ZWNobyBoZWxsbyBlY3Mh
实例自定义数据。设置的自定义数据必须经过Base64编码，且Base64编码前的自定义数据大小不能超过16KB。
不填则默认为空。
Volumes.N.Size integer[] 必选 示例值：Volumes.1.Size=100&Volumes.2.Size=100
云盘的容量，单位为GiB。N的取值范围1～16，N = 1表示系统盘，N ≥ 2表示数据盘。多个云盘之间用&分隔。
云盘容量的取值范围：
- 系统盘：
- ESSD_PL0：20～2048
- ESSD_FlexPL：20～2048
说明
默认值：max{40 ，ImageId对应的镜像容量}。
- 数据盘：
- ESSD_PL0：10～32768
- ESSD_FlexPL：10～32768
说明
如果不传入该参数，则使用Volumes.N.SnapshotId对应的快照大小作为数据盘的容量大小。若未传入Volumes.N.SnapshotId，则报错LimitExceeded.DataVolumeSize。
Volumes.N.DeleteWithInstance boolean[] 可选 示例值：Volumes.1.DeleteWithInstance=true&Volumes.2.DeleteWithInstance=false
云盘是否随实例释放，取值：
- true（默认）：云盘随实例释放。
- false：云盘不随实例释放。
说明
- 参数 - N：表示云盘的序号，取值范围：1～16。N = 1表示系统盘，系统盘默认随实例释放，不可保留；N ≥ 2表示数据盘，可选择是否随实例释放。
- 多个云盘之间用&分隔。
Volumes.N.ExtraPerformanceIOPS integer[] 可选 示例值：Volumes.2.ExtraPerformanceIOPS=100
云盘额外IOPS性能大小，仅ESSD FlexPL数据盘支持，单位为次/秒。
ExtraPerformanceTypeId为Balance或IOPS时需设置该参数。各个类型的额外性能取值范围如下：
- IOPS型：1～50000。
- Balance型：1～50000。
说明
- 参数 - N：表示云盘的序号，取值范围：1～16。N = 1表示系统盘，故N传入1时，该参数将被忽略。N ≥ 2表示数据盘，可正常传入该参数。
- 多个云盘之间用&分隔。
Volumes.N.ExtraPerformanceThroughputMB integer[] 可选 示例值：Volumes.2.ExtraPerformanceThroughputMB=100
云盘额外吞吐性能大小，单位MB/s，仅ESSD FlexPL数据盘支持。
ExtraPerformanceTypeId为Throughput时需设置该参数。
取值范围：1～650。
说明
- 参数 - N：表示云盘的序号，取值范围：1～16。N = 1表示系统盘，故N传入1时，该参数将被忽略。N ≥ 2表示数据盘，可正常传入该参数。
- 多个云盘之间用&分隔。
Volumes.N.ExtraPerformanceTypeId string[] 可选 示例值：Volumes.2.ExtraPerformanceTypeId=IOPS
云盘额外性能的类型，仅ESSD FlexPL数据盘支持。取值：
- Balance：均衡型额外性能。
- IOPS：IOPS型额外性能。
- Throughput：吞吐量型额外性能。
- 关于额外性能的更多介绍，请参见云盘额外性能。
说明
- 参数 - N：表示云盘的序号，取值范围：1～16。N = 1表示系统盘，故N传入1时，该参数将被忽略。N ≥ 2表示数据盘，可正常传入该参数。
- 多个云盘之间用&分隔。
Volumes.N.SnapshotId string[] 可选 示例值：Volumes.1.SnapshotId=snap-31akybwsxi8rudc6****&Volumes.2.SnapshotId=snap-31ak39j5bh8rubsn****
- 参数 - N：表示云盘的序号，取值范围：1～16。N = 1表示系统盘，故N传入1时，该参数将被忽略。N ≥ 2表示数据盘，可正常传入目标数据盘快照ID。
- 多个云盘之间用&分隔。
说明
- 仅极速型SSD支持通过快照创建云盘，性能型SSD不支持快照相关功能。
- 仅状态为“可用”的快照支持创建新云盘，“创建中”、“回滚中”、“删除中”及“错误”状态下的快照不支持创建新云盘。
Volumes.N.VolumeType string[] 可选 示例值：Volumes.1.VolumeType=ESSD_PL0&Volumes.2.VolumeType=ESSD_PL0
云盘的类型，取值：
- ESSD_PL0：极速型SSD PL0
- ESSD_FlexPL：极速型SSD FlexPL
说明
- 参数 - N：表示云盘的序号，取值范围：1～16。N = 1表示系统盘，N ≥ 2表示数据盘。
- 多个云盘之间用&分隔。
返回参数
ScheduledInstanceId string 示例值：esi-ycvw0gtwjql8j1c3****
弹性预约单ID。
请求示例
返回示例
错误码
最近更新时间：2026.05.13 10:11:34
这个页面对您有帮助吗？
有用
有用
无用
无用