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

请求参数

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

系统规定参数。取值：CreateInstance。
Parameter.N.Code String 是 InstanceType

第N个模块属性Code配置，如有多个模块属性参数，按照N=0,1,2,3…N的形式拼接多个参数。

该参数需与Parameter.N.Value一起使用，消息队列RabbitMQ版创建实例还需要配置更多属性，请参见配置Parameter.N.Code参数。

Parameter.N.Value String 是 professional

第N个模块属性Code对应的Value，如有多个模块属性参数，按照N=0,1,2,3…N的形式拼接多个参数。
ProductCode String 是 ons 产品代码，固定为：ons。
ProductType String 是 ons_onsproxy_public_intl 产品类型，固定为：ons_onsproxy_public_intl。
SubscriptionType String 是 Subscription
付费类型，取值如下：
  • Subscription：预付费
  • PayAsYouGo：后付费

消息队列RabbitMQ版实例不再支持按量付费模式，即该参数只能为Subscription。

RenewalStatus String 否 AutoRenewal

续费方式，取值如下：

  • AutoRenewal：自动续费
  • ManualRenewal：手动续费
RenewPeriod Integer 否 1

自动续费周期， 单位：月。

说明 当RenewalStatus取值为AutoRenewal时，该参数必须设置。
Period Integer 否 1

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

说明 当创建预付费实例时，必须设置。
Logistics String 否 不涉及

物流信息。创建消息队列RabbitMQ版实例时不涉及，您无需填写该参数。

ClientToken String 否 JASIOFKVNVIXXXXXX

客户端幂等参数，服务端会查询是否有相同ClientToken的请求，如果有，直接返回上次调用结果。
表 1. 配置Parameter.N.Code参数
参数 取值 是否必选 描述
Parameter.0.Code InstanceType 否 配置实例规格类型。Parameter.0.Value取值如下：
  • professional：专业版
  • enterprise：企业版
  • vip：铂金版
Parameter.1.Code Region 是 配置实例所属地域。Parameter.1.Value取值为所支持的地域，例如cn-shenzhen。
Parameter.2.Code SupportEip 是 配置实例是否支持公网。Parameter.2.Value取值如下：
  • eip_true：支持
  • eip_false：不支持
Parameter.3.Code MaxEipTps 是 配置公网TPS流量峰值。如何配置Parameter.3.Value，请根据消息队列RabbitMQ版控制台购买页所给出的取值设置。
Parameter.4.Code MaxTps 是 配置私网TPS流量峰值。如何配置Parameter.4.Value，请根据消息队列RabbitMQ版控制台购买页所给出的取值设置。
Parameter.5.Code QueueCapacity 是 配置Queue的数量上限。Parameter.5.Value的取值范围如下：
  • 专业版：[50,1000]，最小修改步长为5。
  • 企业版：[200,6000]，最小修改步长为100。
  • 铂金版：[10000,80000]，最小修改步长为100。
单位：个。
Parameter.6.Code OrderNum 是 配置创建实例的数量。Parameter.6.Value取值范围为[1,9999]，单位：个。
Parameter.7.Code StorageSize 是 配置消息存储空间。Parameter.7.Value取值如下：
  • 专业版实例和企业版实例：固定为200，单位： GB。
  • 铂金版实例：m×100，其中m的取值范围为[7,28]，单位：GB。
Parameter.8.Code SupportTracing 否 配置是否开通消息轨迹功能。Parameter.8.Value取值如下：
  • tracing_true：表示开通消息轨迹功能。
  • tracing_false：表示不开通消息轨迹功能。
重要
  • 铂金版实例免费提供15天消息轨迹功能，轨迹功能只能选择开启且轨迹保存时长只能设置为15天。
  • 其他规格类型实例可选择开启或关闭轨迹功能，关闭轨迹功能时，轨迹保存时长只能设置为0。
具体取值组合，请参见下文消息轨迹参数取值约束。
Parameter.9.Code TracingStorageTime 否 配置消息轨迹的保存时长。Parameter.9.Value取值如下：
  • 0
  • 3
  • 7
  • 15

单位：天。
表 2. 消息轨迹参数取值约束
InstanceType参数取值 SupportTracing参数取值 TracingStorageTime参数取值
  • professional
  • enterprise
 tracing_false 0
  • professional
  • enterprise
 tracing_true
  • 3
  • 7
  • 15
vip tracing_true 15

返回数据

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

状态码。
Data Struct

返回信息。
InstanceId String amqp-cn-zvp2ajsj****

订单对应的实例ID。
OrderId String 21014976059****

创建成功的订单ID。
Message String Successful！

提示信息。
RequestId String B62C712B-1789-5114-B0BB-80CB2AFD****

请求ID。
Success Boolean true

是否成功。

示例

请求示例

http(s)://business.aliyuncs.com/?Action=CreateInstance
&Parameter.0.Code=InstanceType
&Parameter.0.Value=professional
&Parameter.1.Code=Region
&Parameter.1.Value=cn-shenzhen
&Parameter.2.Code=SupportEip
&Parameter.2.Value=eip_true
&Parameter.3.Code=MaxEipTps
&Parameter.3.Value=640
&Parameter.4.Code=MaxTps
&Parameter.4.Value=1000
&Parameter.5.Code=QueueCapacity
&Parameter.5.Value=200
&Parameter.6.Code=StorageSize
&Parameter.6.Value=200
&Parameter.7.Code=OrderNum
&Parameter.7.Value=1
&Parameter.8.Code=SupportTracing
&Parameter.8.Value=tracing_true
&Parameter.9.Code=TracingStorageTime
&Parameter.9.Value=3
&ProductCode=ons
&ProductType=ons_onsproxy_public_intl
&SubscriptionType=Subscription
&Period=1
&RenewPeriod=1
&RenewalStatus=AutoRenewal
&<公共请求参数>

正常返回示例

XML 格式 

<CreateInstanceResponse>
      <RequestId>B62C712B-1789-5114-B0BB-80CB2AFD****</RequestId>
      <Message>Successful!</Message>
      <Data>
            <InstanceId>amqp-cn-zvp2ajsj****</InstanceId>
            <OrderId>21014976059****</OrderId>
      </Data>
      <Code>Success</Code>
      <Success>true</Success>
</CreateInstanceResponse>

JSON 格式 

{
  "RequestId": "B62C712B-1789-5114-B0BB-80CB2AFD****",
  "Message": "Successful!",
  "Data": {
    "InstanceId": "amqp-cn-zvp2ajsj****",
    "OrderId": 21014976059****
  },
  "Code": "Success",
  "Success": true
}

错误码

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