华为云用户手册

URI POST /v2/manage/namespaces/{namespace}/repos/{repository}/retentions 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String 组织名称。小写字母开头，后面跟小写字母、数字、小数点、下划线或中划线（其中下划线最多允许连续两个，小数点、下划线、中划线不能直接相连），小写字母或数字结尾，1-64个字符。 repository 是 String 镜像仓库名称

请求示例 POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/retentions { "algorithm" : "string", "rules" : [ { "params" : { }, "tag_selectors" : [ { "kind" : "string", "pattern" : "string" } ], "template" : "string" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json 缺省值：application/json X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 algorithm 是 String 回收规则匹配策略，固定为"or" rules 是 Array of Rule objects 镜像老化规则 表4 Rule 参数 是否必选 参数类型 描述 template 是 String 回收类型，date_rule、tag_rule params 是 Object template是date_rule时，设置params为{"days": "xxx"} template是tag_rule时，设置params为{"num": "xxx"} tag_selectors 是 Array of TagSelector objects 例外镜像 表5 TagSelector 参数 是否必选 参数类型 描述 kind 是 String 匹配规则，label、regexp pattern 是 String kind是label时，设置为镜像版本,kind是regexp时，设置为正则表达式

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json 缺省值：application/json X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of UserAuth objects 需要创建镜像权限的信息 表4 UserAuth 参数 是否必选 参数类型 描述 user_id 是 String 用户id，需要从IAM服务获取 user_name 是 String 用户名，需要从IAM服务获取 auth 是 Long 用户权限，7表示管理权限，3表示编辑权限，1表示读取权限

URI POST /v2/manage/namespaces/{namespace}/repos/{repository}/access 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String 组织名称。小写字母开头，后面跟小写字母、数字、小数点、下划线或中划线（其中下划线最多允许连续两个，小数点、下划线、中划线不能直接相连），小写字母或数字结尾，1-64个字符。 repository 是 String 镜像仓库名称

概述 欢迎使用容器镜像服务（Software Repository for Container，SWR）。容器镜像服务是一种支持镜像全生命周期管理的服务，提供简单易用、安全可靠的镜像管理功能，帮助您快速部署容器化服务。 您可以使用本文档提供API对容器镜像服务进行相关操作，如创建、删除、查询等。支持的全部操作请参见API概览。 在调用容器镜像服务API之前，请确保已经充分了解容器镜像服务相关概念，详细信息请参见“什么是容器镜像服务”。 父主题： 使用前必读

URI PATCH /v2/manage/namespaces/{namespace}/repos/{repository} 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String 组织名称。小写字母开头，后面跟小写字母、数字、小数点、下划线或中划线（其中下划线最多允许连续两个，小数点、下划线、中划线不能直接相连），小写字母或数字结尾，1-64个字符。 repository 是 String 镜像仓库名称。小写字母或数字开头，后面跟小写字母、数字、小数点、斜杠、下划线或中划线（其中下划线最多允许连续两个，小数点、斜杠、下划线、中划线不能直接相连），小写字母或数字结尾，1-128个字符。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json 缺省值：application/json X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 is_public 是 Boolean 是否为公共仓库，可选值为true或false。 category 否 String 仓库类型，可设置为app_server, linux, framework_app, database, lang, other, arm。 description 否 String 镜像仓库的描述信息。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 exist Boolean true：存在；false：不存在 namespace String 组织名称 repository String 镜像仓库名称 access_domain String 共享账号名 permit String 权限 deadline String 截止时间 description String 描述 creator_id String 创建者ID creator_name String 创建者名称 created String 镜像创建时间，UTC时间格式，时间为UTC标准时间 updated String 镜像更新时间，UTC时间格式，时间为UTC标准时间 status Boolean 是否过期，true：有效；false：过期

响应示例 状态码： 200 查询成功 { "exist" : true, "namespace" : "group", "repository" : "busybox", "access_domain" : "xxx", "permit" : "read", "deadline" : "2021-10-01T16:00:00Z", "description" : "description", "creator_id" : "0504186e6a8010e01f3ec009a7279baa", "creator_name" : "xxx", "created" : "2021-06-10T08:14:42.56632Z", "updated" : "2021-06-10T08:14:42.566325Z", "status" : true }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json 缺省值：application/json X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

URI GET /v2/manage/namespaces/{namespace}/repositories/{repository}/access-domains/{access_domain} 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String 组织名称。小写字母开头，后面跟小写字母、数字、小数点、下划线或中划线（其中下划线最多允许连续两个，小数点、下划线、中划线不能直接相连），小写字母或数字结尾，1-64个字符。 repository 是 String 镜像仓库名称 access_domain 是 String 共享账号

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json 缺省值：application/json X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 Content-Range String offset(开始索引)-count(当前页记录条数)/total(总记录条数) 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of ShowReposTagResp objects 镜像tag列表 表6 ShowReposTagResp 参数 参数类型 描述 id Long tag编号 repo_id Long 仓库编号 Tag String Tag版本名称 image_id String 镜像id manifest String 镜像manifest digest String 镜像hash值 schema Long docker协议版本，值为1或2 path String 镜像pull地址，格式为swr.cn-north-1.myhuaweicloud.com/namespace/repository:tag internal_path String cce集群内镜像pull路径，格式为 10.125.0.198:20202/namespace/repository:tag size Long 镜像大小，0 ~ 9223372036854775807 is_trusted Boolean 默认值为false 缺省值：false created String 镜像创建时间，UTC时间格式，时间为UTC标准时间，用户需要根据本地时间计算偏移量；如东8区需要+8:00 updated String 镜像更新时间，UTC时间格式，时间为UTC标准时间，用户需要根据本地时间计算偏移量；如东8区需要+8:00 deleted String 镜像删除时间，UTC时间格式，时间为UTC标准时间，用户需要根据本地时间计算偏移量；如东8区需要+8:00 domain_id String 账号ID scanned Boolean 镜像是否被扫描过 tag_type Long 0：manifest类型；1：manifest list类型

响应示例 状态码： 200 查询镜像列表tag列表成功 [ { "id" : 0, "repo_id" : 0, "Tag" : "latest", "image_id" : "741f24a795d6d93d7c6edd11780d63c13e16c39615dd9d223378a57a836f2ee6", "manifest" : "{\"schemaVersion\":2,\"mediaType\":\"application/vnd.docker.distribution.manifest.v2+json\",\"config\":{\"mediaType\":\"application/vnd.docker.container.image.v1+json\",\"size\":1862,\"digest\":\"sha256:741f24a795d6d93d7c6edd11780d63c13e16c39615dd9d223378a57a836f2ee6\"},\"layers\":[{\"mediaType\":\"application/vnd.docker.image.rootfs.diff.tar.gzip\",\"size\":1292800,\"digest\":\"sha256:8ac8bfaff55af948c796026ee867448c5b5b5d9dd3549f4006d9759b25d4a893\"},{\"mediaType\":\"application/vnd.docker.image.rootfs.diff.tar.gzip\",\"size\":10240,\"digest\":\"sha256:77ddbf3a9fe11e81761a0f9df43a28e3e6f29bbb53c0c8cf71cd7efa69729aed\"}]}", "digest" : "sha256:57b605845a6367c34bfb6ea6477f16852f59aa1861a2b51d10ab77ae0a1dc9c3", "schema" : 2, "path" : "swr.cn-north-1.myhuaweicloud.com/namespace/busybox:latest", "internal_path" : "10.125.0.198:20202/namespace/busybox:latest", "size" : 1304902, "is_trusted" : false, "created" : "2018-07-06T06:18:55Z", "updated" : "2018-07-06T06:18:55Z", "deleted" : null, "domain_id" : "0503dda878000fed0f75c0096d70a960", "scanned" : false, "tag_type" : 0 } ]

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json 缺省值：application/json X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

URI GET /v2/manage/namespaces/{namespace}/repos/{repository}/tags 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String 组织名称。小写字母开头，后面跟小写字母、数字、小数点、下划线或中划线（其中下划线最多允许连续两个，小数点、下划线、中划线不能直接相连），小写字母或数字结尾，1-64个字符。 repository 是 String 镜像仓库名称 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 返回条数。注意：offset和limit参数需要配套使用。 offset 否 String 起始索引。注意：offset和limit参数需要配套使用。 order_column 否 String 按列排序，可设置为updated_at（按更新时间排序）、tag（版本名称）。注意：order_column和order_type参数需要配套使用。 order_type 否 String 排序类型，可设置为desc（降序）、asc（升序）。注意：order_column和order_type参数需要配套使用。 tag 否 String 镜像版本名。 filter 否 String 应填写 offset::{offset}|limit::{limit}|order_column::{order_column}|order_type::{order_type}|tag::{tag} ,其中{limit}为返回条数,{offset}为起始索引,注意：offset和limit参数需要配套使用。 {order_column}为按列排序，可设置为updated_at（按更新时间排序）、tag（版本名称）,{order_type}为排序类型，可设置为desc（降序）、asc（升序），{tag}为镜像版本名。

镜像自动同步管理 API 说明 获取镜像自动同步任务信息 创建镜像自动同步任务后，可以通过此接口查询该任务的状态，以判断是否同步成功。 获取镜像自动同步任务列表 获取为当前镜像仓库所创建的所有自动同步任务。 创建镜像自动同步任务 创建镜像自动同步任务，帮助您把最新推送的镜像自动同步到其他区域镜像仓库内。 镜像自动同步帮助您把最新推送的镜像自动同步到其他区域镜像仓库内，后期镜像有更新时，目标仓库的镜像也会自动更新，但已有的镜像不会自动同步。已有镜像的同步需要手动操作，详情请参见手动同步镜像。 删除镜像自动同步任务 根据目标区域、目标组织删除指定的镜像自动同步任务。 手动同步镜像 对于镜像仓库已有的镜像，如果想在其他区域使用，需要手动触发镜像同步。判断是否同步成功的方法如下： 响应状态码为200，无报错信息，表示同步成功。 通过SWR管理控制台或调用查询镜像仓库概要信息接口，在目标区域的目标组织下，若存在所同步的镜像版本表示同步成功。

镜像仓库管理 API 说明 在组织下创建镜像仓库 在组织下创建镜像仓库。 删除组织下的镜像仓库 删除组织下的镜像仓库。 更新镜像仓库的概要信息 更新组织下的镜像仓库概要信息，包括镜像类型、是否公有、描述信息。 查询镜像仓库概要信息 查询组织下镜像仓库的概要信息，包括仓库ID、组织ID、仓库名称、仓库描述信息、仓库创建者、仓库大小、镜像pull路径等。 查询镜像仓库列表 查询镜像仓库列表。 查看共享镜像列表 查看共享镜像列表。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json 缺省值：application/json X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 Content-Range String offset(开始索引)-count(当前页记录条数)/total(总记录条数) 表5 响应Body参数 参数 参数类型 描述 retention_log Array of RetentionLog objects 镜像老化日志 total Integer 总个数 表6 RetentionLog 参数 参数类型 描述 created_at String 创建时间 id Integer ID namespace String 组织名 repo String 镜像仓库名 retention_id Integer 老化规则ID rule_type String 规则 tag String 镜像版本

响应示例 状态码： 200 请求成功 { "retention_log" : [ { "created_at" : "2020-04-17T08:01:09.658309Z", "id" : 9088, "namespace" : "hwstaff_l00283074", "repo" : "experience_2048", "retention_id" : 91, "rule_type" : "{\"template\":\"tag_rule\",\"params\":{\"num\":\"7\"},\"tag_selectors\":[]}", "tag" : "4" } ], "total" : 1 }

URI GET /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/histories 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String 组织名称。小写字母开头，后面跟小写字母、数字、小数点、下划线或中划线（其中下划线最多允许连续两个，小数点、下划线、中划线不能直接相连），小写字母或数字结尾，1-64个字符。 repository 是 String 镜像仓库名称 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 返回条数。注意：offset和limit参数需要配套使用。 offset 否 String 起始索引。注意：offset和limit参数需要配套使用。 filter 否 String 应填写 limit::{limit}|offset::{offset}, 其中{limit}为返回条数,{offset}为起始索引, 注意：offset和limit参数需要配套使用

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

URI PATCH /v2/manage/namespaces/{namespace}/repos/{repository}/triggers/{trigger} 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String 组织名称。小写字母开头，后面跟小写字母、数字、小数点、下划线或中划线（其中下划线最多允许连续两个，小数点、下划线、中划线不能直接相连），小写字母或数字结尾，1-64个字符。 repository 是 String 镜像仓库名称 trigger 是 String 触发器名称

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json 缺省值：application/json X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 enable 是 String 是否生效,true启用，false不启用

修订记录 发布日期 修订记录 2023-06-16 第十三次正式发布。 完善请求示例。 2022-02-15 第十二次正式发布。 新增获取配额信息章节。 2021-06-18 第十一次正式发布。 全文优化，包括优化功能介绍、补充请求样例、优化参数描述等。 2020-11-10 第十次正式发布。 新增应用示例： 创建镜像仓库、添加镜像授权、创建镜像老化规则 2020-10-23 第九次正式发布。 新增以下分类： 镜像权限管理 镜像同步管理 触发器管理 镜像老化规则管理 2020-05-30 第八次正式发布。 修改 查询组织列表响应参数描述。 在组织下创建镜像仓库、更新镜像仓库的概要信息、查询镜像仓库概要信息、查询镜像仓库列表、查询共享镜像列表category参数信息。 2019-12-30 第七次正式发布。 新增授权管理的相关接口： 创建组织权限 删除组织权限 更新组织权限 查询组织权限 2019-08-30 第六次正式发布。 新增查询API版本信息接口： 查询所有API版本信息 查询指定API版本信息 2019-06-15 第五次正式发布。 修改access_domain参数信息，涉及以下接口： 创建共享账号 获取共享账号列表 删除共享账号 更新共享账号 判断共享账号是否存在 2018-12-30 第四次正式发布。 修改以下接口的参数信息： 创建组织 查询组织列表 在组织下创建镜像仓库 更新镜像仓库的概要信息 查询镜像仓库概要信息 查询镜像仓库列表 创建共享账号 获取共享账号列表 更新共享账号 判断共享账号是否存在 2018-11-15 第三次正式发布。 新增查询共享镜像列表章节。 2018-04-10 第二次正式发布。 新增租户间共享私有镜像，涉及以下接口： 创建共享账号 获取共享账号列表 删除共享账号 更新共享账号 判断共享账号是否存在 2018-01-26 第一次正式发布。

响应示例 状态码： 200 请求成功 [ { "name" : "nginx", "category" : "linux", "size" : 200977474, "is_public" : false, "num_images" : 2, "num_download" : 0, "created_at" : "2017-01-01T00:00:00Z", "updated_at" : "2017-09-11T03:00:02.542841141Z", "url" : "", "path" : "swr.cn-north-1.myhuaweicloud.com/namespace/repository", "internal_path" : "10.125.0.198:20202/namespace/repository", "domain_name" : "root", "namespace" : "root", "tags" : [ "latest", "log" ], "status" : false, "total_ranage" : 4 } ]

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json 缺省值：application/json X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

URI GET /v2/manage/repos 表1 Query参数 参数 是否必选 参数类型 描述 namespace 否 String 组织名称。小写字母开头，后面跟小写字母、数字、小数点、下划线或中划线（其中下划线最多允许连续两个，小数点、下划线、中划线不能直接相连），小写字母或数字结尾，1-64个字符。 name 否 String 镜像仓库名称 category 否 String 镜像仓库分类，可设置为app_server, linux, framework_app, database, lang, other, arm。 limit 否 String 返回条数。注意：offset和limit参数需要配套使用。 offset 否 String 起始索引。注意：offset和limit参数需要配套使用。 order_column 否 String 按列排序，可设置为updated_at（按更新时间排序）,name（名称）、tag_count（版本数）、namespace（组织）、is_public（是否公开私有）。注意：order_column和order_type参数需要配套使用。 order_type 否 String 排序类型，可设置为desc（降序）、asc（升序）。注意：order_column和order_type参数需要配套使用。 is_public 否 String 是否公开私有，true为公开，false为私有 filter 否 String 注意：至少要传递一个filter参数。其中{namespace}为组织名称，模糊匹配。 {name}为镜像仓库名称，模糊匹配。{category}为镜像仓库分类，可设置为app_server、linux、framework_app、database、lang、other、arm。{is_public}为镜像是否公开私有，true为公开，false为私有 {limit}为返回条数,{offset}为起始索引，注意：offset和limit参数需要配套使用。{order_column}为按列排序，可设置为updated_at（按更新时间排序）,name（名称）、tag_count（版本数）、namespace（组织）、is_public（是否公开私有）,{order_type}为排序类型， 可设置为desc（降序）、asc（升序），注意：order_column和order_type参数需要配套使用。