文档首页/ 文档数据库服务 DDS/ API参考/ API v3(推荐)/ 标签管理/ 查询项目标签-QueryingTagsinaSpecifiedProject
更新时间:2025-11-25 GMT+08:00
分享

查询项目标签-QueryingTagsinaSpecifiedProject

接口说明

查询指定project ID下实例的所有标签集合。

调试

您可以在API Explorer中调试该接口。

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    dds:tag:listAll

    list

    -

    -

    -

    -

URI

  • URI格式

    GET /v3/{project_id}/tags

  • URI样例

    https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/tags

表1 请求参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

参数解释:

从IAM服务获取的用户Token。请参考认证鉴权

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

project_id

string

path

参数解释:

租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求消息

无。

响应消息

  • 参数说明
    表2 参数说明

    名称

    是否必选

    参数类型

    描述

    tags

    Array of objects

    标签列表。详情请参见表3

    表3 tags字段数据结构说明

    名称

    是否必选

    参数类型

    描述

    key

    String

    标签键。

    • key不能为空,长度1~128个半角字符。
    • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @。
    • _sys_开头属于系统标签,租户不能输入。

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

    values

    Array of strings

    标签值列表。

    • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @。
    • 可以为空(empty or null),长度0~255个半角字符。

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

  • 响应示例
    {
      "tags": [
        {
          "key": "key1",
          "values": [
            "value1",
            "value2"
          ]
        },
        {
          "key": "key2",
          "values": [
            "value1",
            "value2"
          ]
        }
      ]
    }

SDK

单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码

错误码

详情请参见错误码

相关文档