华为云用户手册

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

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的帐号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个帐号下所有资源或帐号的某个project下的资源，详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四 ”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求参数 表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 查询成功 { "algorithm" : "or", "id" : 222, "rules" : [ { "params" : { "days" : "30" }, "tag_selectors" : [ { "kind" : "label", "pattern" : "v5" }, { "kind" : "label", "pattern" : "1.0.1" }, { "kind" : "regexp", "pattern" : "^123$" } ], "template" : "date_rule" } ], "scope" : "" }

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 algorithm String 回收规则匹配策略，or id Integer ID rules Array of Rule objects 镜像老化规则 scope String 保留字段 表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时，设置为正则表达式

响应示例 状态码： 200 查询成功 [ { "action" : "update", "app_type" : "deployments", "application" : "abcde", "cluster_id" : "******************", "cluster_name" : "test123", "cluster_ns" : "default", "condition" : ".*", "container" : "", "created_at" : "2020-04-16T02:04:55.922236Z", "creator_name" : "************", "enable" : "true", "name" : "test1", "trigger_history" : null, "trigger_mode" : "cce", "trigger_type" : "all" } ]

请求参数 表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 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of Trigger objects 触发器列表 表4 Trigger 参数 参数类型 描述 action String 触发动作，update app_type String 应用类型，deployments、statefulsets application String 应用名 cluster_id String 集群ID（cci时为空） cluster_name String 集群名（cci时为空） cluster_ns String 应用名所在的namespace condition String 触发条件，type为all时为.*,type为tag时为tag名,type为regular时为正则表达式 container String 需更新的container名，默认为所有container created_at String 创建时间 creator_name String 创建人 enable String 是否生效 name String 触发器名 trigger_history Array of TriggerHistories objects 触发器历史 trigger_mode String 触发器类型，cce、cci trigger_type String 触发条件，all、tag、regular 表5 TriggerHistories 参数 参数类型 描述 action String 触发动作，update app_type String 应用类型，deployments、statefulsets application String 应用名 cluster_id String 集群ID（cci时为空） cluster_name String 集群名（cci时为空） cluster_ns String 应用名所在的namespace condition String 触发条件，type为all时为.*,type为tag时为tag名,type为regular时为正则表达式 container String 需更新的container名，默认为所有container created_at String 创建时间 creator_name String 创建人 detail String 详情 result String 更新结果，success、failed tag String 触发的版本号

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

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 云服务存在两种部署方式：项目级服务和全局级服务。其中： 项目级服务需要获取项目级别的Token，此时请求body中auth.scope的取值为project。 全局级服务需要获取全局级别的Token，此时请求body中auth.scope的取值为domain。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 1 2 3 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 Content-Range String offset(开始索引)-count(当前页记录条数)/total(总记录条数) 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of ShowReposResp objects 请求成功 表5 ShowReposResp 参数 参数类型 描述 name String 仓库名称 category String 仓库类型（计划改造，每个镜像会有多个lable标示） description String 仓库描述信息 size Long 仓库大小 is_public Boolean 仓库是否为公共仓库，值为true或false num_images Long 仓库中镜像个数，0 ~ 9223372036854775807 num_download Long 仓库下载次数 created_at String 仓库创建时间，UTC日期格式，时间为UTC标准时间，用户需要根据本地时间计算偏移量；如东8区需要+8:00 updated_at String 仓库更新时间，UTC日期格式，时间为UTC标准时间，用户需要根据本地时间计算偏移量；如东8区需要+8:00 logo String 仓库logo地址（暂时未用） url String 仓库logo图片的URL，URL格式。（暂时未用） path String 镜像pull路径，格式为 swr.cn-north-1.myhuaweicloud.com/namespace/repository internal_path String 镜像pull路径，格式为 10.125.0.198:20202/namespace/repository domain_name String 租户名 namespace String 租户的组织名称 tags Array of strings 镜像版本列表 status Boolean 查询他人共享镜像：共享是否过期 查询我共享的镜像：默认为false,无意义 total_range Long 总记录条数

响应示例 状态码： 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 DELETE /v2/manage/namespaces/{namespace}/repos/{repository} 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String 组织名称。小写字母开头，后面跟小写字母、数字、小数点、下划线或中划线（其中下划线最多允许连续两个，小数点、下划线、中划线不能直接相连），小写字母或数字结尾，1-64个字符。 repository 是 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 表3 响应Body参数 参数 参数类型 描述 id Integer id name String 组织名称。小写字母开头，后面跟小写字母、数字、小数点、下划线或中划线（其中下划线最多允许连续两个，小数点、下划线、中划线不能直接相连），小写字母或数字结尾，1-64个字符。 creator_name String IAM用户名 auth Integer 用户权限。7表示管理权限，3表示编辑权限，1表示读取权限。

URI POST /v2/manage/namespaces/{namespace}/repos/{repository}/retentions 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String 组织名称。小写字母开头，后面跟小写字母、数字、小数点、下划线或中划线（其中下划线最多允许连续两个，小数点、下划线、中划线不能直接相连），小写字母或数字结尾，1-64个字符。 repository 是 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时，设置为正则表达式

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

响应示例 状态码： 200 查询成功 [ { "algorithm" : "or", "id" : 222, "rules" : [ { "params" : { "days" : "30" }, "tag_selectors" : [ { "kind" : "label", "pattern" : "v5" }, { "kind" : "label", "pattern" : "1.0.1" }, { "kind" : "regexp", "pattern" : "^123$" } ], "template" : "date_rule" } ], "scope" : "" } ]

请求示例 POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/shares { "share_type" : "account", "share_principals" : [ "fb3f175c1fd146ab8cdae3272be6107b" ], "permission" : "read", "deadline" : "2018-10-01T16:00:00.000Z", "description" : "description" }

请求参数 表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参数 参数 是否必选 参数类型 描述 share_type 是 String 共享类型。目前只支持account，organization share_principals 是 Array of strings 被共享者的信息列表。 permission 是 String 当前只支持read权限 deadline 是 String 截止时间，UTC时间格式。永久有效为forever description 否 String 描述

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