指定したコンシューマーのハートビートパケットをサーバーに送信します。

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

リクエスト構文

POST /logstores/<logstoreName>/consumergroups/<consumerGroup>? type=heartbeat&consumer=<consumer> HTTP/1.1
Authorization: <AuthorizationString>
x-log-bodyrawsize: 0
User-Agent: <UserAgent>
x-log-apiversion: 0.6.0
Host: <Project Endpoint>
x-log-signaturemethod: hmac-sha1
Date: <GMT Date>
Content-Type: application/json
Content-MD5: F58544E4D022CC28A93D0B7CC208A5AA
Content-Length: <ContentLength>
<shard ID list>

リクエストパラメーター

属性名 データ型 必須/省略可能 説明
logstoreName string 必須 Logstore の名前は、属するプロジェクトにおいて一意でなければなりません。
consumerGroup string 必須 コンシューマーグループ名はプロジェクトにおいて一意でなければなりません。
consumer string 必須 コンシューマー
{Shard ID List} array 必須 消費されるシャードの ID リスト
リクエストヘッダー

HeartBeat インターフェースに特別のリクエストヘッダーはありません。 Log Service API のパブリックリクエストヘッダーの詳細については、「パブリックリクエストヘッダー」をご参照ください。

レスポンスヘッダー

HeartBeat インターフェースに特別のレスポンスヘッダーはありません。 Log Service API の パブリックリクエストヘッダーの詳細については、「パブリックレスポンスヘッダー」をご参照ください。

レスポンス要素

HeartBeat リクエストが正常に送信されると、HTTP ステータスコード 200 とコンシューマーによって消費されたすべてのシャードの ID リストが 返されます。

エラーコード

Log Service API の 一般的なエラー コードに加えて、インターフェースから以下のエラーコードが返される場合があります。

HTTP ステータスコード エラーコード エラーメッセージ
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
詳細

ハートビートパケットは、コンシューマーとサーバー間の接続が確立された場合のみ送信されます。

例

リクエストの例 
POST /logstores/my-logstore/consumergroups/consumer_group_test? type=heartbeat&consumer=consumer_1 HTTP/1.1
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
[0]
レスポンス例： 
HTTP/1.1 200
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
[0,1]