Updated on 2025-09-08 GMT+08:00

Querying the Pipeline Tags

Function

This API is used to query the pipeline tags.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/pipeline-tag/list

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

proj_id

No

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

[items]

Array of PipelineTagResp objects

Definition:

Tag response body.

Value range:

N/A

Table 4 PipelineTagResp

Parameter

Type

Description

tag_id

String

Definition:

Tag ID.

Value range:

The value consists of 32 characters, including digits and letters.

name

String

Definition:

Tag name.

Value range:

N/A

color

String

Definition:

Tag color.

Value range:

N/A

project_id

String

Definition:

Project ID.

Value range:

The value consists of 32 characters, including digits and letters.

project_name

String

Definition:

Project name.

Value range:

N/A

Example Requests

GET https://{endpoint}/db8d07265e24426598b3eb03a7818972/v5/api/pipeline-tag/list?proj_id=db8d07265e24426598b3eb03a7818972

Example Responses

Status code: 200

Response body.

[ {
  "tag_id" : "707b6711d3484578a1d848d889a7fa60",
  "name" : "1",
  "color" : "#0b81f6",
  "project_id" : "db8d07265e24426598b3eb03a7818972",
  "project_name" : "cjrTest"
} ]

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.