Querying Tags of Specified Streams¶

Function¶

This API is used to query tags of specified streams.

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

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
stream_id	Yes	String	Stream ID.

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Status code: 200

**Table 3** Response body parameters¶
Parameter	Type	Description
tags	Array of Tag objects	Label list.

**Table 4** Tag¶
Parameter	Type	Description
key	String	Key It cannot be left blank. It must be unique for each resource. It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF). Minimum: 1 Maximum: 36
value	String	Value It can contain a maximum of 43 characters. It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF). It can only contain digits, letters, hyphens (-), and underscores (_). Minimum: 0 Maximum: 43

This API is used to query tags of specified streams.

GET https://{Endpoint}/v2/{project_id}/stream/{stream_id}/tags

Status code: 200

Response body of the stream tag information.

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

Status Code	Description
200	Response body of the stream tag information.

last updated: 2024-12-10 14:41 UTC - commit: db5044b39a741a136a48819e0e9f85c1f48090c6