文档

CreateGWSInstance - 创建一个可视化实例

更新时间:

调用CreateGWSInstance创建一个可视化实例。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ClusterIdstring

可视化服务集群 ID。

gws-rhzxpazwebua****
ImageIdstring

可视化服务镜像 ID。

ehs-faeid-****
SystemDiskSizeinteger

系统盘大小。单位:GiB

取值范围:20~500

20
SystemDiskCategorystring

系统盘类型。取值范围:

  • cloud_efficiency:高效云盘
  • cloud_ssd:SSD 云盘
  • cloud_essd:ESSD 云盘
  • cloud:普通云盘
cloud
InstanceTypestring

可视化实例规格。

ecs.g6.large
InstanceChargeTypestring

可视化实例计费方式,不能为抢占式实例。

  • PostPaid:按量付费
  • PrePaid:包年包月

默认值:PostPaid

PostPaid
WorkModestring

实例工作模式。取值范围:

  • Desktop:桌面模式
  • Application:应用模式
Desktop
AllocatePublicAddressboolean

是否分配公网地址。取值范围:

  • true:分配
  • false:不分配

默认值:false

false
InternetChargeTypestring

公网带宽计费方式。取值范围:

  • PayByBandwidth:按固定带宽计费。
  • PayByTraffic:按使用流量计费。

默认值:PayByTraffic

PayByTraffic
InternetMaxBandwidthIninteger

公网入带宽最大值。单位为 Mbit/s。取值范围:

  • 当所购出网带宽小于等于 10 Mbit/s 时:1~10。默认值:10
  • 当所购出网带宽大于 10 Mbit/s 时:1~InternetMaxBandwidthOut 的取值,默认为 InternetMaxBandwidthOut 的取值。
122
InternetMaxBandwidthOutinteger

公网出带宽最大值。单位:Mbit/s

取值范围:0~100

默认值:0

122
Namestring

可视化实例名称。

Test-ehpc
Periodstring

购买资源的时长。单位由 PeriodUnit 指定。当 InstanceChargeType 取值为 PrePaid 时才生效,且为必选值。

  • 如果 PeriodUnit 为 Month,该参数的取值范围:{“1”, “2”, “3”, “6”}。
  • 如果 PeriodUnit 为 Year,该参数的取值范围:{“1”, “2”, “3”, “4”, “5”}。
1
PeriodUnitstring

购买资源的时长单位。取值范围:

  • Month:月
  • Year:年
Month
AutoRenewboolean

是否自动续费。取值范围:

  • true:是
  • false:否

默认值:false

false
AppListstring

应用程序列表。WorkMode 选择为 Application 时必选。包含如下信息:

  • AppName:应用名称。
  • AppPath:应用运行路径。
  • AppArgs:应用运行参数。
[{AppName: notepad},{AppArgs:c:/temp.txt}]
VSwitchIdstring

交换机 ID。

vsw-bp1gb5gf5546rn****

返回参数

名称类型描述示例值
object
InstanceIdstring

可视化实例 ID。

i-bp1bzqddeemudsdsdsdsdn****
RequestIdstring

请求 ID。

5198C3E8-85F5-4280-8547-687C1710FE08

示例

正常返回示例

JSON格式

{
  "InstanceId": "i-bp1bzqddeemudsdsdsdsdn****",
  "RequestId": "5198C3E8-85F5-4280-8547-687C1710FE08"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe specified parameter %s is invalid.无效的参数:%s
406AliyunErrorAn Alibaba Cloud product error occurred.阿里云产品错误
407NotAuthorizedYou are not authorized by RAM for this request.此请求未获得RAM授权
409PartFailurePart of the batch operation failed.批量操作部分失败
500UnknownErrorAn unknown error occurred.未知错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

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

  • 本页导读 (1)
文档反馈