指定したコンシューマーグループによって消費された 1 つ、またはすべてのシャードのチェックポイントを取得します。

例:
GET /logstores/{logstoreName}/consumergroups/{consumerGroupName}? shard={shardId}

リクエスト構文

GET /logstores/<logstoreName>/consumergroups/<consumerGroup>? shard=<shardId> 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
Connection: Keep-Alive

リクエストパラメーター

属性名 データ型 必須/省略可能 説明
logstoreName string 必須 コンシューマーグループの Logstore 名
consumerGroup string 必須 コンシューマーグループ名
shardId integer 省略可能 シャード ID シャード ID が指定されていない場合、すべてのシャードのチェックポイントが返されます。
リクエストヘッダー

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

レスポンスヘッダー

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

レスポンス要素

GetCheckPoint リクエストが正常に送信されると、指定したコンシューマーグループによって消費されたシャードのチェックポイントが以下の形式でレスポンスボディの中に含まれます。

属性名 データ型 説明
shard integer シャード ID
checkpoint string チェックポイント値
updateTime integer チェックポイントの最新更新時間
consumer string シャードのコンシューマー
エラーコード

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

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

シャードが指定されていない場合、空のリストが返されます。 シャード ID が指定されていない場合、すべてのシャードのチェックポイントが返されます。

リクエスト例:
GET /logstores/my-logstore/consumergroups/consumer_group_test? shard=0
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: Fri, 04 May 2018 09:26:53 GMT
Content-Type: application/x-protobuf
Connection: Keep-Alive
レスポンス例:
HTTP/1.1 200
Server: nginx/1.12.1
Content-Type: application/json
Content-Length: 111
Connection: close
Access-Control-Allow-Origin: *
Date: Fri, 04 May 2018 09:26:53 GMT
x-log-requestid: 5AEC275D1FFC036AB254B20C
[
  {
    "shardId": 0,
    "checkpoint": "MTUyNDE1NTM3OTM3MzkwODQ5Ng==",
    "updateTime": 1524224984800922,
    "consumer": "consumer_1"
  }
]