You need to enable JavaScript to run this app.
导航

ConsumerHeartbeat

最近更新时间2023.11.13 16:31:41

首次发布时间2023.09.27 12:24:24

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

使用说明

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

URI

请求方法
POST

URI

https://tls-{Region}.ivolces.com/ConsumerHeartbeat

传输协议

HTTPS

Body 请求参数

参数
参数类型
是否必选
示例值
说明

ProjectID

String

c7******

消费组所属的日志项目 ID。

ConsumerGroupName

String

my-consumer-group

消费组名称。

ConsumerName

String

consumer-0

指定消费组中的新消费者名称。应符合以下规范:

  • 只支持小写英文字母、数字和连字符(-)。
  • 必须以小写英文字母、或数字开头或结尾。
  • 长度为 3~63 个字符。

响应参数

参数
参数类型
示例值
说明

Shards

Array of ConsumeShard

/

服务端为指定消费者分配的日志分区列表。详细说明请参考 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
        },
    ]
}

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。