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

Querying an Application List

Function

This API is used to query an application list.

During query, you need to specify the application from which the application list is returned and the maximum number of applications returned in a single request.

URI

  • URI format

    GET /v2/{project_id}/apps

  • Parameter description

    None

Request

  • Example request 
    GET https://{endpoint}/v2/{project_id}/apps?limit=10&start_app_name=app_test
  • Parameter description
    Table 1 Parameter description

    Parameter

    Mandatory

    Type

    Description

    limit

    No

    Int

    Maximum number of applications to list in a single API call.

    Value range: 1 to 100

    Default value: 10

    start_app_name

    No

    String

    Name of the application to start the list with. The returned application list does not contain this application name.

    stream_name

    No

    String

    Name of the stream whose application list will be returned.

Response

  • Example response
{
    "has_more_app": false,
    "apps": [
        {
            
            "app_id": "LGxEy8EvtdgzM7mSJfJ",
            "app_name": "app",
            "create_time": 1522313108126
        },
        {
           
            "app_id": "xzRSZhpRN1x0BBgT0fR",
            "app_name": "dis-consumer-example",
            "create_time": 1532760945216
        }
    ]
}
Table 2 Response parameter description

Parameter

Type

Description

has_more_app

Boolean

Specifies whether there are more matching consumer applications to list.

  • true: There are more consumer applications.
  • false: There are no more consumer applications.

apps

List<App>

AppEntry list that meets the current request.
Table 3 Application parameter description

Parameter

Type

Description

app_id

String

ID of the consumer application.

app_name

String

Name of the consumer application.

create_time

Long

Time when the consumer application is created. Unit: ms

Status Code

  • Normal

    200 OK

  • Failed

    For more information, see Error Codes.

Parent topic: API Description