創建云消息隊列 RocketMQ 版5.x系列實例。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
rocketmq:CreateInstance | create | *Instance acs:rocketmq:{#regionId}:{#accountId}:Instance/* |
| 無 |
請求語法
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 |
subSeriesCode | string | 是 | 實例的子系列編碼。子系列間具體差異,請參見產品選型。 參數取值如下:
主系列選擇 ultimate(鉑金版)時,子系列只能選擇為 cluster_ha(集群高可用版)。 注意 實例創建成功后,子系列不支持變更。 枚舉值:
| cluster_ha |
paymentType | string | 是 | 實例的付費類型。云消息隊列 RocketMQ 版支持包年包月和按量付費兩種類型。 參數取值如下:
具體信息,請參見計費方式。 | Subscription |
period | integer | 否 | 購買時長。僅當實例付費類型為 Subscription(包年包月)時,該參數生效。 取值范圍如下:
| 3 |
periodUnit | string | 否 | 購買時長的最小周期單位。 參數取值如下:
| Month |
autoRenew | boolean | 否 | 是否自動續費。僅當實例付費類型為 Subscription(包年包月)時,該參數生效。
| true |
autoRenewPeriod | integer | 否 | 自動續費周期。僅當開啟自動續費時該參數有效。單位:月。 取值范圍:
| 3 |
remark | string | 否 | 實例的備注信息。 | This is the remark for test. |
productInfo | object | 否 | 實例規格信息。 | |
msgProcessSpec | string | 是 | 消息收發計算規格。具體消息收發 TPS 上限,請參見實例規格。 | rmq.s2.2xlarge |
sendReceiveRatio | float | 否 | 消息發送 TPS 占整個實例消息收發 TPS 總量的比例。 例如,實例的消息收發 TPS 上限為 1000 次/秒,若消息發送占比為 0.8,則消息發送 TPS 上限為 800 次/秒,消息接收 TPS 上限為 200 次/秒。 取值范圍:[0,1],默認值為 0.5。 | 0.5 |
autoScaling | boolean | 否 | true | |
messageRetentionTime | integer | 否 | 72 | |
chargeType | string | 否 | 計費模式。 參數取值如下:
| provisioned |
intranetSpec | string | 否 | 廢棄參數,您無需填寫。 | xxxx |
storageEncryption | boolean | 否 | 是否開啟存儲加密 | false |
storageSecretKey | string | 否 | 存儲加密密鑰 Key | xxxxx |
networkInfo | object | 是 | 網絡配置信息。 | |
vpcInfo | object | 是 | 專有網絡配置信息。 | |
vpcId | string | 是 | 待創建實例所關聯的專有網絡的 ID。 說明
云消息隊列 RocketMQ 版實例創建后,選擇的 VPC 不支持變更。若要修改關聯的 VPC,您需要先釋放已購買的云消息隊列 RocketMQ 版實例,再重新購買。
| vpc-wz9qt50xhtj9krb****** |
vSwitchIddeprecated | 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 版會收取公網下行帶寬費用。具體計費信息,請參見公網訪問費用。 | disable |
flowOutType | string | 是 | 公網計費類型。 參數取值如下:
| uninvolved |
flowOutBandwidth | integer | 否 | 公網帶寬規格。單位:Mb/s。 只有在公網計費類型為按固定帶寬計費的時候才需要填寫。 取值范圍:[1 - 1000]。 | 100 |
ipWhitelistdeprecated | array | 否 | 公網訪問 IP 白名單。僅公網接入點支持配置 IP 白名單,VPC 接入點暫不支持。
| |
string | 否 | 公網訪問白名單地址段。 | 192.168.x.x/24 | |
commodityCode | string | 否 | 商品編碼。
| ons_ rmqpost_public_cn |
resourceGroupId | string | 否 | 資源組 ID。 | rg-aekzy6pist7uuna |
返回參數
示例
正常返回示例
JSON
格式
{
"requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
"success": true,
"data": "rmq-cn-7e22ody****",
"code": "200",
"message": "Success",
"httpStatusCode": 200,
"dynamicCode": "InstanceId",
"dynamicMessage": "instanceId"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-11-26 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2024-07-03 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2023-10-09 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2023-10-09 | OpenAPI 入參發生變更 | 查看變更詳情 |
2023-10-09 | OpenAPI 入參發生變更 | 查看變更詳情 |