Help Center> Data Ingestion Service> API Reference> API Description> Deleting a Checkpoint
View PDF

Deleting a Checkpoint

Function

This API is used to delete a checkpoint.

When deleting a checkpoint, you need to specify the stream name, partition ID, and application name.

URI

  • URI format

    DELETE /v2/{project_id}/checkpoints

  • Parameter description

    None

Request

  • Example request 
    DELETE https://{endpoint}/v2/{project_id}/ checkpoints?stream_name=test&app_name=app
    • Parameter description
      Table 1 Parameter description

      Parameter

      Mandatory

      Type

      Description

      stream_name

      Yes

      String

      Name of the stream created on the management console.

      A stream name is 1 to 64 characters long. Only letters, digits, hyphens (-), and underscores (_) are allowed.

      partition_id

      No

      String

      Unique identifier of the partition.

      app_name

      Yes

      String

      Unique ID of the consumer application. An application name is 1 to 50 characters long. Only letters, digits, hyphens (-), and underscores (_) are allowed.

      checkpoint_type

      No

      String

      Type of the checkpoint.

      LAST_READ indicates that only sequence numbers are recorded into the database.

Response

  • If the DIS stream was successfully deleted, a 204 response with an empty response body is returned. For details about status codes, see Status Codes.
  • If the DIS stream failed to be created, identify the failure cause according to the response body and the instructions in Error Codes.

Status Code

  • Normal

    204 NOCONTENT

  • Failed

    For more information, see Error Codes.

Parent topic: API Description