Updates the checkpoint of a shard whose data is consumed by a consumer group.
Usage notes
- If you do not specify a consumer, you must set forceSuccess to true. Otherwise, the checkpoint cannot be updated.
- Host consists of a project name and a Log Service endpoint. You must specify a project in Host.
-
An AccessKey pair is created and obtained. For more information, see AccessKey pair.
The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Log Service.
- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see Manage a project and Manage a Logstore.
Debugging
Request headers
This operation uses only common request headers. For more information, see Common request headers.
Request syntax
POST /logstores/{logstore}/consumergroups/{consumerGroup}?type=checkpoint HTTP/1.1
Request parameters
Parameter | Type | Position | Required | Example | Description |
project | String | Host | No | ali-test-project | The name of the project. |
logstore | String | Path | No | ali-test-logstore | The name of the Logstore. |
consumerGroup | String | Path | No | consumer_group_test | The name of the consumer group. |
consumer | String | Query | No | consumer_1 | The consumer. |
forceSuccess | Boolean | Query | No | false | Specifies whether to enable force updates. Valid values:
|
Array | Body | No | The ID of the shard. |
||
shard | Integer | Body | No | 0 | The ID of the shard. |
checkpoint | String | Body | No | MTUyNDE1NTM3OTM3MzkwODQ5Ng== | The value of the checkpoint. |
Response parameters
Parameter | Type | Example | Description |
Server | String | nginx | The name of the server. |
Content-Type | String | application/json | The type of the response body. |
Content-Length | String | 0 | The length of the response body. |
Connection | String | close | Indicates whether the connection is persistent. Valid values:
|
Date | String | Sun, 27 May 2018 08:25:04 GMT | The time when the response was returned. |
x-log-requestid | String | 5B0A6B60BB6EE39764D458B5 | The request ID. |
Examples
Sample requests
POST /logstores/ali-test-logstore/consumergroups/{consumerGroup}?type=checkpoint?consumer=consumer_1&forceSuccess=false HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json
[ {
"shard" : 0,
"checkpoint" : "MTUyNDE1NTM3OTM3MzkwODQ5Ng=="
} ]
Sample success responses
JSON
format
HTTP/1.1 200 OK
Error codes
For a list of error codes, see Service error codes.
HTTP status code |
Error code |
Error message |
Description |
400 |
InvalidShardCheckPoint |
shard checkpoint not encoded by base64. |
The checkpoint is not Base64-encoded. |
404 |
ProjectNotExist |
Project does not exist. |
The specified project does not exist. |
404 |
LogStoreNotExist |
Logstore does not exist. |
The specified Logstore does not exist. |
404 |
ConsumerGroupNotExist |
consumer group not exist. |
The specified consumer group does not exist. |
404 |
ConsumerNotExist |
consumer not exist in the consumer group. |
The consumer does not exist in the specified consumer group. |
404 |
ShardNotExist |
shard not exist. |
The specified shard does not exist. |
500 |
InternalServerError |
Specified Server Error Message. |
An internal server error has occurred. |
For more information, see Common error codes.