全部产品
弹性计算 会员服务 网络 安全 移动云 数加·大数据分析及展现 数加·大数据应用 管理与监控 云通信 阿里云办公 培训与认证 智能硬件
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 更多
日志服务

HeartBeat

更新时间:2018-05-28 10:15:30

为指定消费者发送心跳到服务端。

示例:

POST /logstores/{logstoreName}/consumergroups/{consumerGroupName}?type=heartbeat&consumer={consumer}

请求语法

  1. POST /logstores/<logstoreName>/consumergroups/<consumerGroup>?type=heartbeat&consumer=<consumer> HTTP/1.1
  2. Authorization: <AuthorizationString>
  3. x-log-bodyrawsize: 0
  4. User-Agent: <UserAgent>
  5. x-log-apiversion: 0.6.0
  6. Host: <Project Endpoint>
  7. x-log-signaturemethod: hmac-sha1
  8. Date: <GMT Date>
  9. Content-Type: application/json
  10. Content-MD5: F58544E4D022CC28A93D0B7CC208A5AA
  11. Content-Length: <ContentLength>
  12. <shard ID list>

请求参数

属性名称 类型 是否必须 描述
logstoreName string Logstore 的名称,在 Project 下必须唯一。
consumerGroup string 消费组名称,在Project 下必须唯一。
consumer string 消费者。
{Shard ID List} array 正在消费的Shard Id列表。

请求头

HeartBeat 接口无特有请求头,关于 Log Service API 的公共请求头请参考 公共请求头

响应头

HeartBeat 接口无特有响应头,关于 Log Service API 的公共响应头请参考 公共响应头

响应元素

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

错误码

除了返回 Log Service API 的 通用错误码,还可能返回如下特有错误码:

HTTP状态码 ErrorCode ErrorMessage
400 NotExistConsumerWithBody non-exist consumer with non-empty body of heartbeat message
404 ProjectNotExist The Project does not exist : {Project}
404 LogStoreNotExist logstore {logstoreName} dose not exist
404 ConsumerGroupNotExist consumer group not exist
500 InternalServerError Specified Server Error Message

细节描述

只有消费者和服务端建立连接之后才能发送心跳。

示例

请求示例:
  1. POST /logstores/my-logstore/consumergroups/consumer_group_test?type=heartbeat&consumer=consumer_1 HTTP/1.1
  2. Authorization: LOG LTRTfdR7fbosJYad:OK7Sldsxcv/8gz6YtrrmzR19Tgh=
  3. x-log-bodyrawsize: 0
  4. User-Agent: sls-java-sdk-v-0.6.1
  5. x-log-apiversion: 0.6.0
  6. Host: my-project.cn-shanghai.log.aliyuncs.com
  7. x-log-signaturemethod: hmac-sha1
  8. Date: Sun, 06 May 2018 09:44:10 GMT
  9. Content-Type: application/json
  10. Content-MD5: 8D5162CA104FA7E79FE80FD92BB657FB
  11. Content-Length: 3
  12. Connection: Keep-Alive
  13. [0]
响应示例:
  1. HTTP/1.1 200
  2. Server: nginx/1.12.1
  3. Content-Type: application/json
  4. Content-Length: 5
  5. Connection: close
  6. Access-Control-Allow-Origin: *
  7. Date: Sun, 06 May 2018 09:44:11 GMT
  8. x-log-requestid: 5AEECE6B1FFC0366B2553FB5
  9. [0,1]
本文导读目录