ConsumerGroupHeartBeat - Log Service - Alibaba Cloud Documentation Center

Sends heartbeat messages to Log Service for a specified consumer.

Description

Connections between consumers and Log Service are established by sending heartbeat messages within a fixed period of time. If Log Service does not receive heartbeat messages from a consumer within the period, Log Service deletes the consumer.
Host consists of a project name and a Log Service endpoint. You must specify a project in Host.

Debugging

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


Parameter	Type	Location	Required	Example	Description
logstore	String	Path	Yes	ali-test-logstore	The name of the Logstore.
consumerGroup	String	Path	Yes	consumer_group_test	The name of the consumer group. The name must be unique in a project.
consumer	String	Query	Yes	consumer_1	The consumer.
	Array of Integer	Body	Yes	[0]	The IDs of shards whose data is being consumed.

Response parameters


Parameter	Type	Example	Description
Date	String	Sun, 27 May 2018 08:25:04 GMT	The time at which the response was returned.
Server	String	nginx	The name of the server.
x-log-requestid	String	5B0A6B60BB6EE39764D458B5	The ID of the request. This is a unique ID generated by Log Service.
Content-Length	String	0	The content length of the response body.
Connection	String	close	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.

Examples

Sample requests

POST /logstores/ali-test-logstore/consumergroups/{consumerGroup}?type=heartbeat?consumer=consumer_1 HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

[ 0]

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

[ 0, 1 ]

Error codes

For a list of error codes, visit the API Error Center.


HTTP status code	Error code	Error message	Description
400	NotExistConsumerWithBody	non-exist consumer with non-empty body of heartbeat message.	The error message returned because a consumer with non-empty heartbeat messages does not exist. The actual consumer that consumes data in specified shards is inconsistent with the specified consumer. The possible cause is that no heartbeats reach Log Service and the shards are assigned to another consumer. We recommend that you specify an empty shard list.
404	ProjectNotExist	Project does not exist.	The error message returned because the specified project does not exist.
404	LogStoreNotExist	Logstore does not exist.	The error message returned because the specified Logstore does not exist.
404	ConsumerGroupNotExist	consumer group not exist.	The error message returned because the specified consumer group does not exist.
500	InternalServerError	Specified Server Error Message.	The error message returned because an internal server error has occurred.

For more information, see Common error codes.