文档

CreateInstance - 实例创建服务

更新时间:
一键部署

创建一个实例资源,会创建一个新购实例资源的订单,并自动支付。不支持ECS和RDS系列产品的创建。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
bssapi:CreateInstanceWrite
  • 全部资源
    acs:bssapi:*:*:*
  • bssapi:ProductCode
  • bssapi:ProductType

请求参数

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

产品代码。可通过接口 QueryProductList 查询产品代码

rds
ProductTypestring

产品类型。

rds
SubscriptionTypestring

付费类型,取值:

  • Subscription:预付费。
  • PayAsYouGo:后付费。
Subscription
Periodinteger

预付费周期。单位为月,按年付费产品请输入 12 的整数倍。

说明 当创建预付费实例时,必须设置。
12
RenewalStatusstring

自动续费状态,取值:

  • AutoRenewal:自动续费。
  • ManualRenewal:手动续费。

默认 ManualRenewal。

ManualRenewal
RenewPeriodinteger

自动续费周期, 单位为月。

说明 当设置 RenewalStatusAutoRenewal 时,必须设置。
12
ClientTokenstring

客户端幂等参数,服务端会查询是否有相同 ClientToken 的请求,如果有,直接返回上次调用结果。

JASIOFKVNVIXXXXXX
Logisticsstring

本次订单的物流信息地址,一般对实物类订单有效

{"cityCode":"330100","cityName":"杭州","contactName":"测试","countryCode":"","districtName":"浦沿街道","email":"**@example.com","mobilePhone":"153564848844","phone":"1234567","provCode":"330000","provName":"浙江省","streetCode":"33010610","streetName":"转塘","zipCode":"0000"}
Parameterobject []

模块列表

Valuestring

第 n 个模块属性 value 配置,n 的取值范围为(1~100)。

disk
Codestring

第 n 个模块属性 code 配置,n 的取值范围为(1~100),如有多个模块属性参数,按照 n=1,2,3…n 的形式拼接多个参数。

InstanceType

返回参数

名称类型描述示例值
object
Codestring

状态码。

Success
Messagestring

错误信息。

Successful!
RequestIdstring

请求 ID。

C880B065-A781-4F19-B6DD-3E0E3B715C64
Successboolean

是否成功。

true
Dataobject

返回信息。

OrderIdstring

创建成功的订单 ID。

20240xxxx21
InstanceIdstring

订单对应的实例 ID。

OSSBAG-cn-v1hxxxxx23

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "C880B065-A781-4F19-B6DD-3E0E3B715C64",
  "Success": true,
  "Data": {
    "OrderId": "20240xxxx21",
    "InstanceId": "OSSBAG-cn-v1hxxxxx23"
  }
}

错误码

HTTP status code错误码错误信息描述
200INSUFFICIENT.AVAILABLE.QUOTAThe account balance is negative. Add funds to the account and try again.您的账户可用额度小于0,请先充值后再尝试购买
400InvalidOwnerThe specified owner doesn't belong to caller.用户身份错误
400ORDER.ACCOUNT_STATUS_ILLEGALPlease complete your basic personal information first.-
400400Failure to check order before create instance.-
400ORDER.ACCOUNT_INFORMATION_INCOMPLETEYour information is incomplete. Complete your information before ordering-
500InternalErrorThe request processing has failed due to some unknown error.内部服务器错误。

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

变更历史

变更时间变更内容概要操作
2023-08-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
    新增错误码:200

创建成功后,可以使用实例查询服务,查询已创建的实例

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