全部產品
Search

搜尋本產品

    ApsaraMQ for RabbitMQ：CreateInstance

    文件中心

    ApsaraMQ for RabbitMQ：CreateInstance

    更新時間：Aug 04, 2026

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

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    amqp:CreateInstance

    create

    *All Resource

    *
    • amqp:InstanceType
    • amqp:SupportEIP
    • amqp:ServerlessChargeType
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ClientToken

    string

    否

    用戶端 Token。

    c2c5d1274axxxxxxxx
    PaymentType

    string

    是

    付費類型，取值如下：

    枚舉值：

    • PayAsYouGo :

      PayAsYouGo

    • Subscription :

      Subscription

    Subscription
    Period

    integer

    否

    預付費週期，單位：periodCycle。

    1
    PeriodCycle

    string

    否

    預付費週期單位，取值如下：

    枚舉值：

    • Month :

      Month

    • Year :

      Year

    Month
    AutoRenew

    boolean

    否

    續約方式，取值如下：

    false
    AutoRenewPeriod

    integer

    否

    自動續約週期，單位為 RenewalDurationUnit 值，預設為：月。

    1
    RenewStatus

    string

    否

    續約狀態，等同於 autoRenew，二選一設定即可，取值如下：

    false
    RenewalDurationUnit

    string

    否

    自動續約週期單位，取值如下：

    枚舉值：

    • Month :

      Month

    • Year :

      Year

    Month
    InstanceType

    string

    否

    執行個體規格類型，

    枚舉值：

    • enterprise :

      enterprise

    • vip :

      vip

    • professional :

      professional

    professional
    ServerlessChargeType

    string

    否

    Serverless 系列執行個體的計費類型，取值如下：

    onDemand
    InstanceName

    string

    否

    執行個體名稱。建議長度不超過 64 個字元。

    amqp-xxxxx
    MaxPrivateTps

    integer

    否

    私有網路 TPS 流量，單位：次/秒。

    1000
    SupportEip

    boolean

    否

    是否支援公網，取值如下：

    true
    MaxEipTps

    integer

    否

    公網 TPS 流量峰值，單位：TPS。

    128
    QueueCapacity

    integer

    否

    設定 Queue 的數量，單位：個。

    1000
    MaxConnections

    integer

    否

    最大連線數。

    50000
    StorageSize

    integer

    否

    設定訊息儲存空間，單位：GB，取值如下：

    7
    SupportTracing

    boolean

    否

    是否啟用訊息軌跡功能，取值如下：

    true
    TracingStorageTime

    integer

    否

    設定訊息軌跡的儲存時長，單位：天，取值如下：

    3
    ResourceGroupId

    string

    否

    執行個體所屬資源群組 ID。

    rg-acfmvvajg5qkxhi
    EncryptedInstance

    boolean

    否

    獨享執行個體專屬功能。執行個體是否啟用資料儲存加密功能。

    false
    KmsKeyId

    string

    否

    獨享執行個體專屬功能，當 EncryptedInstance 為 true 時需要填寫此欄位。資料加密儲存使用的 KMS 金鑰 ID。對金鑰有以下要求：

    key-xxx
    ProvisionedCapacity

    integer

    否

    預留+彈性執行個體的預留 TPS 容量。

    2000
    Edition

    string

    否

    Serverless 執行個體部署架構，取值如下：

    shared
    Tags

    array<object>

    否

    資源標籤。

    object

    否

    標籤物件。

    Key

    string

    否

    資源標籤鍵。

    testKey
    Value

    string

    否

    資源標籤值。

    testValue
    VpcId

    string

    是

    使用者指定 vpcId，用於建立 PVL 接入點。

    vpc-xxx
    VswitchIds

    array

    是

    建立執行個體時，用於建立 privateLink 接入點。

    string

    是

    建立執行個體時填寫的 vswitchId。

    vsw-xxx
    SecurityGroupId

    string

    是

    指定安全性群組，用於建立 privatelink 接入點。

    sg-xxx
    ListenerMode

    string

    否

    指定執行個體是否僅啟用 TLS 加密傳輸連接埠。此參數僅在（獨享）預留+彈性、鉑金執行個體支援。

    tcp_and_ssl
    AuthModel

    string

    否

    驗證模式，預設為 Ram 驗證模式。

    枚舉值：

    • openSource :

      openSource

    • ram :

      ram

    ram
    ServerlessSwitch

    boolean

    否

    彈性開關。

    以下範例中的參數皆為必填參數，其他參數可根據實際需求填寫：

    購買 serverless 隨用隨付執行個體：

    購買 serverless 預留+彈性（共用）執行個體：

> provisionedCapacity 範圍 [2000, 20000]，步長 2000

```json。

購買 serverless 預留+彈性（獨享）執行個體：

> provisionedCapacity 範圍 [5000, 500000]，步長 5000

```json。

購買企業版執行個體：

> MaxPrivateTps 參數選擇：3000、5000、8000、10000、15000、20000、30000、40000、50000、80000、100000

```json。

購買鉑金版執行個體：

> MaxPrivateTps 參數選擇：8000、15000、25000、40000、50000、100000、200000、300000、500000、800000、1000000

```json。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    JsonResult

    RequestId

    string

    公用參數，每個請求的 ID 都是唯一的，可用於排查和定位問題。

    CCBB1225-C392-480E-8C7F-D09AB2CD2***
    Code

    integer

    返回碼。返回 200 代表成功。

    200
    Message

    string

    返回資訊。

    xxx failed,xxxx
    Data

    any

    返回已建立執行個體的 ID。

    amqp-cn-xxxxx
    Success

    boolean

    請求是否成功。

    true

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

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

    變更歷史

    更多資訊，參考變更詳情。