5.9 标签管理
5.9.1 查询资源实例
功能介绍
根据标签查询指定的数据库实例。
接口约束
一个文档数据库实例具有20个标签配额，且标签key唯一。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
POST https://{Endpoint}/v3/{project_id}/instances/action
● URI样例
https://dds.cn-north-1.myhuaweicloud.com/
v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/action
● 参数说明
表5-160 参数说明
名称 是否必选 描述
project_id 是 租户在某一region下的project ID。
请求消息
● 参数说明
表5-161 参数说明
名称 是否必选 参数类型 描述
offset 否 String 索引位置偏移量，表示从第一条
数据偏移offset条数据后开始查 询。
● “action”值为“count”
时，不传该参数。
● “action”值为“filter”
时，取值必须为数字，不能 为负数。默认取0值，表示从 第一条数据开始查询。
limit 否 String 查询记录数。
● “action”值为“count”
时，不传该参数。
● “action”值为“filter”
时，取值范围：1~100。不 传该参数时，默认查询前100 条实例信息。
action 是 String 操作标识。
● 取值为“filter”，表示根据 标签过滤条件查询实例。
● 取值为“count”，表示仅返 回总记录数，禁止返回其他 字段。
matches 否 Array of
objects 搜索字段。
● 该字段值为空，表示不按照 实例名称或实例ID查询。
● 该字段值不为空，具体值请 参见表5-163。
tags 否 Array of
objects 包含标签，最多包含20个key。
详情请参见表5-162。
表5-162 tags 字段数据结构说明
名称 是否必选 参数类型 描述
key 是 String 标签键。最大长度36个unicode
字符，key不能为空或者空字符 串，不能为空格，校验和使用之 前先排除前后半角空格。
说明
搜索时不对该参数做字符集校验。
名称 是否必选 参数类型 描述 values 是 Array of
strings 标签值列表。最大长度43个 unicode字符，不能为空格，校 验和使用之前先排除前后半角空 格。
如果values为空列表，则表示查 询任意value。value之间为或的 关系。
表5-163 matches 字段数据结构说明
名称 是否必选 参数类型 描述
key 是 String 取值为“instance_name”或
“instance_id”，分别表示按实 例名称或按实例ID匹配查询。
value 是 String 待匹配的实例名称或实例ID，可
以调用“查询实例列表”接口获 取。如果未申请实例，可以调用
“创建实例”接口创建。
● 请求体样例
根据标签查询指定实例：
{ "offset": "100", "limit": "100", "action": "filter", "matches": [ {
"key": "instance_name", "value": "test-single"
} ], "tags": [ {
"key": "key1", "values": [ "value1", "value2"
] } ]}
查询总记录数：
] }, {
"key": "key2", "values": [ "value1", "value2"
] }
], "matches": [ {
"key": "instance_name", "value": "test-single"
}, {
"key": "instance_id",
"value": "958693039f284d6ebfb177375711072ein02"
} ]}
响应消息
● 要素说明
表5-164 要素说明
名称 参数类型 描述
instances Array of objects 实例列表。详情请参见表5-165。
total_count Integer 总记录数。
表5-165 instance 字段数据结构说明
名称 参数类型 描述
instance_id String 实例ID，可以调用“查询实例列 表”接口获取。如果未申请实例，
可以调用“创建实例”接口创建。
instance_name String 实例名称。
tags Array of objects 标签列表。如果没有标签，默认为 空数组。详情请参见表5-166。
表5-166 tags 字段数据结构说明
名称 参数类型 描述
key String 标签键。最大长度36个unicode字
符，key不能为空。
字符集：0-9，A-Z，a-z，“_”，
“-”，中文。
value String 标签值。最大长度43个unicode字 符，可以为空字符串。
字符集：0-9，A-Z，a-z，“_”，
“.”，“-”，中文。
● 响应样例
根据标签返回指定实例：
{ "instances": [ {
"instance_id": "2acbf2223caf3bac3c33c6153423c3ccin02", "instance_name": "test-single",
"tags": [ {
"key": "key1", "value": "value1"
}, {
"key": "key2", "value": "value1"
} ] } ]}
返回总记录数：
{ "total_count": 4 }
状态码
详情请参见状态码。
错误码
详情请参见错误码。
接口约束
● 一个文档数据库实例具有20个标签配额，且标签key唯一。
– 添加标签时，如果请求体中存在重复key，调用该接口将会报错。
– 添加标签时，如果请求体中的key与指定实例已有的key重复，将会覆盖已有 key对应的value的值。
● 如果待删除的标签不存在，调用该接口将默认处理成功，删除时，不对标签字符 集范围做校验。该场景下，要求请求体中tags结构体不能缺失，且key不能为空，
或者空字符串。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags/action
● URI样例
https://dds.cn-north-1.myhuaweicloud.com/
v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/
cc6345c64cec47499182467ea0dd432ain02/tags/action
● 参数说明
表5-167 参数说明
名称 是否必选 描述
project_id 是 租户在某一region下的project ID。
instance_id 是 实例ID，可以调用“查询实例列表”接口获取。
如果未申请实例，可以调用“创建实例”接口创 建。
请求消息
● 参数说明
表5-168 参数说明
名称 是否必选 参数类型 描述
action 是 String 操作标识。取值：
● create，表示添加标签。
● delete，表示删除标签。
名称 是否必选 参数类型 描述
tags 是 Array of
objects 标签列表。详情请参见表 5-169。
说明
删除标签时，不对该参数做字符集 校验。
表5-169 tags 字段数据结构说明
名称 是否必选 参数类型 描述
key 是 String 标签键。最大长度36个unicode
字符，不能为null或者空字符 串，不能为空格，校验和使用 之前会自动过滤掉前后空格。
字符集：0-9，A-Z，a-z，
“_”，“-”，中文。
value 否 String 标签值。最大长度43个unicode 字符，可以为空字符串，不能 为空格，校验和使用之前会自 动过滤掉前后空格。
字符集：0-9，A-Z，a-z，
“_”，“.”，“-”，中文。
● “action”值为“create”
时，该参数必选。
● “action”值为“delete”
时，该参数可选。
说明删除标签时，如果value有值，
则按照key/value匹配删除；如 果value没有值，则按照key删 除。
● 请求体样例 添加标签：
{ "action": "create", "tags": [
{
"key": "key1", "value": "value1"
},
{ "action": "delete", "tags": [
{
"key": "key1"
}, {
"key": "key2", "value": "value3"
} ]}
响应消息
{}
状态码
详情请参见状态码。
错误码
详情请参见错误码。
5.9.3 查询资源标签
功能介绍
查询指定实例的标签信息。
接口约束
一个文档数据库实例具有20个标签配额，且标签key唯一。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags
● URI样例
https://dds.cn-north-1.myhuaweicloud.com/
v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/
cc6345c64cec47499182467ea0dd432ain02/tags
● 参数说明
表5-170 参数说明
名称 是否必选 描述
project_id 是 租户在某一region下的project ID。
instance_id 是 实例ID，可以调用“查询实例列表”接口获取。
如果未申请实例，可以调用“创建实例”接口创 建。
请求消息
无。
响应消息
● 参数说明
表5-171 参数说明
名称 是否必选 参数类型 描述
tags 是 Array of objects 实例标签列表。详情请参见 表5-172。
表5-172 tags 字段数据结构说明
名称 是否必选 参数类型 描述
key 是 String 标签键。最大长度36个
unicode字符，key不能为 空。
字符集：0-9，A-Z，a-z，
“_”，“-”，中文。
value 是 String 标签值。最大长度43个
unicode字符，可以为空字符 串。
字符集：0-9，A-Z，a-z，
“_”，“.”，“-”，中 文。
● 响应样例 {
} ]}
状态码
详情请参见状态码。
错误码
详情请参见错误码。
5.9.4 查询项目标签
功能介绍
查询指定project ID下实例的所有标签集合。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
GET https://{Endpoint}/v3/{project_id}/tags
● URI样例
https://dds.cn-north-1.myhuaweicloud.com/
v3/0549b4a43100d4f32f51c01c2fe4acdb/tags
● 参数说明
表5-173 参数说明
名称 是否必选 描述
project_id 是 租户在某一region下的project ID。
请求消息
无。
响应消息
● 参数说明
表5-174 参数说明
名称 是否必选 参数类型 描述
tags 是 Array of
objects 标签列表。详情请参见表 5-175。
表5-175 tags 字段数据结构说明
名称 是否必选 参数类型 描述
key 是 String 标签键。最大长度36个
unicode字符，key不能为 空。
字符集：0-9，A-Z，a-z，
“_”，“-”，中文。
values 是 Array of
strings 标签值列表。标签值最大长 度43个unicode字符，可以为 空字符串。
字符集：0-9，A-Z，a-z，
“_”，“-”，中文。
● 响应样例 { "tags": [ {
"key": "key1", "values": [ "value1", "value2"
] }, {
"key": "key2", "values": [ "value1", "value2"
] } ]}
状态码
详情请参见状态码。
5.10.1 创建数据库用户
功能介绍
给指定实例创建数据库用户。
接口约束
● 该接口只支持DDS社区版。
● 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非
“normal”时，不允许执行该操作。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-user
● URI样例
https://dds.cn-north-1.myhuaweicloud.com/
v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/
f032c0db12d147ef87317efdfacbbe15in02/db-user
● 参数说明
表5-176 参数说明
名称 是否必选 描述
project_id 是 租户在某一region下的project ID。
instance_id 是 实例ID，可以调用“查询实例列表”接口获取。
如果未申请实例，可以调用“创建实例”接口创 建。
请求消息
● 参数说明
表5-177 参数说明
名称 是否必选 参数类型 描述
user_name 是 String 数据库用户名称。
取值范围：长度为1~64位，可 以包含大写字母（A~Z）、小写 字母（a~z）、数字（0~9）、
中划线、下划线和点。
名称 是否必选 参数类型 描述
user_pwd 是 String 数据库用户密码。
● 取值范围：长度为8~32位，
必须是大写字母（A~Z）、
小写字母（a~z）、数字
（0~9）、特殊字符~!@#
%^*-_=+?的组合。
● 建议您输入高强度密码，以 提高安全性，防止出现密码 被暴力破解等安全风险。
roles 是 Array of
Object 新用户所拥有的角色。请参见表 5-178。
db_name 否 String 新用户所在的数据库，默认为
“admin”。
取值范围：长度为1~64位，可 以包含大写字母（A~Z）、小写 字母（a~z）、数字（0~9）、
下划线。
表5-178 roles 字段数据结构说明
名称 是否必选 参数类型 描述
role_db_name 是 String 授予新用户所拥有的角色所在数 据库名称。
取值范围：长度为1~64位，可 以包含大写字母（A~Z）、小写 字母（a~z）、数字（0~9）、
下划线。
role_name 是 String 授予新用户所拥有的角色名称。
取值范围：长度为1~64位，可 以包含大写字母（A~Z）、小写 字母（a~z）、数字（0~9）、
中划线、下划线和点。
● 请求体样例
{ "user_name":"test" , "user_pwd":"******", "roles":[{
响应消息
● 响应样例 {}
状态码
详情请参见状态码。
错误码
详情请参见错误码。
5.10.2 创建数据库角色
功能介绍
给指定实例创建数据库角色。
接口约束
● 该接口只支持DDS社区版。
● 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非
“normal”时，不允许执行该操作。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-role
● URI样例
https://dds.cn-north-1.myhuaweicloud.com/
v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/
659914406d2c4c76bce6a028ce8d8e0din02/db-role
● 参数说明
表5-179 参数说明
名称 是否必选 描述
project_id 是 租户在某一region下的project ID。
instance_id 是 实例ID，可以调用“查询实例列表”接口获取。
如果未申请实例，可以调用“创建实例”接口创 建。
请求消息
● 参数说明
表5-180 参数说明
名称 是否必选 参数类型 描述
role_name 是 String 创建角色名称。
取值范围：长度为1~64位，可 以包含大写字母（A~Z）、小写 字母（a~z）、数字（0~9）、
中划线、下划线和点。
roles 否 Array of
objects 新建角色所继承的角色列表。请 参见表5-181。
db_name 否 String 角色所在的数据库名称，默认
admin。
取值范围：长度为1~64位，可 以包含大写字母（A~Z）、小写 字母（a~z）、数字（0~9）、
下划线。
表5-181 roles 字段数据结构说明
名称 是否必选 参数类型 描述
role_db_name 是 String 被继承角色所在数据库名称。
取值范围：长度为1~64位，可 以包含大写字母（A~Z）、小写 字母（a~z）、数字（0~9）、
下划线。
role_name 是 String 被继承角色的名称。
取值范围：长度为1~64位，可 以包含大写字母（A~Z）、小写 字母（a~z）、数字（0~9）、
中划线、下划线和点。
● 请求体样例
{ "role_name": "testRole", "roles" : [{
"role_name":"readWrite",
响应消息
● 响应样例 {}
状态码
详情请参见状态码。
错误码
详情请参见错误码。
5.10.3 查询数据库用户列表
功能介绍
查询数据库用户列表。
接口约束
● 该接口支持DDS社区版。
● 实例在创建、规格变更、修改端口、重启等过程中以及状态为非“normal”时，
不允许执行该操作。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-user/detail?
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-user/detail?