All Products
Search

This Product

    :ConsumerGroupUpdateCheckPoint

    Document Center

    :ConsumerGroupUpdateCheckPoint

    Last Updated:Jul 25, 2024

    Updates the data consumption progress.

    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

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request syntax

    POST /logstores/{logstore}/consumergroups/{consumerGroup}?type=checkpoint

    Request parameters

    ParameterTypeRequiredDescriptionExample
    projectstringYes

    The name of the project.

    		ali-test-project
    logstorestringYes

    The name of the Logstore.

    		ali-test-logstore
    consumerGroupstringYes

    The name of the consumer group.

    		consumer_group_test
    consumerstringYes

    The consumer.

    		consumer_1
    forceSuccessbooleanNo

    Specifies whether to enable forceful updates. Valid values:

    • true
    • false
    		False
    bodyobjectNo

    The ID of the shard.

    shardintegerYes

    The ID of the shard.

    		0
    checkpointstringYes

    The value of the checkpoint.

    		MTUyNDE1NTM3OTM3MzkwODQ5Ng==

    Response parameters

    ParameterTypeDescriptionExample
    headersobject
    Serverstring

    The name of the server.

    		nginx
    Content-Typestring

    The type of the response body.

    		application/json
    Content-Lengthstring

    The length of the response body.

    		0
    Connectionstring

    Indicates whether the connection is persistent. Valid values:

    • close: The connection is non-persistent. A new TCP connection is established for each HTTP request.
    • keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth is consumed to establish new connections.
    		close
    Datestring

    The time when the response was returned.

    		Sun, 27 May 2018 08:25:04 GMT
    x-log-requestidstring

    The request ID.

    		5B0A6B60BB6EE39764D458B5

    Examples

    Sample success responses

    JSONformat

    {}

    Error codes

    For a list of error codes, visit the Service error codes.