• Data Ingestion Service

dis
  1. Help Center
  2. Data Ingestion Service
  3. API Reference
  4. API Description
  5. Tag Management APIs
  6. Querying a Tag of a Specified Stream

Querying a Tag of a Specified Stream

Function

This API is used to query a tag of a specified stream.

URI

GET /v2/{project_id}/stream/{stream_id}/tags

The following table describes URI parameters.

Table 1 URI parameter description

Parameter

Mandatory

Description

project_id

Yes

Project ID. For details about how to obtain the project ID, see Obtaining Project IDs.

stream_id

Yes

Stream ID.

Request

Request parameters

None

Response

Response parameter

The following table describes the response parameters.

Table 2 Response parameters

Parameter

Mandatory

Type

Description

tags

No

List<tag>

Tag list.

key

Yes

String

Key.

A tag key consists of a maximum of 36 characters, including A-Z, a-z, 0-9, hyphens (-), and underscores (_).

value

Yes

String

Value.

The value consists of a maximum of 43 characters, including A-Z, a-z, 0-9, periods (.), hyphens (-), and underscores (_), and can be an empty string.

Example

  • Request example

    None

  • Response example
    { 
           "tags": [ 
            { 
                "key": "key1", 
                "value": "value1" 
            }, 
            { 
                "key": "key2", 
                "value": "value3" 
            } 
        ] 
    } 

Status Code

Table 3 lists the status code of this API.

Table 3 Status code

Status Code

Description

200

OK