All Products
Search
Document Center

OnsGroupCreate

Last Updated: Apr 25, 2019

OnsGroupCreate

You can call this operation to create a group ID on the client.

Description

The group ID is used to publish and subscribe to messages.

Request parameters

Name Type Required Description
InstanceId String No The ID of the instance.
PreventCache Long Yes The parameter used for CSRF verification, which can be set to the current system time. Unit: ms
GroupId String Yes The group ID of the consumption cluster. When creating a group ID, pay attention to the following aspects:
  • A group ID starts with “GID_“ or “GID-“, and contains letters, numbers, hyphens (-), and underscores (_).
  • A group ID ranges from 7 to 64 bytes.
  • Once a group ID is created, it cannot be edited anymore.
Remark String No The remarks on the request.

Response parameters

Name Type Description
RequestId String A common parameter. Each request has a unique ID.
HelpUrl String A help link.
Remark String The remarks on the request.

Examples

For more information about sample codes, see API sample code and endpoints.