为一个或多个云数据库 Tair(兼容 Redis)实例绑定标签。
接口说明
在实例数量较多的情况下,您可以创建多个标签,为实例绑定不同的标签对其进行分类,之后通过标签进行实例筛选。
标签由一对键(key)值(value)组成,键在同账号同地域下唯一,值无此限制。
若设置的标签不存在,则自动创建该标签并绑定到目标实例。
若实例已经绑定了有相同键的标签,则进行覆盖绑定。
每个实例最多可以绑定 20 个标签。
每次调用最多设置 50 个实例进行批量标签绑定。
该 API 对应的控制台操作请参见新建标签。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
kvstore:TagResources |
create |
*DBInstance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
实例所属的地域 ID。 |
cn-hangzhou |
| ResourceType |
string |
是 |
资源类型,取值固定为 INSTANCE。 |
INSTANCE |
| ResourceId |
array |
是 |
实例 ID。 |
r-bp1zxszhcgatnx**** |
|
string |
否 |
实例 ID,支持设置多个。 说明
N 表示传入第几个实例 ID。例如ResourceId.1表示传入第一个实例 ID;ResourceId.2表示传入第二个实例 ID。 |
r-bp1zxszhcgatnx**** |
|
| Tag |
array<object> |
是 |
实例的标签信息。 |
|
|
object |
否 |
对象。 |
||
| Key |
string |
是 |
标签的键。 说明
|
demokey |
| Value |
string |
是 |
标签的值。 说明
N 表示传入第几个标签的值。例如Tag.1.Value表示传入第一个标签的值;Tag.2.Value表示传入第二个标签的值。 |
demovalue |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
4BD4E308-A3D8-4CD1-98B3-0ADAEE38**** |
示例
正常返回示例
JSON格式
{
"RequestId": "4BD4E308-A3D8-4CD1-98B3-0ADAEE38****"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | NumberExceed.Tags | The Tags parameter number is exceed, Valid is 20. | |
| 400 | InvalidTagKey.Malformed | The specified parameter Tag.n.Key or TagKey.n is not valid. | |
| 400 | InvalidTagValue.Malformed | The specified parameter Tag.n.Value is not valid. | |
| 400 | InvalidParameter.ResourceId | The specified parameter ResourceId.n is not valid. | |
| 400 | MissParameter.TagOrResourceId | The parameter Tag.n or ResourceId.n is needed. | 参数Tag和ResourceId不能全部为空,至少传入其中一种 |
| 400 | InvalidParameter.Scope | The specified parameter Scope is not valid. | |
| 400 | NumberExceed.ResourceIds | The ResourceIds parameter number is exceed. | |
| 400 | NumberExceed.CustomTags | The Custom Tags parameter number is exceed. Valid is 20. | |
| 400 | Duplicate.TagKey | The specified parameter Tag.n.Key is duplicated. | |
| 400 | InvalidParameter.ResourceType | The specified parameter ResourceType is not valid. | |
| 400 | OperationDenied.QuotaExceed | The Tags parameter number is exceed. Valid is 20. | |
| 404 | InvalidDbInstanceId.NotFound | Specified instance does not exist. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。