ConsumerGroupHeartBeat - - Alibaba Cloud Documentation Center

Sends heartbeats to a server from a consumer.

Operation description

Connections between consumers and servers are established by sending heartbeats at regular intervals. If a server does not receive heartbeats from a consumer on schedule, the server deletes the consumer.
Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.

There is currently no authorization information disclosed in the API.

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

Parameter	Type	Required	Description	Example
logstore	string	Yes	The name of the Logstore.	ali-test-logstore
consumerGroup	string	Yes	The name of the consumer group. The name must be unique in a project.	consumer_group_test
consumer	string	Yes	The consumer.	consumer_1
body	array	Yes	The IDs of shards whose data is being consumed.
	integer	Yes	The IDs of shards whose data is being consumed.	[0]

Parameter	Type	Description	Example
headers	object
Date	string	The time when the response was returned.	Sun, 27 May 2018 08:25:04 GMT
Server	string	The name of the server.	nginx
x-log-requestid	string	The request ID.	5B0A6B60BB6EE39764D458B5
Content-Length	string	The length of the response body.	0
Connection	string	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
	array	The IDs of shards whose data is consumed by the consumer.
	integer	The IDs of shards whose data is consumed by the consumer.	[0]

Sample success responses

JSONformat

[
  0
]

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