更新时间:2024-06-24 GMT+08:00

添加镜像标签

功能介绍

该接口用于为指定镜像添加或更新指定的单个标签。

约束与限制

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

URI

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

参数说明请参见表1
表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

项目ID

image_id

String

镜像ID

请求消息

  • 请求参数

    参数

    是否必选

    参数类型

    描述

    tag

    Object

    要添加或更新的标签数据,详情请参见表2

    表2 tag数据结构说明

    参数

    是否必选

    参数类型

    描述

    key

    String

    标签的键,键不能为空。

    value

    String

    标签的值。

请求示例

添加镜像标签,其中,标签键为“key1”对应的值为“value1”。

1
2
3
4
5
6
7
POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags
{
   "tag": {
      "value": "value1",
      "key": "key1"
   }
}

响应消息

  • 响应参数

  • 响应样例
    STATUS CODE 204

返回值

  • 正常

    204

  • 异常

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。