文档

TagResources - 为一个或多个MongoDB实例绑定标签

为一个或多个MongoDB实例绑定标签。

接口说明

在实例数量较多的情况下,您可以创建多个标签,为实例绑定不同的标签对其进行分类,后续可通过标签筛选实例。

  • 标签由一对键(key)值(value)组成,键在同账号同地域下唯一,值无此限制。
  • 若设置的标签不存在,则自动创建该标签并绑定到目标实例。
  • 若实例已经绑定了有相同键的标签,则会覆盖绑定。
  • 每个实例最多可以绑定 20 个标签。
  • 每次调用最多可以对 50 个实例执行批量标签绑定。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dds:TagResourcesWrite
  • Instance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

实例所属的地域 ID,您可以调用 DescribeDBInstanceAttribute 接口查询。

cn-hangzhou
ResourceTypestring

资源类型,取值固定为 INSTANCE

INSTANCE
ResourceGroupIdstring

资源组 ID。

rg-acfmyiu4ekp****
ResourceIdarray

实例和标签信息列表。

string

实例和标签信息列表。

N 表示传入第几个实例的 ID,N 的取值范围为 1~50。例如:

  • ResourceId.1表示传入第一个实例 ID。
  • ResourceId.2表示传入第二个实例 ID。
dds-bp1fa5efaa93****
Tagobject []

标签信息列表。

Keystring

标签的键。

N 表示传入第几个标签的键,N 的取值范围为 1~20。例如:

  • Tag.1.Key表示传入第一个标签的键。
  • Tag.2.Key表示传入第二个标签的键。
开发组
Valuestring

标签的值。

N 表示传入第几个标签的值,N 的取值范围为 1~20。例如:

  • Tag.1.Value表示传入第一个标签的值。
  • Tag.2.Value表示传入第二个标签的值。
4.0环境

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

0FDDC511-7252-4A4A-ADDA-5CB1BF63****

示例

正常返回示例

JSON格式

{
  "RequestId": "0FDDC511-7252-4A4A-ADDA-5CB1BF63****"
}

错误码

HTTP status code错误码错误信息描述
400InvalidTagKey.MalformedThe specified parameter 'Tag.n.Key' or 'TagKey.n' is not valid.指定的参数“Tag.n.Key”或“TagKey.n”无效。
400InvalidTagValue.MalformedThe specified parameter 'Tag.n.Value' is not valid.-
400InvalidParameter.ResourceIdThe specified parameter 'ResourceId.n' is not valid.-
400MissParameter.TagOrResourceIdThe parameter 'Tag.n'' or 'ResourceId.n' is needed.-
400InvalidParameter.ScopeThe specified parameter 'Scope' is not valid.-
400NumberExceed.ResourceIdsThe ResourceIds parameter's number is exceed.-
400NumberExceed.TagsThe Tags parameter's number is exceed.-
400NumberExceed.CustomTagsThe Custom Tags parameter's number is exceed. Valid 20.-
400Duplicate.TagKeyThe specified parameter 'Tag.n.Key' is duplicated.-
400InvalidParameter.ResourceTypeThe specified parameter 'ResourceType' is not valid.-
404InvalidDbInstanceId.NotFoundSpecified instance does not exist.该实例不存在,原因可能是该实例已经释放,请刷新页面。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
  • 本页导读 (1)
文档反馈