全部產品
Search

搜尋本產品

    ApsaraMQ for RocketMQ：CreateInstance

    文件中心

    ApsaraMQ for RocketMQ：CreateInstance

    更新時間：Sep 24, 2026

    建立雲端訊息佇列 RocketMQ 版 5.x 系列執行個體。

    介面說明

    重要 阿里雲提供的 OpenAPI 屬於管控類 API，用於管理和查詢阿里雲服務的相關資源。僅推薦在管控鏈路整合，訊息收發的核心資料鏈路中嚴禁依賴 OpenAPI 實作，否則可能會導致鏈路產生風險。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    rocketmq:CreateInstance

    create

    *Instance

    acs:rocketmq:{#regionId}:{#accountId}:Instance/*
    • rocketmq:InternetSpec
    		 無

    請求文法

    POST /instances HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    clientToken

    string

    否

    用於保證請求的冪等性。由用戶端產生該參數值，要保證在不同請求間唯一，最大不超過 64 個 ASCII 字元。

    c2c5d1274a8d4317a13bc5b0d4******
    body

    object

    否

    body 參數。

    instanceName

    string

    否

    待建立的執行個體名稱。

    未填寫則以執行個體 ID 作為執行個體名稱。

    rmq-cn-72u3048uxxx
    serviceCode

    string

    是

    執行個體所屬的服務編碼。訊息佇列 RocketMQ 版的服務編碼為 rmq。

    rmq
    seriesCode

    string

    是

    執行個體的主系列編碼。主系列間的具體差異，請參閱產品選型。

    枚舉值：

    • standard :

      標準版。

    • dedicated :

      獨享版。

    • shared :

      共享版。

    • ultimate :

      鉑金版。

    • professional :

      專業版。

    standard
    subSeriesCode

    string

    是

    執行個體的子系列編碼。子系列間具體差異，請參閱產品選型。

    主系列選擇 ultimate（鉑金版）時，子系列只能選擇為 cluster_ha（叢集高可用版）。

    重要 執行個體建立成功後，子系列不支援變更。

    枚舉值：

    • serverless :

      Serverless 版。

    • cluster_ha :

      叢集高可用版。

    • single_node :

      單節點測試版。

    cluster_ha
    paymentType

    string

    是

    執行個體的付費類型。雲端訊息佇列 RocketMQ 版支援包年包月和按量付費兩種類型。

    具體資訊，請參閱計費方式。

    枚舉值：

    • PayAsYouGo :

      按量付費，一種後付費模式，即先使用再付費。

    • Subscription :

      包年包月，一種預付費模式，即先付費再使用。

    Subscription
    period

    integer

    否

    購買時長。僅當執行個體付費類型為 Subscription（包年包月）時，該參數生效。

    取值範圍如下：

    • 按月購買：1、2、3、4、5、6

    • 按年購買：1、2、3

    3
    periodUnit

    string

    否

    購買時長的最小週期單位。

    枚舉值：

    • Month :

      按月購買。

    • Year :

      按年購買。

    Month
    autoRenew

    boolean

    否

    是否自動續費。僅當執行個體付費類型為 Subscription（包年包月）時，該參數生效。

    枚舉值：

    • true :

      開啟自動續費。

    • false :

      不開啟自動續費。

    true
    autoRenewPeriod

    integer

    否

    自動續費週期。僅當開啟自動續費時該參數有效。單位：月。

    取值範圍：

    • 按月續費：1、2、3、6、12

    3
    remark

    string

    否

    執行個體的備註資訊。

    This is the remark for test.
    productInfo

    object

    否

    執行個體規格資訊。

    msgProcessSpec

    string

    否

    訊息收發運算規格。具體訊息收發 TPS 上限，請參閱執行個體規格。

    rmq.s2.2xlarge
    sendReceiveRatio

    number

    否

    訊息發送 TPS 佔整個執行個體訊息收發 TPS 總量的比例。

    例如，執行個體的訊息收發 TPS 上限為 1000 次/秒，若訊息發送佔比為 0.8，則訊息發送 TPS 上限為 800 次/秒，訊息接收 TPS 上限為 200 次/秒。

    取值範圍：[0.05，0.95]，預設值為 0.5。

    0.5
    autoScaling

    boolean

    否

    是否開啟規格外突發彈性能力。

    開啟彈性突發能力後，雲端訊息佇列 RocketMQ 版允許該執行個體在一定範圍內超過基礎規格限制的 TPS，且超過基礎規格外的部分，需要收取額外的彈性規格費用。具體計費資訊，請參閱運算能力費用。

    說明

    僅部分規格的執行個體支援開啟彈性突發規格能力，具體支援的執行個體，請參閱執行個體規格。

    枚舉值：

    • true :

      開啟彈性能力。

    • false :

      不開啟彈性能力。

    true
    messageRetentionTime

    integer

    否

    訊息保存時長。單位：小時。

    取值範圍，請參閱使用限制>資源配額>訊息保存時長的限制值。

    雲端訊息佇列 RocketMQ 版的訊息儲存完全實作 Serverless 彈性，按照實際儲存空間收取費用，您可以透過調整訊息保存時長來控制訊息的儲存容量。更多資訊，請參閱儲存費用。

    72
    storageEncryption

    boolean

    否

    是否開啟儲存加密。

    false
    storageSecretKey

    string

    否

    儲存加密金鑰 Key。

    xxxxx
    capacityType

    string

    否

    容量模式。

    枚舉值：

    • provisioned :

      預留+彈性。

    • ondemand :

      按量付費。

    provisioned
    provisionedCapacity

    integer

    否

    預留容量。

    5000
    traceOn

    boolean

    否

    是否開啟訊息軌跡功能。

    true：開啟訊息軌跡功能 false：關閉訊息軌跡功能 該參數僅對 Serverless 類型的執行個體生效，若開啟訊息軌跡功能，會產生相關的訊息軌跡費用，具體計費資訊，請參閱 Serverless 計費說明。對於按量付費和包年包月執行個體，該參數不生效，即不管參數是否開啟，都預設支援訊息軌跡功能。

    true
    drReplicationMode

    string

    否

    跨地域複製模式。

    枚舉值：

    • async_cross_az :

      非同步複製。

    • sync_cross_az :

      同步複製。

    async_cross_az
    adaptiveElasticity

    boolean

    否

    是否開啟自適應彈性能力。true 表示開啟，false 表示關閉。

    networkInfo

    object

    是

    網路配置資訊。

    vpcInfo

    object

    是

    專有網路配置資訊。

    vpcId

    string

    是

    待建立執行個體所關聯的專有網路的 ID。

    說明

    雲端訊息佇列 RocketMQ 版執行個體建立後，選擇的 VPC 不支援變更。若要修改關聯的 VPC，您需要先釋放已購買的雲端訊息佇列 RocketMQ 版執行個體，再重新購買。

    vpc-wz9qt50xhtj9krb******
    vSwitchId deprecated

    string

    否

    執行個體所關聯的交換器 ID，當有多個交換器時，請以「|」進行拼接。

    說明

    雲端訊息佇列 RocketMQ 版執行個體建立後，選擇的交換器不支援變更。若要修改關聯的交換器，您需要先釋放已購買的雲端訊息佇列 RocketMQ 版執行個體，再重新購買。

    重要 該欄位不推薦使用，請使用 vSwitches 欄位

    vsw-uf6gwtbn6etadpv*******
    securityGroupIds

    string

    否

    安全性群組 ID。

    sg-bp17hpmgz96tvnsdy6so
    vSwitches

    array<object>

    否

    交換器清單。

    說明

    雲端訊息佇列 RocketMQ 版執行個體建立後，選擇的交換器不支援變更。若要修改關聯的交換器，您需要先釋放已購買的雲端訊息佇列 RocketMQ 版執行個體，再重新購買。

    重要 必填欄位，由於 vSwitchId 欄位已不推薦使用，請使用該欄位設定交換器

    object

    否

    vSwitchId

    string

    否

    執行個體所關聯的交換器 ID。

    vsw-uf6gwtbn6etadpv*******
    internetInfo

    object

    是

    公網配置資訊。

    internetSpec

    string

    是

    是否開通公網存取。

    執行個體預設支援 VPC 存取方式，若開啟公網存取，雲端訊息佇列 RocketMQ 版會收取公網下行頻寬費用。具體計費資訊，請參見公網存取費用。

    枚舉值：

    • enable :

      開啟公網存取。

    • disable :

      關閉公網存取。

    disable
    flowOutType

    string

    是

    公網計費類型。

    枚舉值：

    • payByBandwidth :

      固定頻寬計費，開啟公網存取時，設定為該參數取值。

    • payByTraffic :

      按流量計費，開啟公網存取時，設定為該參數取值。

    • uninvolved :

      不涉及，關閉公網存取時，設定為該參數取值。

    uninvolved
    flowOutBandwidth

    integer

    否

    公網頻寬規格。單位：Mb/s。

    只有在公網計費類型為按固定頻寬計費的時候才需要填寫。

    取值範圍：[1 - 1000]。

    100
    ipWhitelist deprecated

    array

    否

    公網存取 IP 白名單。僅公網接入點支援配置 IP 白名單，VPC 接入點暫不支援。

    • 若不配置 IP 白名單，則預設放行所有 IP 位址段透過公網存取雲端訊息佇列 RocketMQ 版伺服器端。

    • 若配置 IP 白名單，則僅允許白名單內的 IP 位址透過公網存取雲端訊息佇列 RocketMQ 版伺服器端。

    string

    否

    公網存取白名單位址段。

    192.168.x.x/24
    commodityCode deprecated

    string

    否

    商品編碼。

    • ons_rmqpost_public_intl：按量付費

    • ons_rmqsub_public_intl：包年包月

    • ons_rmqsrvlesspost_public_intl ：Serverless 執行個體 serverless 執行個體此參數必填

    ons_ rmqpost_public_cn
    resourceGroupId

    string

    否

    資源群組 ID。

    rg-aekzy6pist7uuna
    tags

    array<object>

    否

    資源標籤清單。

    object

    否

    資源標籤。

    key

    string

    否

    資源標籤 key 值。

    xxxKey
    value

    string

    否

    資源標籤 value 值。

    xxxValue
    aclInfo

    object

    否

    存取控制資訊。

    defaultVpcAuthFree

    boolean

    否

    是否智慧身份識別類型下，VPC 接入免密存取

    • true 開啟免密存取

    • false 關閉免密存取

    false

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    回傳資料。

    requestId

    string

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

    AF9A8B10-C426-530F-A0DD-96320B39****
    success

    boolean

    執行結果是否成功。

    true
    data

    string

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

    rmq-cn-7e22ody****
    code

    string

    錯誤碼。

    200
    message

    string

    錯誤資訊。

    Success
    httpStatusCode

    integer

    HTTP 狀態碼。

    200
    dynamicCode

    string

    動態錯誤碼。

    InstanceId
    dynamicMessage

    string

    動態錯誤資訊。

    instanceId

    樣本

    正常返回樣本

    JSON格式

    {
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": "rmq-cn-7e22ody****",
  "code": "200",
  "message": "Success",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

    錯誤碼

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

    變更歷史

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