文档首页/ 云数据库 GeminiDB/ API参考/ API v3(推荐)/ 标签管理/ 查询项目标签 - QueryingTagsofaSpecifiedProject
更新时间:2025-11-27 GMT+08:00

查询项目标签 - QueryingTagsofaSpecifiedProject

功能介绍

查询指定项目的标签信息。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:tag:list

    List

    -

    -

    nosql:tag:list

    -

URI

GET /v3/{project_id}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一region下的project ID。获取方法请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

索引位置,偏移量。

  • 从第一条数据偏移offset条数据后开始查询,默认为0。
  • 取值必须为数字,且不能为负数。

limit

Integer

查询个数上限值。

  • 取值范围:1~100。
  • 不传该参数时,默认查询前100条信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

tags

Array of Tag objects

标签列表。

total_count

Integer

总记录数。

表5 Tag

参数

参数类型

描述

type

String

标签类型:

  • user:表示用户自定义标签。
  • system:表示系统标签。

key

String

标签键。最大长度36个unicode字符,key不能为空。

字符集:0-9,A-Z,a-z,“_”,“-”,中文。

values

Array of strings

标签值列表。每个标签值最大长度43个unicode字符,可以为空字符串。

字符集:0-9,A-Z,a-z,“_”,“.”,“-”,中文。

请求示例

URI样例
GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/tags?offset=1&limit=10

响应示例

状态码: 200

Success.

{ 
  "tags" : [ { 
    "key" : "key1", 
    "values" : [ "value1", "value2" ], 
    "type" : "user" 
  }, { 
    "key" : "key2", 
    "values" : [ "value1", "value2" ], 
    "type" : "system" 
  } ], 
  "total_count" : 2 
}

状态码

请参见状态码

错误码

请参见错误码