本文导读

展开导读

文档首页/ 镜像服务 IMS/ API参考/ API/ 镜像标签/ 批量添加删除镜像标签

批量添加删除镜像标签

更新时间：2024-11-13 GMT+08:00

查看PDF

功能介绍

该接口用于为指定镜像批量添加/更新、删除标签。

约束与限制

每个标签由键值对组成，标签的key的长度不超过36个字符，value的长度不超过43个字符。key不能为空或者空白字符串，value不能为空，但可以是空白字符串。
单个镜像最多添加10个标签。
请求体中的多个标签的key不允许重复。
此接口为幂等接口：
创建时，如果创建的标签已经存在，即key相同而value不同，则更新对应标签；如果创建的标签已经存在，key/value均相同，则不进行重复添加，视为添加成功。

删除时，如果指定的标签不存在，则默认视为删除成功。

批量删除时对key、value的限制：
删除时，对标签的key、value不做字符集范围校验，key不允许为空或空白字符串；value为可选，且不对value做校验。如果要删除的标签不存在，视为删除成功，不报错。删除时，对标签的key、value做长度校验，标签的key不超过127，value不超过255。

调试

您可以在API Explorer中调试该接口。

URI

POST /v2/{project_id}/images/{image_id}/tags/action

参数说明请参见表1。

表1 参数说明
参数	是否必选	参数类型	描述
project_id	是	String	项目ID
image_id	是	String	镜像ID

请求消息

请求参数

参数	是否必选	参数类型	描述
tags	是	Array of objects	要操作的标签列表。详情请参见表2。
action	是	String	要进行的标签操作，区分大小写。支持create、delete，分别用于批量地创建/更新、删除标签。

表2 tags数据结构说明
参数	是否必选	参数类型	描述
key	是	String	标签的键，键不能为空。
value	是	String	标签的值。

请求示例

批量添加镜像标签，其中，标签键为“key1”对应的值为“value1”、标签键为“key2”对应的值为“value2”。

      
       
         
         POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/action
{
   "tags": [{
      "value": "value1",
      "key": "key1"
   },
   {
      "value": "value2",
      "key": "key2"
   },
   {
      "value": "",
      "key": "key3"
   }],
   "action": "create"
}

        

      
     

批量删除镜像标签，其中，标签键为“key1”对应的值为“value1”、标签键为“key2”对应的值为“value2”。

      
       
         
         POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/action
{
   "tags": [{
      "value": "value1",
      "key": "key1"
   },
   {
      "value": "value2",
      "key": "key2"
   },
   {
      "value": "",
      "key": "key3"
   }],
      "action": "delete"
}

        

      
     

响应消息

响应参数
 无
响应样例
```
STATUS CODE 204
```

返回值

正常
 204

异常

返回值	说明
400 Bad Request	请求错误。
401 Unauthorized	鉴权失败。
403 Forbidden	没有操作权限。
404 Not Found	找不到资源。
500 Internal Server Error	服务内部错误。
503 Service Unavailable	服务不可用。

父主题： 镜像标签

上一篇：按标签查询镜像

下一篇：添加镜像标签

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

批量添加删除镜像标签

功能介绍

约束与限制

调试

URI

请求消息

请求示例

响应消息

返回值

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线

文档反馈