HeartBeat

接口说明

消费者和服务端通过固定时间发送心跳建立连接。在超时时间段内没有收到心跳，消费者将被删除。

请求语法

POST /logstores/logstoreName/consumergroups/consumerGroup?type=heartbeat&consumer=<consumer> HTTP/1.1
Authorization: LOG yourAccessKeyId:yourSignature
x-log-bodyrawsize: 0
User-Agent: UserAgent
x-log-apiversion: 0.6.0
Host: ProjectName.Endpoint
x-log-signaturemethod: hmac-sha1
Date: GMT Date
Content-Type: application/json
Content-MD5: F58544E4D022CC28A93D0B7CC208A5AA
Content-Length: 54
Body :
[shard ID list]

其中，Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。

请求参数

• 请求头

  HeartBeat接口无特有请求头，关于Log Service API的公共请求头，请参见公共请求头。

• 参数列表

  参数名称	数据类型	是否必填	示例值	描述
  projectName	String	是	my-project	Project名称。
  logstoreName	String	是	my-logstore	Logstore名称。
  consumerGroup	String	是	consumer_group_test	消费组名称，同一Project中消费组名称为唯一值。
  consumer	String	是	consumer_1	消费者。
  shards	Array	否	[0]	正在消费的Shard ID列表。

返回数据

• 响应头

  HeartBeat接口无特有响应头，关于Log Service API的公共响应头，请参见公共响应头。

• 响应元素

  返回HTTP状态码200，则表示HeartBeat请求成功，同时返回消费者消费的所有Shard ID列表。

示例

• 请求示例

  POST /logstores/my-logstore/consumergroups/consumer_group_test?type=heartbeat&consumer=consumer_1 HTTP/1.1
  Header :
  {
  Authorization: LOG yourAccessKeyId:yourSignature
  x-log-bodyrawsize: 0
  User-Agent: sls-java-sdk-v-0.6.1
  x-log-apiversion: 0.6.0
  Host: my-project.cn-shanghai.log.aliyuncs.com
  x-log-signaturemethod: hmac-sha1
  Date: Sun, 06 May 2018 09:44:10 GMT
  Content-Type: application/json
  Content-MD5: 8D5162CA104FA7E79FE80FD92BB657FB
  Content-Length: 3
  Connection: Keep-Alive
  }
  Body :
  [0]

• 正常返回示例

  HTTP/1.1 200 OK
  Header :
  {
  Server: nginx/1.12.1
  Content-Type: application/json
  Content-Length: 5
  Connection: close
  Access-Control-Allow-Origin: *
  Date: Sun, 06 May 2018 09:44:11 GMT
  x-log-requestid: 5AEECE6B1FFC0366B2553FB5
  }
  Body :
  [0,1]

错误码

更多错误码，请参见通用错误码。