查询资源标签
接口说明
查询指定实例的标签信息。
约束说明
一个文档数据库实例具有20个标签配额,且标签key唯一。
调试
您可以在API Explorer中调试该接口。
URI
请求消息
参数说明
名称 |
类型 |
IN |
是否必选 |
描述 |
---|---|---|---|---|
X-Auth-Token |
string |
header |
是 |
参数解释: 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
project_id |
string |
path |
是 |
参数解释: 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
instance_id |
string |
path |
是 |
参数解释: 实例ID,可以调用“查询实例列表和详情”接口获取。如果未申请实例,可以调用“创建实例”接口创建。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应消息
- 参数说明
表2 参数说明 名称
是否必选
参数类型
描述
tags
是
Array of objects
实例标签列表。详情请参见表3。
表3 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" } ] }
SDK
单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。