Modifies the checkpoint of a shard for a consumer group in a specified project and Logstore.

Description

If you do not specify the consumer, you must set the forceSuccess parameter to true. Otherwise, the checkpoint cannot be updated.

Request syntax

POST /logstores/<logstoreName>/consumergroups/<consumerGroupName>? forceSuccess=<forceSuccess>&type=checkpoint&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-Length: <ContentLength>
Connection: Keep-Alive
{
  "shard": <shardID>,
  "checkpoint": <checkpoint>
}

Request parameters

  • Request headers

    The UpdateCheckPoint operation does not have operation-specific request headers. For information about the common request headers of Log Service API operations, see Common request headers.

  • Parameters
    Parameter Type Required Example Description
    logstoreName string Yes logstore-4 The name of the Logstore to which the consumer group belongs.
    consumerGroup string Yes consumer_group_test The name of the consumer group.
    forceSuccess bool No false Specifies whether to force the update.
    consumer string No consumer_1 The consumer.
    shard integer Yes 0 The ID of the shard.
    checkpoint string Yes MTUyNDE1NTM3OTM3MzkwODQ5Ng== The value of the checkpoint.

Response parameters

  • Response headers

    The UpdateCheckPoint operation does not have operation-specific response headers. For information about the common response headers of Log Service API operations, see Common response headers.

  • Response elements

    The HTTP status code 200 is returned.

Examples

  • Sample requests
    POST /logstores/logstore-4/consumergroups/consumer_group_test? forceSuccess=false&type=checkpoint&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:14:53 GMT
    Content-Type: application/json
    Content-MD5: 59457BAFB3F85A5117BDE243947583B0
    Content-Length: 55
    Connection: Keep-Alive
    {
      "shard": 0,
      "checkpoint": "MTUyNDE1NTM3OTM3MzkwODQ5Ng=="
    }
  • Sample success responses
    HTTP/1.1 200
    Server: nginx/1.12.1
    Content-Length: 0
    Connection: close
    Access-Control-Allow-Origin: *
    Date: Sun, 06 May 2018 09:14:54 GMT
    x-log-requestid: 5AEEC78E1FFC0366B24F1C63

Error codes

HTTP status code Error code Error message Description
400 InvalidShardCheckPoint shard checkpoint not encoded by base64. The error message returned because the checkpoint is not Base64-encoded.
404 ProjectNotExist The Project does not exist : {Project}. The error message returned because the specified project does not exist.
404 LogStoreNotExist logstore {logstoreName} does not exist. The error message returned because the specified Logstore does not exist.
404 ConsumerGroupNotExist consumer group does not exist. The error message returned because the specified consumer group does not exist.
404 ShardNotExist shard does not exist. The error message returned because the specified shard does not exist.
500 InternalServerError Specified Server Error Message. The error message returned because an internal server error has occurred.

For more information about the error codes, see Common error codes.