全部产品
Search

搜索本产品

    云数据库 Tair（兼容 Redis®）：TagResources - 为一个或多个实例绑定标签

    文档中心

    云数据库 Tair（兼容 Redis®）：TagResources - 为一个或多个实例绑定标签

    更新时间：Dec 09, 2024

    为一个或多个云数据库 Tair（兼容 Redis）实例绑定标签。

    接口说明

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

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

    该 API 对应的控制台操作请参见新建标签。

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    kvstore:TagResourcescreate
    *全部资源
    *
      无
    		无

    请求参数

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

    实例所属的地域 ID。

    		cn-hangzhou
    ResourceTypestring是

    资源类型，取值固定为 INSTANCE。

    		INSTANCE
    ResourceIdarray是

    实例 ID。

    string是

    实例 ID，支持设置多个。

    说明 N 表示传入第几个实例 ID。例如ResourceId.1表示传入第一个实例 ID；ResourceId.2表示传入第二个实例 ID。
    		r-bp1zxszhcgatnx****
    Tagarray<object>是

    实例的标签信息。

    object是

    对象。

    Keystring是

    标签的键。

    说明
  • N 表示传入第几个标签的键。例如Tag.1.Key表示传入第一个标签的键；Tag.2.Key表示传入第二个标签的键。
  • 如果标签的键不存在，则自动创建。
    •
    		demokey
    Valuestring是

    标签的值。

    说明 N 表示传入第几个标签的值。例如Tag.1.Value表示传入第一个标签的值；Tag.2.Value表示传入第二个标签的值。
    		demovalue

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		4BD4E308-A3D8-4CD1-98B3-0ADAEE38****

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "4BD4E308-A3D8-4CD1-98B3-0ADAEE38****"
}

    错误码

    HTTP status code错误码错误信息描述
    400NumberExceed.TagsThe Tags parameter number is exceed, Valid is 20.-
    400InvalidTagKey.MalformedThe specified parameter Tag.n.Key or TagKey.n is not valid.-
    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.参数Tag和ResourceId不能全部为空，至少传入其中一种
    400InvalidParameter.ScopeThe specified parameter Scope is not valid.-
    400NumberExceed.ResourceIdsThe ResourceIds parameter number is exceed.-
    400NumberExceed.TagsThe Tags parameter number is exceed.-
    400NumberExceed.CustomTagsThe Custom Tags parameter number is exceed. Valid is 20.-
    400Duplicate.TagKeyThe specified parameter Tag.n.Key is duplicated.-
    400InvalidParameter.ResourceTypeThe specified parameter ResourceType is not valid.-
    400OperationDenied.QuotaExceedThe Tags parameter number is exceed. Valid is 20.-
    404InvalidDbInstanceId.NotFoundSpecified instance does not exist.指定的实例不存在

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

    变更历史

    变更时间变更内容概要操作
    2023-07-20OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情