gtema
6bc123a554
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: gtema <artem.goncharov@gmail.com> Co-committed-by: gtema <artem.goncharov@gmail.com>
7.0 KiB
Deleting Checkpoints
Function
This API is used to delete checkpoints.
URI
DELETE /v2/{project_id}/checkpoints
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
stream_name |
Yes |
String |
Name of the stream to which the checkpoint belongs. |
app_name |
Yes |
String |
Name of the application associated with the checkpoint. Minimum: 1 Maximum: 50 |
checkpoint_type |
Yes |
String |
Type of the checkpoint. LAST_READ: Only sequence numbers are recorded in databases. Enumeration values:
|
partition_id |
No |
String |
Identifier of the stream partition to which the checkpoint belongs. The value can be in either of the following formats:
For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, and shardId-0000000000, shardId-0000000001, shardId-0000000002, respectively. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Response Parameters
None
Example Requests
Deleting Checkpoints
DELETE https://{Endpoint}/v2/{project_id}/checkpoints
Example Responses
None
Status Codes
Status Code |
Description |
|---|---|
204 |
Normal response. |
Error Codes
See Error Codes.