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.
- Simple Log Service provides examples of both regular log consumption and consumer group-based log consumption by using Simple Log Service SDKs for Java. For more information, see Consume log data and Use consumer groups to consume data.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
log:CreateConsumerGroup | create |
|
| none |
Request syntax
POST /logstores/{logstore}/consumergroups
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
logstore | string | Yes | The name of the Logstore. | aliyun-test-logstore |
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 parameters
Examples
Sample success responses
JSON
format
{}
Error codes
For a list of error codes, visit the Service error codes.