Submitting Checkpoints¶
Function¶
This API is used to submit checkpoints.
URI¶
POST /v2/{project_id}/checkpoints
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
X-Auth-Token | Yes | String | User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
app_name | Yes | String | Name of the app, which is the unique identifier of a user data consumption program. |
checkpoint_type | Yes | String | Type of the checkpoint
Enumeration values:
|
stream_name | Yes | String | Name of the stream. |
partition_id | Yes | String | Partition ID of the stream The value can be in either of the following formats:- shardId-0000000000- 0 For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively. |
sequence_number | Yes | String | Sequence number to be submitted, which is used to record the consumption checkpoint of the stream. Ensure that the sequence number is within the valid range. |
metadata | No | String | Metadata information of the consumer application The metadata information can contain a maximum of 1,000 characters. Maximum: 1000 |
Response Parameters¶
None
Example Requests¶
Submitting Checkpoints
POST https://{Endpoint}/v2/{project_id}/checkpoints
{
"stream_name" : "newstream",
"app_name" : "newapp",
"partition_id" : "0",
"sequence_number" : "2",
"checkpoint_type" : "LAST_READ"
}
Example Responses¶
None
Status Codes¶
Status Code | Description |
|---|---|
201 | Normal response. |
Error Codes¶
See Error Codes.