CreateGroupId API reference - ApsaraMQ for MQTT - Alibaba Cloud - ApsaraMQ for MQTT

Message producers and consumers must specify a unique Client ID when they connect to ApsaraMQ for MQTT to send and receive messages. A Client ID consists of two parts in the format <groupid>@@@<deviceid>. The DeviceID is defined by the client, and the GroupID must be created on the ApsaraMQ for MQTT server beforehand.

Operation description

Each successful call to the CreateGroupId operation counts as one message TPS and affects your billing. For more information, see billing.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mq:CreateMqttGroupId

create

*Instance

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

None

mq:MqttInstanceAccess

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the group to create. This ID must meet the following requirements: The ID must be 7 to 64 characters in length, start with `GID_` or `GID-`, and contain only letters, digits, hyphens, and underscores. Group IDs cannot be modified after creation. For more information, see glossary.	GID_test
InstanceId	string	Yes	The ID of the instance to which the group ID belongs.	mqtt-cn-0pp1ldu****
Tag	array<object>	No	An array of tag key-value pairs.
	object	No	A list of resource tags. A resource can have a maximum of 20 tags. You can specify up to 20 tags in a single request.
Key	string	No	The tag key.	test
Value	string	No	The tag value.	test

Note

For more information about common parameters, see Common parameters and Endpoints.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	2C7D722D-0F3D-4415-A9CD-A464D82C****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
400	GroupIdAlreadyExsited	The specified GroupId already exists.
400	GroupIdAlreadyUsedByOtherUsers	The current GroupId is used by another user. Please change to a different GroupId.
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.
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.
500	CreateGroupIdError	Failed to create GroupId. Try again later.
500	InternalError	An error occurred while processing your request. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.