Creates a consumer group for a Logstore.
Operation description
Usage notes
-
Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.
-
You can create up to 30 consumer groups for a Logstore. The name of a consumer group must be unique in a project.
-
An AccessKey pair is created and obtained. For more information, see AccessKey pair.
The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Simple Log Service.
-
The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see Manage a project and Manage a Logstore.
-
Simple Log Service provides examples of both regular log consumption and consumer group-based log consumption by using Simple Log Service SDK for Java. For more information, see Consume log data and Use consumer groups to consume data.
Authentication resources
The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.
| Action | Resource |
log:CreateConsumerGroup |
acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup} |
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
log:CreateConsumerGroup |
create |
*LogStore
|
|
None |
Request syntax
POST /logstores/{logstore}/consumergroups HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| logstore |
string |
Yes |
The name of the Logstore. |
aliyun-test-logstore |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| project |
string |
Yes |
The name of the project. |
aliyun-test-project |
| body |
object |
Yes |
The information about the consumer group. |
|
| consumerGroup |
string |
Yes |
The name of the consumer group. The name must be unique in a project. |
consumerGroupX |
| timeout |
integer |
Yes |
The timeout period. If the server does not receive heartbeats from a consumer within the timeout period, the server deletes the consumer. Unit: seconds. |
300 |
| order |
boolean |
Yes |
Specifies whether to consume data in sequence. Valid values:
|
true |
Response elements
|
Element |
Type |
Description |
Example |
None defined.
Examples
Success response
JSON format
{}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.