全部产品
Search
文档中心

日志服务:ConsumerGroupHeartBeat

更新时间:Oct 26, 2023

调用ConsumerGroupHeartBeat接口为指定消费者发送心跳到服务端。

接口说明

  • Host由Project名称和日志服务Endpoint构成,您需要在Host中指定Project。
  • 消费者和服务端通过固定时间发送心跳建立连接。在固定时间段内没有收到心跳,消费者将被删除。
  • 已创建并获取AccessKey。更多信息,请参见访问密钥

    阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作,请参见创建RAM用户及授权

  • 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询,请参见管理Project管理Logstore
  • 已获取消费组名称。更多信息,请参见ListConsumerGroup

鉴权资源

下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息,用于为RAM用户或RAM角色授予调用此API的权限。

动作(Action)

授权策略中的资源描述方式(Resource)

log:ConsumerGroupHeartBeat acs:log:${regionId}:${accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/{#ConsumerGroupName}

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
project String Host ali-test-project

Project名称。

logstore String Path ali-test-logstore

Logstore名称。

consumerGroup String Path consumer_group_test

消费组名称,同一Project中消费组名称为唯一值。

consumer String Query consumer_1

消费者。

Array of Integer Body [0]

正在消费的Shard ID列表。

返回数据

名称 类型 示例值 描述
Date String Sun, 27 May 2018 08:25:04 GMT

返回响应的时间。

Server String nginx

服务器名称。

x-log-requestid String 5B0A6B60BB6EE39764D458B5

服务端产生的标识,该请求的唯一ID。

Content-Length String 0

响应内容长度。

Connection String close

是否长连接。取值包括:

  • close:不是长连接,则每个HTTP请求都会重新建立TCP连接。
  • keep-alive:长连接,TCP连接建立后保持连接状态,节省连接所需时间和带宽。
Array of Integer [0]

消费者消费的所有Shard ID列表。

示例

请求示例

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]

正常返回示例

JSON格式

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

[ 0, 1 ]

错误码

访问错误中心查看更多错误码。

HttpStatusCode

ErrorCode

ErrorMessage

错误码描述

400

NotExistConsumerWithBody

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

不存在非空心跳消息的消费者。请求参数中的Shard实际分配的消费者,与请求参数中的消费者不一致。可能原因是和服务端心跳断开后,Shard已经分配给其他消费者,建议传入空Shard列表。

404

ProjectNotExist

Project does not exist.

Project不存在。

404

LogStoreNotExist

Logstore does not exist.

Logstore不存在。

404

ConsumerGroupNotExist

consumer group not exist.

消费组不存在。

500

InternalServerError

Specified Server Error Message.

内部服务调用错误。

更多信息,请参见通用错误码