Updates the checkpoint of a shard for a consumer group.
Operation description
- 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 Simple 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 Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (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 Simple Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Simple 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
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| log:ConsumerGroupUpdateCheckPoint | update | *All Resources * |
| none |
Request syntax
POST /logstores/{logstore}/consumergroups/{consumerGroup}?type=checkpoint HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| project | string | Yes | The name of the project. | ali-test-project |
| logstore | string | Yes | The name of the Logstore. | ali-test-logstore |
| consumerGroup | string | Yes | The name of the consumer group. | consumer_group_test |
| consumer | string | Yes | The consumer. | consumer_1 |
| forceSuccess | boolean | No | Specifies whether to enable forceful updates. Valid values:
| False |
| body | object | No | The ID of the shard. | |
| shard | integer | Yes | The ID of the shard. | 0 |
| checkpoint | string | Yes | The value of the checkpoint. | MTUyNDE1NTM3OTM3MzkwODQ5Ng== |
Response parameters
Examples
Sample success responses
JSONformat
{}Error codes
For a list of error codes, visit the Service error codes.