Help Center/ DataArts Fabric/ API Reference/ APIs/ TMS Management/ Querying Project Tags
Updated on 2025-09-15 GMT+08:00
View PDF
Share

Querying Project Tags

Function

This API is used to query project tags. You can call this API to query the tags that have been used in a project by inputting predefined tags (when set to true, predefined tags can be queried). This API outputs project tags. This API is synchronous with no accompanying APIs or specific scenarios.

URI

GET /v1/{project_id}/fabric-workspace/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition: Project ID. For how to obtain a project ID, see [Obtaining a Project ID] (dataartsfabric_03_0020.xml).

Constraints: N/A.

Range: 1 to 36 characters. Only letters, digits, and hyphens (-) are allowed.

Default Value: N/A.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

use_predefine_tags

Yes

Boolean

Definition: Whether to use predefined tags.

Constraints: N/A.

Range: true (yes) or false (no).

Default Value: false.

offset

No

Integer

Definition: Offset where a query starts.

Constraints: N/A.

Range: [0, 1000000000].

Default Value: 0

limit

No

Integer

Definition: Number of records to be queried.

Constraints: N/A.

Range: [1, 1000].

Default Value: 1000.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Definition: Tenant token. It is used for API calling authentication. For how to obtain a token, see [Authentication] (dataartsfabric_03_0005.xml).

Constraints: N/A.

Range: Up to 65,534 characters.

Default Value: N/A.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Definition: Request ID.

Constraints: The value cannot be changed.

Range: N/A.

Default Value: N/A.
Table 5 Response body parameters

Parameter

Type

Description

tags

Array of ResourceTagParam objects

Definition: Tag list.

Constraints: [0, 100000].
Table 6 ResourceTagParam

Parameter

Type

Description

key

String

Definition: Resource tag key. For details about how to obtain a tag key, see "API Description" > "Resource Tags" > "Querying Tag Keys" in Tag Management Service API Reference.

Constraints: N/A.

Range: N/A.

Default Value: N/A.

values

Array of strings

Definition: Resource tag value list.

Constraints: N/A.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Status code: 408

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Definition: Error code.

Constraints: N/A.

Range: 8 to 36 characters.

Default Value: N/A.

error_msg

String

Definition: Error message.

Constraints: N/A.

Range: 2 to 512 characters.

Default Value: N/A.

solution_msg

String

Definition: Solution description.

Constraints: N/A.

Range: 0 to 4,096 characters.

Default Value: N/A.

Example Requests

GET https://{endpoint}/v1/{project_id}/fabric-workspace/tags

Example Responses

Status code: 200

OK

{
  "tags" : [ {
    "key" : "tag_key",
    "values" : [ "tag_value" ]
  } ]
}

Status code: 400

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

Status code: 408

Request Time-out

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

Status code: 500

InternalServerError

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

Status Codes

Status Code

Description

200

OK

400

BadRequest

401

Unauthorized

403

Forbidden

408

Request Time-out

500

InternalServerError

Error Codes

See Error Codes.

Parent topic: TMS Management