OnsGroupCreate - 创建客户端Group ID - 云消息队列 RocketMQ 版

调用OnsGroupCreate创建客户端Group ID。

接口说明

注意阿里云提供的 OpenAPI 属于管控类 API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖 OpenAPI 实现，否则可能会导致链路产生风险。

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

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作	访问级别	资源类型	条件关键字	关联操作
mq:CreateGroup	create	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	无	mq:QueryInstanceBaseInfo

名称	类型	必填	描述	示例值
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数量超出限制

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

变更时间	变更内容概要	操作
2023-10-07	OpenAPI 错误码发生变更	查看变更详情

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