You need to enable JavaScript to run this app.
文档中心
文档数据库 MongoDB 版

文档数据库 MongoDB 版

复制全文
下载 pdf
标签管理
AddTagsToResource
复制全文
下载 pdf
AddTagsToResource
调用 AddTagsToResource 接口为目标 MongoDB 实例绑定标签。​
请求类型​
异步请求。​
注意事项​
  • 仅当实例状态为运行中(即 DescribeDBInstances 接口的返回结果中,对应实例的 InstanceStatus 取值为 Running)时,支持调用 AddTagsToResource 接口。关于实例状态的更多信息,请参见实例状态。​
  • 设置标签时,标签键(Key)和标签值(Key)需满足一定的规则。详细信息,请参见标签设置规则。​
  • 同一实例下多个标签的标签键不可重复,且每个标签键只能有一个标签值。​
  • 若新绑定的标签键与实例已绑定的标签键重合,则新标签值将覆盖原标签值,请谨慎操作。更多说明,请参见绑定或添加标签。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
InstanceIds String[] 必选 示例值:["mongo-shard-011d2479****"]​
需要绑定标签的实例 ID。​
说明​
  • 您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息,包括实例 ID。​
  • 支持一次传入多个实例 ID,多个 ID 间用英文逗号(,)分隔。最多同时传入 20 个实例 ID。​
​
Tags Object[] 必选 示例值:​
需要绑定的标签键和标签值数组对象。​
Key String 必选 示例值:instancetype​
需要绑定标签所对应的标签键。​
说明​
  • 当需要为实例绑定标签时,标签键(Key)必填,标签值(Value)可不填,不填标签值表示对应标签键的标签值为空。​
  • 支持一次传入多组标签键值对象,多组标签键值对象间用英文逗号(,)分隔。最多同时传入 20 组标签键值对。​
  • 单个实例最多可绑定 50 个标签。标签键需满足设置规则,具体规则请参见标签设置规则。​
​
Value String 可选 示例值:replica​
需要绑定标签所对应的标签值。​
说明​
  • 当需要为实例绑定标签时,标签键(Key)必填,标签值(Value)可不填,不填标签值表示对应标签键的标签值为空。​
  • 支持一次传入多组标签键值对象,多组标签键值对象间用英文逗号(,)分隔。最多同时传入 20 组标签键值对。​
  • 单个实例最多可绑定 50 个标签。标签键需满足设置规则,具体规则请参见标签设置规则。​
​
​
​
返回参数​
本接口无特有的返回参数。更多信息请见返回结构。​
示例​
请求示例​
​
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=AddTagsToResource&Version=2022-01-01 HTTP/1.1​
Host: mongodb.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=utf-8​
X-Date: 20201103T104027Z​
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****​
{​
"InstanceIds":[​
"mongo-replica-36ce163c****"​
],​
"Tags":[​
{​
"Key":"instancetype",​
"Value":"shard"​
},​
{​
"Key":"chargetype",​
"Value":"prepaid"​
}​
]​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202212091735327549DDD37A541ADE06A5",​
"Action": "AddTagsToResource",​
"Version": "2022-01-01",​
"Service": "mongodb",​
"Region": "cn-beijing"​
},​
"Result": null​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.06.17 16:09:57
这个页面对您有帮助吗?
有用
有用
无用
无用