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

AddTagsToResource

最近更新时间：2023.12.27 14:30:44

首次发布时间：2023.07.21 10:21:41

我的收藏

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

请求类型

异步请求。

注意事项

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

请求参数

名称类型是否必选示例值描述

InstanceIds

Array of String

是

[
"redis-cn0212gzmh2xs****"
]

需要绑定标签的实例 ID。

说明

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

Tags

Array of TagInfo

是

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

需要绑定的标签键和标签值数组对象。关于 Tags 的更多详情，请参见数据结构。

说明

  • 支持一次传入多组标签键值对像，多组标签键值对像间用英文逗号（,）分隔。
  • 一次最多同时传入 20 组标签键值对，单个实例最多可绑定 50 个标签。更多关于标签键值的设置规则，请参见标签设置规则。
ClientTokenString否WbiAlPqJM6tMoSOYhT****用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回数据

null

请求示例

POST https://redis.volcengineapi.com/?Action=AddTagsToResource&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceIds":[
        "redis-cn0212gzmh2xs****"
    ],
    "Tags":[
        {
            "Key":"instancetype",
            "Value":"cluster"
        },
        {
            "Key":"chargetype",
            "Value":"prepaid"
        }
    ]
}

返回示例

正常返回示例

{
     "ResponseMetadata": {
          "RequestId": "202204151542080102120420191760****",
          "Action": "AddTagsToResource",
          "Version": "2020-12-07",
          "Service": "Redis",
          "Region": "cn-beijing"
     },
    "Result": null
}

错误码

更多详情，请参见错误码。