调用CreateGroupId接口创建Group ID-云消息队列 MQTT 版-阿里云-云消息队列 MQTT 版(MQTT)-阿里云帮助中心

消息生产者和消费者客户端接入云消息队列 MQTT 版服务端收发消息时，需要指定Client ID，用于唯一标识一个客户端。 Client ID由两部分组成，组织形式为@@@，DeviceID由客户端自定义，GroupID需要提前在云消息队列 MQTT 版服务端创建。

接口说明

每成功调用一次 CreateGroupId 接口，都会计算为一次消息 TPS，从而影响您的计费。详情请参见计费说明。

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

操作

访问级别

资源类型

条件关键字

关联操作

mq:CreateMqttGroupId

create

*Instance

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

无

名称	类型	必填	描述	示例值
GroupId	string	是	您需创建的 Group ID。取值说明如下：以 "GID_" 或者 "GID-" 开头，只能包含字母、数字、连字符（-）和下划线（_），长度限制在 7~64 字符之间。 Group ID 一旦创建，则无法修改，详情请参见名词解释。	GID_test
InstanceId	string	是	创建的 Group ID 所在的实例 ID。	mqtt-cn-0pp1ldu****
Tag	array<object>	否	标签键值对数组。
	object	否	资源标签列表，一次最多添加 20 个标签，一个资源最多可以添加 20 个标签
Key	string	否	标签键	test
Value	string	否	标签值。	test

说明

更多参数说明请参见公共参数和服务接入点。

正常返回示例

JSON格式

{
  "RequestId": "2C7D722D-0F3D-4415-A9CD-A464D82C****"
}

HTTP status code	错误码	错误信息	描述
400	GroupIdAlreadyExsited	The specified GroupId already exists.	当前Group ID已经存在。
400	GroupIdAlreadyUsedByOtherUsers	The current GroupId is used by another user. Please change to a different GroupId.	当前Group ID已经被其他用户占用，请更换其他名称。
400	ParameterFieldCheckFailed	Failed to validate the parameters. The parameters may be missing or invalid.	参数校验失败，可能缺失或者传入值非法。
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.	实例权限校验失败，请确认MQTT实例的所属关系以及授权策略。
400	InstanceNotFound	Failed to find the instance. The instanceId may be invalid.	无法找到实例。
400	PermissionCheckFailed	An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.	资源权限校验失败，请检查实例、Topic和Group ID的所属权限和授权策略。
500	CreateGroupIdError	Failed to create GroupId. Try again later.	创建Group ID请求执行失败，请稍后重试。
500	InternalError	An error occurred while processing your request. Try again later.	MQTT后端服务异常，请重试。

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

更多信息，参考变更详情。