調(diào)用OnsGroupCreate創(chuàng)建客戶端Group ID。
接口說明
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
mq:CreateGroup |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
GroupId | string | 是 | 創(chuàng)建的消息消費集群的 Group ID。取值說明如下:
說明
| GID_test_groupId |
Remark | string | 否 | 備注。 | test |
InstanceId | string | 是 | 需創(chuàng)建的 Group ID 所對應(yīng)的實例 ID。 | MQ_INST_111111111111_DOxxxxxx |
GroupType | string | 否 | 指定創(chuàng)建的 Group ID 適用的協(xié)議。TCP 協(xié)議和 HTTP 協(xié)議的 Group ID 不可以共用,需要分別創(chuàng)建。取值說明如下:
| tcp |
返回參數(shù)
示例
正常返回示例
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數(shù)量超出限制 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-10-07 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
控制臺操作
除了調(diào)用 OnsGroupCreate 接口,您還可以通過消息隊列 RocketMQ 版控制臺創(chuàng)建 Group ID。具體操作,請參見 Group 管理。