调用OnsGroupCreate创建客户端Group ID。

使用说明

本接口一般是在发布新应用、业务逻辑实现等需要新的Group的情况下使用。

QPS限制

本接口的单用户QPS限制为1次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

授权信息

默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息,请参见权限策略和示例

API

Action

Resource

OnsGroupCreate

mq:CreateGroup

acs:mq:*:*:{instanceId}

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String OnsGroupCreate

系统规定参数。取值:OnsGroupCreate

GroupId String GID_test_groupId

创建的消息消费集群的Group ID。取值说明如下:

  • 以“GID_“或者“GID-“开头,只能包含字母、数字、短划线(-)和下划线(_)。
  • 长度限制为7~64个字符。
说明 Group ID创建后,将无法再修改。
Remark String test

备注。

InstanceId String MQ_INST_111111111111_DOxxxxxx

需创建的Group ID所对应的实例ID。

GroupType String tcp

指定创建的Group ID适用的协议。TCP协议和HTTP协议的Group ID不可以共用,需要分别创建。取值说明如下:

  • tcp:默认值,表示创建的Group ID仅适用于TCP协议的消息收发。
  • http:表示创建的Group ID仅适用于HTTP协议的消息收发。

返回数据

名称 类型 示例值 描述
RequestId String A07E3902-B92E-44A6-B6C5-6AA111111****

公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。

示例

请求示例

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsGroupCreate
&GroupId=GID_test_groupId
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&Remark=test
&GroupType=tcp
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsGroupCreateResponse>
<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>
</OnsGroupCreateResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

访问错误中心查看更多错误码。

控制台操作

除了调用OnsGroupCreate接口,您还可以通过消息队列RocketMQ版控制台创建Group ID。具体操作,请参见Group管理