文档首页/ 云备份 CBR/ API参考/ API/ 标签/ 批量添加删除存储库资源标签
更新时间：2024-12-12 GMT+08:00
编辑
查看PDF
分享

批量添加删除存储库资源标签

功能介绍

为指定实例批量添加或删除标签

标签管理服务需要使用该接口批量管理实例的标签。

一个资源上最多有10个标签（支持landingzone的region支持20个）。

此接口为幂等接口：

创建时如果请求体中存在重复key则报错。

创建时，不允许重复key，如果数据库存在就覆盖。

删除时，允许重复key。

删除时，如果删除的标签不存在，默认处理成功,删除时不对标签字符集范围做校验。key长度127个字符，value为255个字符。删除时tags结构体不能缺失，key不能为空，或者空字符串。

URI

POST /v3/{project_id}/vault/{vault_id}/tags/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id

vault_id

是

String

资源id

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

tags

否

Array of Tag objects

标签列表。

tags不允许为空列表。

tags中最多包含10个key。

tags中key不允许重复。

sys_tags

否

Array of SysTag objects

系统标签列表。

op_service权限可以访问，和tags二选一。

目前TMS调用时只包含一个resource_tag结构体 ，key固定为：_sys_enterprise_project_id。

value是UUID或0,value为0表示默认企业项目。

现在仅支持create操作。

action

是

String

操作标识

  • create: 创建

  • delete: 删除
表3 Tag

参数

是否必选

参数类型

描述

key

是

String

键。

key最大长度为36个字符。

key不能为空字符串。

key前后空格会被丢弃。

key不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文，字母，数字，“-”，“_”组成。

value

是

String

值。

添加标签时value值必选，删除标签时value值可选。

value最大长度为43个字符。

value可以为空字符串。

value前后的空格会被丢弃。

value不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文，字母，数字，“-”，“_”，“.”组成。
表4 SysTag

参数

是否必选

参数类型

描述

key

是

String

键。

系统标签的key，从白名单中取，不能随意定义。

目前仅支持 _sys_enterprise_project_id字段，对应 的value为企业项目ID。

value

是

String

值。

目前仅会用到企业项目ID，其中默认的企业项目ID为“0”。

响应参数

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

请参见错误码。

error_msg

String

错误信息

请求示例

批量创建tag

POST  https://{endpoint}/v3/{project_id}/vault/{vault_id}/tags/action

{
  "tags" : [ {
    "key" : "string",
    "value" : "string"
  }, {
    "key" : "string1",
    "value" : "string2"
  } ],
  "action" : "create"
}

响应示例

无

状态码

状态码

描述

204

No Content

400

Bad Request

错误码

请参见错误码。

父主题： 标签

相关文档