OnsGroupCreate - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Operation description

Important Alibaba Cloud OpenAPI is a management API. You can use it to manage and query Alibaba Cloud service resources. Integrate this API for management purposes only. Do not use this API for core data links to send and receive messages because this can introduce security threats.

This operation is typically used to create a new group for deploying new applications or implementing business logic.

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:CreateGroup

create

*Instance

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

None

mq:QueryInstanceBaseInfo

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the consumer group that you want to create. The value must meet the following requirements: The value must be 2 to 64 characters in length and can contain only letters, digits, hyphens (-), and underscores (_). If the instance for which you want to create the group has a namespace, the group ID must be unique within the instance. It cannot be the same as an existing group ID or topic name in the instance. Group IDs can be the same across different instances. For example, a group ID in Instance A can be the same as a group ID or a topic name in Instance B. If the instance for which you want to create the group does not have a namespace, the group ID must be globally unique across all instances and regions. It cannot be the same as any existing group ID or topic name. Note The group ID cannot be changed after the group is created. To check whether an instance has a namespace, go to the Basic Information section on the Instance Details page in the ApsaraMQ for RocketMQ console.	GID_test_groupId
Remark	string	No	The remarks on the group.	test
InstanceId	string	No	The ID of the instance to which the group belongs.	MQ_INST_111111111111_DOxxxxxx
GroupType	string	No	The protocol to which the group ID applies. Group IDs for the TCP and HTTP protocols cannot be used interchangeably. Create a separate group ID for each protocol. Valid values: tcp: This is the default value. The created group ID applies only to message sending and receiving over the TCP protocol. http: The created group ID applies only to message sending and receiving over the HTTP protocol.	tcp

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	A common parameter. The ID of the request is unique for each request. Use this ID to troubleshoot and locate issues.	A07E3902-B92E-44A6-B6C5-6AA111111****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	%s	%s, please check and retry later
400	Group.NumLimited	group count exceed limit.	The number of gid exceeds the limit.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.