全部產品
Search
文件中心

:CreateInstance

更新時間:Jun 30, 2024

建立雲訊息佇列RabbitMQ的執行個體。

請求參數

名稱

類型

是否必選

樣本值

描述

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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。