调用CreateInstance创建一个实例资源_云消息队列 RabbitMQ 版( RabbitMQ)-阿里云帮助中心

创建云消息队列RabbitMQ的实例。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CreateInstance	系统规定参数。取值：CreateInstance。
ClientToken	String	否	c2c5d1274axxxxxxxx	客户端Token。
PaymentType	String	是	Subscription	付费类型，取值如下： Subscription：预付费 PayAsYouGo ：后付费（即 Serverless）
Period	Integer	否	1	预付费周期，单位：periodCycle。说明当 PaymentType 为 Subscription 时，该参数有效，默认值为1。
PeriodCycle	String	否	Month	预付费周期单位，取值如下： Month：月 Year：年当PaymentType为Subscription时，该参数有效，默认值为Month。
AutoRenew	Boolean	否	false	续费方式，取值如下： true：自动续费 false：手动续费
AutoRenewPeriod	Integer	否	1	自动续费周期，单位 RenewalDurationUnit 值，默认为：月。说明当 AutoRenew 为 true 时，该参数有效，默认值为1 。
RenewStatus	String	否	false	续费状态,等同于 autoRenew ，二选1 配置即可，取值如下： AutoRenewal: 自动续费说明和renewStatus都是续费方式，当两个同时填写时，以renewStatus为准
RenewalDurationUnit	String	否	Month	自动续费周期单位，取值如下： Month：月 Year：年
InstanceType	String	否	professional	实例规格类型，预付费类型的取值如下： professional：专业版 enterprise：企业版 vip：铂金版后付费实例：无需填写
ServerlessChargeType	String	否	onDemand	后付费（即 Serverless）实例的计费类型，取值如下： onDemand：按量累计
InstanceName	String	否	amqp-xxxxx	实例名称。建议长度不超过64个字符。
MaxPrivateTps	Long	否	1000	私网TPS流量，单位：次/秒。请根据 “云消息队列 RabbitMQ 版-购买页” 所给出的取值设置。
SupportEip	Boolean	否	true	是否支持公网，取值如下： true：支持公网 false：不支持公网
MaxEipTps	Long	否	128	公网网TPS流量峰值，单位：TPS。请根据 “云消息队列 RabbitMQ 版-购买页” 所给出的取值设置。
QueueCapacity	Integer	否	1000	配置Queue的数量，单位：个。请根据 “云消息队列 RabbitMQ 版-购买页” 所给出的取值设置。
MaxConnections	Integer	否	50000	最大连接数。请根据 “云消息队列 RabbitMQ 版-购买页” 所给出的取值设置。
StorageSize	Integer	否	7	配置消息存储空间，单位： GB，取值如下：专业版实例和企业版实例：固定为0。说明取值为0表示专业版和企业版实例不收取存储费用，而非没有存储空间。铂金版实例：m×100，其中m的取值范围为[7,28]。
SupportTracing	Boolean	否	true	是否开通消息轨迹功能，取值如下： true：开通消息轨迹功能 false：不开通消息轨迹功能说明铂金版实例免费提供15天消息轨迹功能，轨迹功能只能选择开启且轨迹保存时长只能设置为15天。其他规格类型实例可选择开启或关闭轨迹功能。
TracingStorageTime	Integer	否	3	配置消息轨迹的保存时长，单位：天，取值如下： 3：3天 7：7天 15：15天当SupportTracing为true时，该参数有效。

返回数据

名称	类型	示例值	描述
RequestId	String	CCBB1225-C392-480E-8C7F-D09AB2CD2***	公共参数，每个请求的ID都是唯一的，可用于排查和定位问题。
Code	Integer	200	返回码。返回200代表成功。
Message	String	xxx failed,xxxx	返回信息。
Data	Any	amqp-cn-xxxxx	返回已创建实例的ID
Success	Boolean	true	请求是否成功。

示例

预付费系列实例入参示例

当实例类型为预付费时，PaymentType=Subscription，需要传入的参数如下所示。

&PaymentType=Subscription
&AutoRenew=true
&AutoRenewPeriod=1
&Period=1
&PeriodCycle=Month
&InstanceType=professional
&MaxPrivateTps=1000
&SupportEip=true
&MaxEipTps=128
&QueueCapacity=1000
&MaxConnections=50000
&StorageSize=7
&SupportTracing=true
&TracingStorageTime=3
&公共请求参数

预付费实例中，消息轨迹取值限制如下：

InstanceType	SupportTracing	TracingStorageTime
professional enterprise	false	0
professional enterprise	true	3 7 15
vip	true	15

Serverless系列实例入参示例

当实例类型为Serverless时，PaymentType=PayAsYouGo，需要传入的参数如下所示。

&PaymentType=PayAsYouGo
&ServerlessChargeType=onDemand
&SupportEip=true
&SupportTracing=true
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateInstanceResponse>
    <RequestId>CCBB1225-C392-480E-8C7F-D09AB2CD2***</RequestId>
    <Code>200</Code>
    <Message>xxx failed,xxxx</Message>
    <Data>amqp-cn-xxxxx</Data>
    <Success>true</Success>
</CreateInstanceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CCBB1225-C392-480E-8C7F-D09AB2CD2***",
  "Code" : 200,
  "Message" : "xxx failed,xxxx",
  "Data" : "amqp-cn-xxxxx",
  "Success" : true
}

错误码

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