调用 ConsumerHeartbeat 接口向日志服务发送消费组中的一个消费者的心跳信息。

使用说明

此接口用于向日志服务服务端上报消费组中的一个消费者的心跳信息，表示该消费者为在线状态。服务端接收到此请求后，会根据此消费组的消费者数量、订阅日志主题的分区数量，为该消费者均衡分配日志分区，并返回指定消费者所负责消费的日志分区（Shards）信息。
每个活跃的消费者都应定期上报心跳信息，上报时间间隔不得超过心跳过期时间（HeartbeatTTL），否则服务端会将其视为下线。
此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

请求说明

• 请求方式：POST
• 请求地址：https://tls-{Region}.ivolces.com/ConsumerHeartbeat

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Body

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

ConsumeShard

请求示例

POST https://tls-{Region}.ivolces.com/ConsumerHeartbeat HTTP/1.1
Content-Type: application/json
{
    "ProjectID": "c7************",
    "ConsumerGroupName": "my-consumer-group",
    "ConsumerName": "consumer-0"
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8 
{
    "Shards": [
        {
            "TopicID": "e6********",
            "ShardID": 0
        },
        {
            "TopicID": "e6********",
            "ShardID": 1
        },
    ]
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。