创建实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateInstance

系统规定参数。取值:CreateInstance。

ClusterId String gws-xxx

集群 id

ImageId String m-xxx

镜像 id

InstanceType String ecs.g6.large

实例规格,请参见 实例规格族 或调用 DescribeInstanceTypes 获得规格表。

SystemDiskCategory String cloud_ssd

系统盘的种类:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD云盘。
  • cloud_essd:ESSD 云盘。(只有较新规格族的实例,例如 ecs.g6 系统,才支持 ESSD 云盘)
SystemDiskSize Integer 100

系统盘大小,单位为 GB。

  • 取值范围 20~500。
  • 选取不同镜像时,要求系统盘大小 >= 镜像的大小。
WorkMode String Desktop

工作模式:

  • Desktop:桌面模式。
  • Application:应用模式。
VSwitchId String vsw-xxx

VSwitch id。当不指定时,后台会根据当前实例类型,找到有库存的最新可用区(例如华北 2 可用区 G ),如果此可用区

  • 已有交换机,则直接选用
  • 没有交换机,则会尝试自动创建
Name String desktop-xxx

实例名称。

AllocatePublicAddress String true

是否分配公网地址

  • True
  • False
InternetChargeType String PayByBandwidth
说明 此值只在 AllocatePublicAddresstrue 时有效

网络计费类型。取值范围:

  • PayByTraffic(默认):按使用流量计费
  • PayByBandwidth:按固定带宽计费
InternetMaxBandwidthIn Integer 4
说明 此值只在 AllocatePublicAddresstrue 时有效

公网入带宽最大值,单位为 Mbps

  • 取值范围 1~100
  • 默认值:4
InternetMaxBandwidthOut Integer 4
说明 此值只在 AllocatePublicAddresstrue 时有效

公网出带宽最大值,单位为 Mbps

  • 取值范围 1~100
  • 默认值:4
InstanceChargeType String PostPaid

实例付费方式:

  • PostPaid(默认):按量付费
  • PrePaid:包年包月
AutoRenew String True

自动续费:

  • False(默认)
  • True
Period Integer 1
说明 此值仅在 InstanceChargeTypePrePaid(包年包月)时有效。

包年包月的时长。

  • PeriodUnitWeek(周)时,取值范围 1~4
  • PeriodUnitMonth(月)时,取值范围 1 2 3 4 5 6 7 8 9 12 24 36 48 60
PeriodUnit String Week
说明 此值仅在 InstanceChargeTypePrePaid(包年包月)时有效。

包年包月的单位。

  • Week
  • Month
AppList.N.AppName String notepad
说明 此值仅在 WorkModeApplication 时有效。

应用名称。其中 AppList.N 的允许范围是 1~10。

AppList.N.AppPath String C:\Windows\System32\notepad.exe
说明 此值仅在 WorkModeApplication 时有效。

应用的运行路径。其中 AppList.N 的允许范围是 1~10。

AppList.N.AppArgs String c:/temp.txt
说明 此值仅在 WorkModeApplication 时有效。

应用的运行参数。其中 AppList.N 的允许范围是 1~10。

返回数据

名称 类型 示例值 描述
InstanceId String i-xxx

实例 id

RequestId String XXX-XXX

请求 id

示例

请求示例

http(s)://[Endpoint]/?Action=CreateInstance
&ClusterId=gws-xxx
&ImageId=m-xxx
&InstanceType=ecs.g6.large
&SystemDiskCategory=cloud_ssd
&SystemDiskSize=100
&WorkMode=Desktop
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>XXX-XXX</RequestId>
<InstanceId>i-xxx</InstanceId>

JSON 格式

{"RequestId":"XXX-XXX","InstanceId":"i-xxx"}

错误码

访问错误中心查看更多错误码。