You need to enable JavaScript to run this app.
导航
文档数据库 MongoDB 版
  • 文档首页
    • /
  • 文档数据库 MongoDB 版

AddTagsToResource

最近更新时间：2024.04.26 11:09:11

首次发布时间：2023.01.17 12:49:01

我的收藏

调用 AddTagsToResource 接口为指定实例绑定标签。

请求类型

异步请求。

注意事项

  • 设置标签时，标签键（Key）和标签值（Key）需满足一定的规则。详细信息，请参见标签设置规则。
  • 同一实例下多个标签的标签键不可重复，且每个标签键只能有一个标签值。
  • 若新绑定的标签键与实例已绑定的标签键重合，则新标签值将覆盖原标签值，请谨慎操作。更多说明，请参见绑定或添加标签。

请求参数

参数类型是否必选示例值描述

InstanceIds

Array of String

是

["mongo-shard-011d2479****"]

需要绑定标签的实例 ID。

说明

  • 您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。
  • 支持一次传入多个实例 ID，多个 ID 间用英文逗号（,）分隔。最多同时传入 20 个实例 ID。

Tags

Array of TagObject

是

[{"Key":"instancetype","Value":"shard"},{"Key":"chargetype","Value":"prepaid"}]

需要绑定的标签键和标签值数组对象。

说明

  • 支持一次传入多组标签键值对像，多组标签键值对像间用英文逗号（,）分隔。
  • 一次最多同时传入 20 组标签键值对，单个实例最多可绑定 50 个标签。标签键值需满足设置规则，具体规则请参见标签设置规则。

TagObject

参数类型是否必选示例值描述

Key

String

是

instancetype

Key 参数在不同 API 接口中作用不同，其中：

  • 在 CreateDBInstance 和 AddTagsToResource 请求参数中表示需要绑定标签所对应的标签键。

    说明

    • 该参数留空表示新建实例不绑定任何标签。当需要为实例绑定标签时，标签键（Key）必填，标签值（Value）可不填，不填标签值表示对应标签键的标签值为空。
    • 支持一次传入多组标签键值对象，多组标签键值对象间用英文逗号（,）分隔。最多同时传入 20 组标签键值对。单个实例最多可绑定 50 个标签。标签键需满足设置规则，具体规则请参见标签设置规则。
  • 在 DescribeDBInstances 和 DescribeDBInstanceDetail 的返回数据中表示当前实例所绑定标签的标签键。

Value

String

否

replica

Value 参数在不同 API 接口中作用不同，其中：

  • 在 CreateDBInstance 和 AddTagsToResource 请求参数中表示需要绑定标签所对应的标签值。

    说明

    • 当需要为实例绑定标签时，标签键（Key）必填，标签值（Value）可不填，不填标签值表示对应标签键的标签值为空。支持一次传入多组标签键值对象，多组标签键值对象间用英文逗号（,）分隔。
    • 最多同时传入 20 组标签键值对。单个实例最多可绑定 50 个标签。标签键需满足设置规则，具体规则请参见标签设置规则。

  • 在 DescribeDBInstances 和 DescribeDBInstanceDetail 的返回数据中表示当前实例所绑定标签的标签值。

返回参数

无。

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=AddTagsToResource&Version=2022-01-01 HTTP/1.1
Host: mongodb.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": "202212091735327549DDD37A541ADE****",
        "Action": "AddTagsToResource",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}