All Products
Search
Document Center

Simple Log Service:ConsumerGroupHeartBeat

Last Updated:Nov 28, 2024

Sends heartbeats to a server from a consumer.

Operation description

Usage notes

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

ActionResource
log:ConsumerGroupHeartBeatacs:log:${regionId}:${accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/{#ConsumerGroupName}

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:ConsumerGroupHeartBeatnone
*All Resources
*
  • log:TLSVersion
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
logstorestringYes

The name of the Logstore.

ali-test-logstore
consumerGroupstringYes

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

consumer_group_test
consumerstringYes

The consumer.

consumer_1
bodyarrayYes

The IDs of shards whose data is being consumed.

integerYes

The IDs of shards whose data is being consumed.

[0]

Response parameters

ParameterTypeDescriptionExample
headersobject
Datestring

The time when the response was returned.

Sun, 27 May 2018 08:25:04 GMT
Serverstring

The name of the server.

nginx
x-log-requestidstring

The request ID.

5B0A6B60BB6EE39764D458B5
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
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]

Examples

Sample success responses

JSONformat

[
  0
]

Error codes

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