• Data Ingestion Service

dis
  1. Help Center
  2. Data Ingestion Service
  3. API Reference
  4. API Description
  5. Listing DIS Streams

Listing DIS Streams

Function

This API is used to list all the DIS streams created by the current tenant.

URL

  • URL format

    GET /v2/{project_id}/streams

  • Parameter description

    None

Request

  • Example request
    GET https://{ip}{endpoint}:{port}/v2/6352bba7aaab443aa1d9943efc586a68/streams?limit=10&start_stream_name=test_stream 
    
    Request Header: 
    Content-Type: application/json 
    X-Sdk-Date: 20180820T024248Z 
    Authorization: SDK-HMAC-SHA256 Credential=QRUP2R3QFNAOVAWMYHZW/20180820/eu-de/test/sdk_request,  
    SignedHeaders=host;x-sdk-date,  
    Signature=9d8b56b055c0e1f7a9498d881a7cb726be91b4f0cde1773b0b1557e987a480ce
  • Parameter description
    Table 1 Parameter description

    Parameter

    Mandatory

    Type

    Description

    limit

    No

    Int

    The maximum number of DIS streams to list in a single API call.

    Value range: 1 to 100

    Default value: 10

    start_stream_name

    No

    String

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

    NOTE:

    Streams in the stream list are arranged in alphabetical order.

Response

  • Example response
    {
      "total_number": 1,
      "has_more_streams": false,
      "stream_names": [
        "stream_test"
      ]
    }
  • Parameter description
    Table 2 Response parameter description

    Parameter

    Type

    Description

    total_number

    Int

    Total number of DIS streams created by the current tenant.

    stream_names

    List<String>

    Name of the list of the streams meeting the current requests.

    has_more_streams

    Boolean

    Specify whether there are more matching DIS streams to list. Possible values:

    • true: There are more streams.
    • false: There are no more streams.

Status Code

  • Normal

    200 OK

  • Failed

    For more information, see Error Codes.