Help Center> Data Ingestion Service> API Reference> API Description> Creating an Application
View PDF

Creating an Application

Function

This API is used to create an application.

  • Application: Multiple applications can access data in the same stream. Checkpoints generated for each application are used to record the consumed data in the stream by each application.
  • An application and checkpoint are used together. When adding a checkpoint, you need to specify an application name. For details about how to add a checkpoint, see Adding a Checkpoint.

    Checkpoint: When an application consumes data, the latest SN of the consumed data is recorded as a checkpoint. When the data is reconsumed, the consumption can be continued based on this checkpoint.

URL

  • URI format

    POST /v2/{project_id}/apps

  • Parameter description

    None

Request

  • Example request 
    POST https://{endpoint}/v2/{project_id}/apps

{
  "app_name": "app_test"
}
  • Parameter description
    Table 1 Parameter description

    Parameter

    Mandatory

    Type

    Description

    app_name

    Yes

    String

    Unique name of the consumer application to be created.

    An application name is 1 to 200 characters long. Only letters, digits, hyphens (-), and underscores (_) are allowed.

Response

  • If the DIS stream was successfully created, a 201 response with an empty response body is returned.
  • 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

    201 Created

  • Failed

    For more information, see Error Codes.

Parent topic: API Description