文档首页/数智融合计算服务 DataArts Fabric/API参考/API/TMS管理/查询项目标签 - ListFabricProjectTags
更新时间：2025-12-23 GMT+08:00
查看PDF
分享

查询项目标签 - ListFabricProjectTags

功能介绍

查询项目标签。通过该接口可查询该项目已使用的标签；支持输入：使用预定义标签（为true时可查询预定义的标签）；输出为项目标签。此接口为同步接口，无配套使用接口和特殊场景。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：项目ID。获取方法，请参见获取项目ID。

约束限制：不涉及。

取值范围：长度为[1,36]的英文字符、数字和中划线(-)的组合。

默认取值：不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

use_predefine_tags

是

Boolean

参数解释：使用预定义标签。

约束限制：不涉及。

取值范围：true表示使用，false表示不使用。

默认取值：false。

offset

否

Integer

参数解释：偏移量，表示从此偏移量开始查询。

约束限制：不涉及。

取值范围：[0,1000000000]。

默认取值：0。

limit

否

Integer

参数解释：查询记录数。

约束限制：不涉及。

取值范围：[1,1000]。

默认取值：1000。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释：租户Token。用于调用接口的认证。获取方法，请参见认证鉴权。

约束限制：不涉及。

取值范围：长度不超过65534个字符。

默认取值：不涉及。

响应参数

状态码：200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释：请求ID。

约束限制：不可修改。

取值范围：不涉及。

默认取值：不涉及。

表5 响应Body参数

参数

参数类型

描述

tags

Array of ResourceTagParam objects

参数解释：标签列表。

约束限制：[0,100000]。

表6 ResourceTagParam

参数

参数类型

描述

key

String

参数解释：资源标签的键。

约束限制：不涉及。

取值范围：见查询标签键列表。

默认取值：不涉及。

values

Array of strings

参数解释：资源标签的值列表。

约束限制：不涉及。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

状态码：408

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

请求示例

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

响应示例

状态码：200

OK

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

状态码：400

BadRequest

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

状态码：401

Unauthorized

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

状态码：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"
}

状态码：408

Request Time-out

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

状态码：500

InternalServerError

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

状态码

状态码

描述

200

OK

400

BadRequest

401

Unauthorized

403

Forbidden

408

Request Time-out

500

InternalServerError

错误码

请参见错误码。

父主题：TMS管理