All Products
Document Center

Simple Log Service:ConsumerGroupHeartBeat

Last Updated:Oct 26, 2023

Sends heartbeat messages to Log Service for a consumer.

Usage notes

  • Host consists of a project name and a Log Service endpoint. You must specify a project in Host.
  • Connections between consumers and Log Service are established by sending heartbeat messages at regular intervals. If Log Service does not receive heartbeat messages from a consumer on schedule, Log Service deletes the consumer.
  • 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 Log Service is a high-risk operation. We recommend that you use a 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 Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access 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.
  • The name of the required consumer group is obtained. For more information, see ListConsumerGroup.

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.





OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

POST /logstores/{logstore}/consumergroups/{consumerGroup}?type=heartbeat HTTP/1.1

Request parameters


The name of the project.


The name of the Logstore.


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


The consumer.

Array of IntegerBodyYes[0]

The IDs of shards whose data is being consumed.

Response parameters

DateStringSun, 27 May 2018 08:25:04 GMT

The time when the response was returned.


The name of the server.


The request ID.


The length of the response body.


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.
Array of Integer[0]

The IDs of shards whose data is consumed by the consumer.


Sample requests

POST /logstores/ali-test-logstore/consumergroups/{consumerGroup}?type=heartbeat?consumer=consumer_1 HTTP/1.1

[ 0]

Sample success responses

JSON format

HTTP/1.1 200 OK

[ 0, 1 ]

Error codes

For a list of error codes, see Service error codes.

HTTP status code

Error code

Error message




non-exist consumer with non-empty body of heartbeat message.

A consumer with non-empty heartbeat messages does not exist. The actual consumer that consumes data in the specified shards is inconsistent with the specified consumer. The possible cause is that no heartbeat messages reach Log Service and the shards are assigned to another consumer. We recommend that you specify an empty shard list in the request.



Project does not exist.

The specified project does not exist.



Logstore does not exist.

The specified Logstore does not exist.



consumer group not exist.

The specified consumer group does not exist.



Specified Server Error Message.

An internal server error has occurred.

For more information, see Common error codes.