更新时间:2025-08-27 GMT+08:00
分享

实例开通接口

功能介绍

租户可以通过调用该接口生成实例。

该接口需要结合BatchShowSku接口一起使用,在BatchShowSku接口中获取全量的可售的sku。租户根据自己需要去选择相应规格进行订购。

调用该接口时如果想要直接购买成功,请您先在账户上充值并在订购参数中选择isAutoPay为自动付费。

如果没有选择自动付费,在调完接口后请拿对应的订单号去您账号的待支付订单中选择手动付费。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/instances/create

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

String

租户token

Content-Type

String

请求体的数据格式。默认填写“application/json”,表示请求体是JSON格式

表2 请求Body参数

参数

是否必选

参数类型

描述

os

String

创建实例的镜像规格,当前支持的场景下必填。枚举值,AOSP9:镜像9版本,AOSP11:镜像11版本

instanceSkuId

String

创建的实例商品规格id,在CBC定义,Console提供规格与资源池映射,最大长度64

bandSkuId

String

带宽商品规格id,在CBC定义,通用云终端及云应用时必填,最大长度64

regionId

String

区域id,最大长度64

instanceNamePrefix

String

云机实例名称前缀,最大长度14

bandSize

Double

带宽大小,单位M

count

Integer

购买实例数量,最大1500

chargeParam

chargeParam object

计费相关参数

network

String

网络线路

表3 chargeParam

参数

是否必选

参数类型

描述

chargingMode

Integer

计费模式。1:包年包月,当前只支持包年包月模式

periodType

Integer

订购周期类型。2:月,3:年

periodNum

Integer

订购周期数。当订购周期为月时,取值范围[1,9]。当订购周期为年时,取值范围[1,3]

isAutoPay

Integer

是否自动付款,默认不自动付款。0:不自动付款,1:自动付款

isAutoRenew

Integer

是否自动续订。0:非自动续订,1:自动续订

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

data object

返回内容

error_code

String

0 表示成功

error_msg

String

OK表示成功

表5 data

参数

参数类型

描述

orderId

String

订单id

instanceInfos

Array of instanceInfos objects

实例信息

表6 instanceInfos

参数

参数类型

描述

instanceId

String

实例id

instanceName

String

实例名称

请求示例

订购请求参数

/instances/create

{
  "os" : "AOSP9",
  "instanceSkuId" : "kp.professional.2xlarge.128g.2",
  "bandSkuId" : "kp.bandwidth",
  "regionId" : "cn-north-7",
  "instanceNamePrefix" : "koophone",
  "bandSize" : 4,
  "count" : 1,
  "chargeParam" : {
    "chargingMode" : 1,
    "periodType" : 2,
    "periodNum" : 1,
    "isAutoPay" : 1,
    "isAutoRenew" : 1
  },
  "network" : "EIP",
  "instanceType" : "specification",
  "sceneType" : "CLOUD_PHONE"
}

响应示例

状态码:200

实例订购返参

{
  "data" : {
    "orderId" : "CS2412261442DBN4E",
    "instanceInfos" : [ {
      "instanceId" : "11J6QVu5",
      "instanceName" : "koophone-00001"
    } ]
  },
  "error_code" : "0",
  "error_msg" : "OK"
}

状态码

状态码

描述

200

实例订购返参

错误码

请参见错误码

相关文档