文档首页/ 湖仓构建 LakeFormation/ API参考/ API/ Console类API/ 标签管理服务/ 查询资源标签集合 - ListLakeFormationInstanceTags
更新时间:2026-08-11 GMT+08:00
分享

查询资源标签集合 - ListLakeFormationInstanceTags

功能介绍

查询租户在指定Project中实例类型的所有资源标签集合。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

GET /v1/{project_id}/lakeformation-instance/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

use_predefine_tags

Boolean

参数解释:

使用预定义标签,true表示使用

约束限制:

不涉及

取值范围:

不涉及

默认取值:

false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

租户token

约束限制:

长度为0~65534个字符

取值范围:

长度为0~65534个字符

默认取值:

不涉及

响应参数

状态码:200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,定位辅助信息。

表5 响应Body参数

参数

参数类型

描述

tags

Array of ResourceTagParam objects

参数解释:

标签

表6 ResourceTagParam

参数

参数类型

描述

key

String

参数解释:

资源标签的键

取值范围:

长度为0~128个字符

values

Array of strings

参数解释:

资源标签的值列表

取值范围:

长度为0~255个字符,数组元素个数为0~100000

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

common_error_code

String

参数解释:

CBC公共错误码

solution_msg

String

参数解释:

解决方案描述

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

common_error_code

String

参数解释:

CBC公共错误码

solution_msg

String

参数解释:

解决方案描述

状态码:403

表9 响应Body参数

参数

参数类型

描述

error

Error object

参数解释:

错误信息

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

title

String

参数解释:

标题

表10 Error

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

title

String

参数解释:

标题

message

String

参数解释:

错误信息

code

String

参数解释:

状态码

状态码:404

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

common_error_code

String

参数解释:

CBC公共错误码

solution_msg

String

参数解释:

解决方案描述

状态码:408

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

common_error_code

String

参数解释:

CBC公共错误码

solution_msg

String

参数解释:

解决方案描述

状态码:500

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

common_error_code

String

参数解释:

CBC公共错误码

solution_msg

String

参数解释:

解决方案描述

请求示例

GET https://{endpoint}/v1/{project_id}/lakeformation-instance/tags

响应示例

状态码:200

查询资源标签集合

{
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1" ]
  }, {
    "key" : "key2",
    "values" : [ "value2" ]
  } ]
}

状态码:400

Bad Request

{
  "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",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码:404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码:408

Request Timeout

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

状态码:500

Internal Server Error

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

状态码

状态码

描述

200

查询资源标签集合

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

错误码

请参见错误码

相关文档