调用CreateInstance创建一个实例资源,调用接口会创建一个新购实例资源的订单,并自动支付。

调试

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

请求参数

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

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

Parameter.N.Code String InstanceType

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

Parameter.N.Value String disk

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

ProductCode String rds

产品代码。

SubscriptionType String Subscription

付费类型,取值:

  • Subscription:预付费。
  • PayAsYouGo:后付费。
ProductType String rds

产品类型。

RenewPeriod Integer 12

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

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

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

说明 当创建预付费实例时,必须设置。
RenewalStatus String ManualRenewal

自动续费状态,取值:

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

默认ManualRenewal。

ClientToken String JASIOFKVNVIXXXXXX

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

返回数据

名称 类型 示例值 描述
Code String Success

状态码。

Data Struct

返回信息。

InstanceId String OSSBAG-cn-v1hxxxxx23

订单对应的实例ID。

OrderId String 20240xxxx21

创建成功的订单ID。

Message String Successful!

错误信息。

RequestId String C880B065-A781-4F19-B6DD-3E0E3B715C64

请求ID。

Success Boolean true

是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateInstance
&Parameter.1.Code=InstanceType
&Parameter.1.Value=disk
&ProductCode=rds
&SubscriptionType=Subscription
&<公共请求参数>

正常返回示例

XML 格式

<CreateInstanceResponse>
      <Message>Successful!</Message>
      <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>
      <Success>true</Success>
      <Code>Success</Code>
      <Data>
            <InstanceId>OSSBAG-cn-v1hxxxxx23</InstanceId>
            <OrderId>20240xxxx21</OrderId>
      </Data>
</CreateInstanceResponse>

JSON 格式

{
	"Message": "Successful!",
	"RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
	"Success": true,
	"Code": "Success",
	"Data": {
		"InstanceId": "OSSBAG-cn-v1hxxxxx23",
		"OrderId": "20240xxxx21"
	}
}

错误码

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