文档首页/ 智能数据湖 AI DataLake/ API参考/ TMS管理/ 查询项目标签 - ListV2ProjectTags
更新时间：2026-10-10 GMT+08:00
查看PDF
分享

查询项目标签 - ListV2ProjectTags

功能介绍

查询指定项目关联的标签列表。此接口为同步接口，无配套使用接口和特殊场景。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/{resource_type}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

约束限制：不涉及。

取值范围：长度为1~36的英文字符、数字和中划线的组合。

默认取值：不涉及。

resource_type

是

String

参数解释：资源类型，用于指定需要打标签的资源类型。

约束限制：不能为空。

取值范围：

  • aidatalake-workspace：工作空间。

  • aidatalake-endpoint-ray：Ray引擎端点。

  • aidatalake-endpoint-aura：Aura引擎端点。

  • aidatalake-endpoint-spark：Spark引擎端点。

  • aidatalake-endpoint-flink：Flink引擎端点。

  • aidatalake-compute：计算资源。

默认取值：不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

use_predefine_tags

是

Boolean

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

约束限制：不涉及。

取值范围：

  • true：使用。

  • false：不使用。

默认取值：false。

engine_types

否

Array of strings

参数解释：端点引擎类型列表。取值包括：

  • AuraJob：AuraJob引擎。

  • SparkSql：SparkSql引擎。

  • SparkJob：SparkJob引擎。

  • FlinkJob：FlinkJob引擎。

  • AuraJobV2：AuraJobV2引擎。

  • RayCluster：RayCluster引擎。

  • RayJob：RayJob引擎。

约束限制：不涉及。

offset

否

Integer

参数解释：分页偏移量。

约束限制：不涉及。

取值范围：0~10000。

默认取值：0。

limit

否

Integer

参数解释：查询记录数。

约束限制：不涉及。

取值范围：1~1000。

默认取值：1000。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：用户Token，通过调用获取IAM用户Token接口获取。

约束限制：不涉及。

取值范围：只能由英文字母、数字及特殊字符组成，长度不超过65534个字符。Token格式由IAM服务定义，具体字符集参见IAM服务相关文档。

默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释：项目标签总记录数。

取值范围：0~2147483647。

tags

Array of V2ProjectResourceTag objects

参数解释：项目标签列表，每个元素为一个V2ProjectResourceTag对象，包含key（标签键）和values（标签值列表）字段。
表5 V2ProjectResourceTag

参数

参数类型

描述

key

String

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

取值范围：长度1~128的多语言字母、空格、数字、下划线、点、冒号、斜杠、等号、加号、减号、@符号组合。

values

Array of strings

参数解释：项目资源标签的值列表，每个元素为字符串，数组最大元素数量为1000。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案。

取值范围：长度为0~4096个字符。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案。

取值范围：长度为0~4096个字符。

状态码：403

表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 /v2/{project_id}/{resource_type}/tags?use_predefine_tags=false

响应示例

状态码：200

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

状态码：400

{
  "error_code" : "AIDataLake.00010151",
  "error_msg" : "Parameter value is invalid.",
  "solution_msg" : "Please input valid parameter value."
}

状态码：401

{
  "error_code" : "APIGW.0301",
  "error_msg" : "Incorrect IAM authentication information: decrypt token fail.",
  "solution_msg" : "Check whether the IAM authentication information is correct."
}

状态码：403

{
  "error_code" : "AIDataLake.00010150",
  "error_msg" : "The operation is not allowed.",
  "solution_msg" : "Check whether the operation is allowed in the current status."
}

状态码：408

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred",
  "solution_msg" : "Try again later. If the problem persists, contact technical support."
}

状态码：500

{
  "error_code" : "AIDataLake.00011001",
  "error_msg" : "Internal error.",
  "solution_msg" : "Contact technical support or try again later."
}

状态码

状态码

描述

200

请求成功。

400

请求参数错误。

401

未授权。

403

禁止访问。

408

请求超时。

500

内部服务器错误。
父主题： TMS管理

相关文档