为一个或多个MongoDB实例绑定标签。
接口说明
在实例数量较多的情况下,您可以创建多个标签,为实例绑定不同的标签对其进行分类,后续可通过标签筛选实例。
标签由一对键(key)值(value)组成,键在同账号同地域下唯一,值无此限制。
若设置的标签不存在,则自动创建该标签并绑定到目标实例。
若实例已经绑定了有相同键的标签,则会覆盖绑定。
每个实例最多可以绑定 20 个标签。
每次调用最多可以对 50 个实例执行批量标签绑定。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dds:TagResources |
update |
*Instance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
实例所属的地域 ID,您可以调用 DescribeDBInstanceAttribute 接口查询。 |
cn-hangzhou |
| ResourceType |
string |
是 |
资源类型,取值固定为 INSTANCE。 |
INSTANCE |
| ResourceGroupId |
string |
否 |
资源组 ID。 |
rg-acfmyiu4ekp**** |
| ResourceId |
array |
是 |
实例和标签信息列表。 |
dds-bpxxxxxxxx |
|
string |
否 |
实例列表。 N 表示传入第几个实例的 ID,N 的取值范围为 1~50。例如:
|
dds-bp1fa5efaa93**** |
|
| Tag |
array<object> |
是 |
标签信息列表。 |
|
|
object |
否 |
|||
| Key |
string |
是 |
标签的键。 N 表示传入第几个标签的键,N 的取值范围为 1~20。例如:
|
开发组 |
| Value |
string |
是 |
标签的值。 N 表示传入第几个标签的值,N 的取值范围为 1~20。例如:
|
4.0环境 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
0FDDC511-7252-4A4A-ADDA-5CB1BF63**** |
示例
正常返回示例
JSON格式
{
"RequestId": "0FDDC511-7252-4A4A-ADDA-5CB1BF63****"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidTagKey.Malformed | The specified parameter 'Tag.n.Key' or 'TagKey.n' is not valid. | 指定的参数“Tag.n.Key”或“TagKey.n”无效。 |
| 400 | InvalidTagValue.Malformed | The specified parameter 'Tag.n.Value' is not valid. | |
| 400 | InvalidParameter.ResourceId | The specified parameter 'ResourceId.n' is not valid. | |
| 400 | MissParameter.TagOrResourceId | The parameter 'Tag.n'' or 'ResourceId.n' is needed. | |
| 400 | InvalidParameter.Scope | The specified parameter 'Scope' is not valid. | |
| 400 | NumberExceed.ResourceIds | The ResourceIds parameter's number is exceed. | |
| 400 | NumberExceed.Tags | The Tags parameter's number is exceed. | |
| 400 | NumberExceed.CustomTags | The Custom Tags parameter's number is exceed. Valid 20. | |
| 400 | Duplicate.TagKey | The specified parameter 'Tag.n.Key' is duplicated. | |
| 400 | InvalidParameter.ResourceType | The specified parameter 'ResourceType' is not valid. | |
| 404 | InvalidDbInstanceId.NotFound | Specified instance does not exist. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。