All Products
Search

This Product

    :CreateConsumerGroup

    Document Center

    :CreateConsumerGroup

    Last Updated:Apr 25, 2024

    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

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    log:CreateConsumerGroupWrite
    • LogStore
      acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}
    • log:TLSVersion
    		none

    Request syntax

    POST /logstores/{logstore}/consumergroups

    Request parameters

    ParameterTypeRequiredDescriptionExample
    logstorestringYes

    The name of the Logstore.

    		aliyun-test-logstore
    projectstringYes

    The name of the project.

    		aliyun-test-project
    bodyobjectYes

    The information about the consumer group.

    consumerGroupstringYes

    The name of the consumer group. The name must be unique in a project.

    		consumerGroupX
    timeoutintegerYes

    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
    orderbooleanYes

    Specifies whether to consume data in sequence. Valid values:

    • true

      • In a shard, data is consumed in ascending order based on the value of the **__tag__:__receive_time__** field.
      • If a shard is split, data in the original shard is consumed first. Then, data in the new shards is consumed at the same time.
      • If shards are merged, data in the original shards is consumed first. Then, data in the new shard is consumed.

    • false Data in all shards is consumed at the same time. If a new shard is generated after a shard is split or after shards are merged, data in the new shard is immediately consumed.

    		true

    Response parameters

    ParameterTypeDescriptionExample
    headersobject
    Serverstring

    The name of the server.

    		nginx
    Content-Typestring

    The format in which the response body is returned.

    		application/json
    Content-Lengthstring

    The length of the response body.

    		0
    Connectionstring

    Indicates whether the connection is persistent. Valid values:

    • close: The connection is non-persistent. A new TCP connection is established for each HTTP request.
    • keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth is consumed to establish new connections.
    		close
    Datestring

    The time when the response was returned.

    		Sun, 27 May 2018 08:25:04 GMT
    x-log-requestidstring

    The request ID.

    		5B0A6B60BB6EE39764D458B5

    Examples

    Sample success responses

    JSONformat

    {}

    Error codes

    For a list of error codes, visit the Service error codes.