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

查询资源标签

接口说明

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

约束说明

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

URI

  • URI格式

    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

是

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

instance_id

string

path

是

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

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户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，“_”，“.”，“-”。

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

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题：标签管理