文档首页/ 文档数据库服务 DDS/ API参考/ API v3（推荐）/ 标签管理/ 查询资源标签
更新时间：2025-10-24 GMT+08:00
查看PDF
分享

查询资源标签

功能介绍

查询指定实例的标签信息。

接口约束

一个文档数据库实例具有20个标签配额，且标签key唯一。

URI

  • URI格式

    GET /v3/{project_id}/instances/{instance_id}/tags

表1 路径参数

名称

是否必选

类型

IN

描述

project_id

是

string

path

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

string

path

参数解释：

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

名称

是否必选

类型

IN

描述

X-Auth-Token

是

string

header

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

表3 参数说明

名称

是否必选

参数类型

描述

tags

是

Array of objects

实例标签列表。详情请参见表4。
表4 tags字段数据结构说明

名称

是否必选

参数类型

描述

key

是

String

标签键。

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

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

value

是

String

标签值。

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

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

请求示例

https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/tags

响应示例

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

SDK

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

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 标签管理