透過 API 程式化建立 RocketMQ 執行個體 - ApsaraMQ for RocketMQ

介面說明

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

執行個體是用於雲訊息佇列 RocketMQ 版服務的虛擬機器資源，用來儲存 Topic 和 Group 資訊。該介面一般在新業務發布需要建立新的服務資源的情況下使用。

該介面只支援建立標準版執行個體，不支援建立鉑金版執行個體。雲訊息佇列 RocketMQ 版控制台同時支援建立標準版執行個體和鉑金版執行個體，具體操作，請參見執行個體管理。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

mq:CreateInstance

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Remark	string	否	執行個體的描述資訊。	備忘說明
InstanceName	string	是	執行個體名稱。取值說明如下：執行個體名稱在該執行個體所部署的地區下要唯一，不可重名。長度限制為 3~64 個字元，可以是中文、英文、數字、短劃線（-）以及底線（_）。	測試執行個體

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	公用參數，每個請求的 ID 都是唯一的，可用於排查和定位問題。	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object	返回結果。
InstanceId	string	建立的執行個體 ID。	MQ_INST_188077086902****_BXSuW61e
InstanceType	integer	建立的執行個體類型，取值說明如下： 1：標準版執行個體	1

樣本

正常返回樣本

JSON格式

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****",
  "Data": {
    "InstanceId": "MQ_INST_188077086902****_BXSuW61e",
    "InstanceType": 1
  }
}

錯誤碼

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

變更歷史

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