透過 OnsGroupCreate API 建立 RocketMQ 消費組 - ApsaraMQ for RocketMQ

介面說明

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

本介面一般是在發布新應用、商務邏輯實現等需要新的 Group 的情況下使用。

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

mq:CreateGroup

create

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

無

名稱	類型	必填	描述	樣本值
GroupId	string	是	建立的訊息消費叢集的 Group ID。取值說明如下：長度限制為 2~64 個字元，只能包含字母、數字、短劃線（-）和底線（_）。若建立的 Group 所在執行個體有命名空間，則 Group ID 需要保證執行個體內唯一，不能和本執行個體下已有的 Group ID 或 Topic 名稱重複；跨執行個體之間可以重名，例如執行個體 A 的 Group ID 可以和執行個體 B 的 Group ID 重複，也可以和執行個體 B 的 Topic 名稱重複。若建立的 Group 所在執行個體無命名空間，則 Group ID 需要保證跨執行個體和跨地區全域唯一，全域範圍內不能和已有的 Group ID 或 Topic 名稱重複。說明 Group ID 建立後，將無法再修改。執行個體是否有命名空間，可以在訊息佇列 RocketMQ 版控制台執行個體詳情頁面的基礎資訊地區查看。	GID_test_groupId
Remark	string	否	備忘。	test
InstanceId	string	否	需建立的 Group ID 所對應的執行個體 ID。	MQ_INST_111111111111_DOxxxxxx
GroupType	string	否	指定建立的 Group ID 適用的協議。TCP 協議和 HTTP 協議的 Group ID 不可以共用，需要分別建立。取值說明如下： tcp：預設值，表示建立的 Group ID 僅適用於 TCP 協議的訊息收發。 http：表示建立的 Group ID 僅適用於 HTTP 協議的訊息收發。	tcp

名稱	類型	描述	樣本值
	object	返回資訊。
RequestId	string	公用參數，每個請求的 ID 都是唯一的，可用於排查和定位問題。	A07E3902-B92E-44A6-B6C5-6AA111111****

正常返回樣本

JSON格式

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****"
}

HTTP status code	錯誤碼	錯誤資訊	描述
400	%s	%s, please check and retry later
400	Group.NumLimited	group count exceed limit.	Gid數量超出限制

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

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