华为云用户手册

  • URI GET /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id} 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String 组织名称。小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,小数点、下划线、中划线不能直接相连),小写字母或数字结尾,1-64个字符。 repository 是 String 镜像仓库名称 retention_id 是 Integer 镜像老化规则id
  • 请求参数 表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" : "" }
  • 响应参数 状态码: 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时,设置为正则表达式
  • 请求示例 PATCH https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id} { "algorithm" : "or", "rules" : [ { "params" : { "days" : "30" }, "tag_selectors" : [ { "kind" : "label", "pattern" : "v5" }, { "kind" : "label", "pattern" : "1.0.1" }, { "kind" : "regexp", "pattern" : "^123$" } ], "template" : "date_rule" } ] }
  • 请求参数 表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时,设置为正则表达式
  • URI PATCH /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id} 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String 组织名称。小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,小数点、下划线、中划线不能直接相连),小写字母或数字结尾,1-64个字符。 repository 是 String 镜像仓库名称 retention_id 是 Integer 镜像老化规则id
  • 响应示例 状态码: 200 查询成功 { "id" : 1422, "name" : "test", "creator_name" : "user01", "self_auth" : { "user_id" : "3059e6b5562241fda3fa441cca6f228b", "user_name" : "user", "auth" : 7 }, "others_auths" : [ { "user_id" : "fb3f175c1fd146ab8cdae3272be6107b", "user_name" : "user01", "auth" : 7 } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id Integer id name String 组织名称。小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,小数点、下划线、中划线不能直接相连),小写字母或数字结尾,1-64个字符。 creator_name String 组织创建者 self_auth UserAuth object 本用户权限 others_auths Array of UserAuth objects 其他用户的权限 表4 UserAuth 参数 参数类型 描述 user_id String 用户id,需要从IAM服务获取 user_name String 用户名,需要从IAM服务获取 auth Long 用户权限,7表示管理权限,3表示编辑权限,1表示读取权限
  • 请求参数 表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格式:POST /v2/manage/namespaces 详情请参见“创建组织”。 请求示例 POST https://{endpoint}/v2/manage/namespaces Body: { "namespace": "group" } 响应示例 {} 查询组织列表 接口相关信息 URI格式:GET /v2/manage/namespaces?filter=namespace::{namespace} 详情请参见“查询组织列表”。 请求示例 GET https://{endpoint}/v2/manage/namespaces?filter=namespace::group 响应示例 { "namespaces": [ { "auth": 7, "creator_name": "test", "id": 7, "name": "group" } ] } 创建镜像仓库 接口相关信息 URI格式:POST /v2/manage/namespaces/{namespace}/repos 详情请参见“创建镜像仓库”。 请求示例 POST https://{endpoint}/v2/manage/namespaces/{namespace}/repos?repository=test&category=linux&description=test&is_public=false 响应示例 {} 查询镜像仓库概要信息 接口相关信息 URI格式:GET /v2/manage/namespaces/{namespace}/repos/{repository} 详情请参见“查询镜像仓库概要信息”。 请求示例 GET https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository} 响应示例 { "category": "other", "created": "2020-10-30T11:35:02.939134Z", "creator_id": "ff4f44473a1d4ab3847906410af2d152", "creator_name": "test", "description": "", "domain_id": "8b1e8153e5c4414fa57c356319b633fb", "id": 379367, "internal_path": "swr.cn-north-4.myhuaweicloud.com/group/test", "is_public": true, "name": "test", "ns_id": 7, "num_download": 3, "num_images": 1, "path": "swr.cn-north-4.myhuaweicloud.com/group/test", "priority": 0, "size": 1304902, "updated": "2020-10-30T11:47:46.084808Z", "url": "" }
  • 操作步骤 创建镜像权限 接口相关信息 URI格式:POST /v2/manage/namespaces/{namespace}/repos/{repository}/access 详情请参见“创建镜像权限”。 请求示例 POST https://{endpoint}/v2/manage/namespaces/group/repos/test/access Body: [ { "user_id": "fb3f175c1fd146ab8cdae3272be*****", "user_name": "test", "auth": 7 } ] 响应示例 {} 查询镜像权限 接口相关信息 URI格式:GET https://{endpoint}/v2/manage/namespaces/{namespace}/repos/{repository}/access 详情请参见“查询镜像权限”。 请求示例 GET /v2/manage/namespaces/group/repos/test/access 响应示例 { "id": 385550, "name": "test", "others_auths": [ { "auth": 7, "user_id": "fb3f175c1fd146ab8cdae3272be*****", "user_name": "test" } ], "self_auth": { "auth": 7, "user_id": "fb3f175c1fd146ab8cdae3272be*****", "user_name": "test" } }
  • 请求参数 表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表示读取权限。
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 remoteRegionId 是 String 目标region ID。 remoteNamespace 是 String 目标组织
  • URI DELETE /v2/manage/namespaces/{namespace}/repos/{repository}/sync_repo 表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的值)。
  • 操作步骤 创建镜像老化规则 接口相关信息 URI格式:POST /v2/manage/namespaces/{namespace}/repos/{repository}/retentions 详情请参见“创建镜像老化规则”。 请求示例 POST https://{endpoint}/v2/manage/namespaces/group/repos/test/retentions Body: { "algorithm": "or", "rules": [ { "template": "date_rule", "params": { "days": "30" }, "tag_selectors": [ { "kind": "label", "pattern": "v5" }, { "kind": "label", "pattern": "1.0.1" }, { "kind": "regexp", "pattern": "^123$" } ] } ] } 响应示例 { "id": 34 } 删除镜像老化规则 接口相关信息 URI格式:DELETE /v2/manage/namespaces/{namespace}/repos/{repository}/retentions/{retention_id} 详情请参见“删除镜像老化规则”。 请求示例 DELETE https://{endpoint}/v2/manage/namespaces/group/repos/test/retentions/34 响应示例 {}
  • 请求参数 表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}/repos/{repository}/triggers 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String 组织名称。小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,小数点、下划线、中划线不能直接相连),小写字母或数字结尾,1-64个字符。 repository 是 String 镜像仓库名称
  • 响应参数 状态码: 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 触发的版本号
  • 响应示例 状态码: 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" } ]
  • 基本概念 帐号 用户注册时的帐号,帐号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于帐号是付费主体,为了确保帐号安全,建议您不要直接使用帐号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由帐号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看帐号ID和IAM用户ID。通常在调用API的鉴权过程中,您需要用到帐号、用户和密码等信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region,通用Region指面向公共租户提供通用云服务的Region;专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区(AZ,Availability Zone) 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您帐号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中创建资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下,您可以查看项目ID。 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。 父主题: 使用前必读
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 repository 是 String 镜像仓库名称。小写字母或数字开头,后面跟小写字母、数字、小数点、斜杠、下划线或中划线(其中下划线最多允许连续两个,小数点、斜杠、下划线、中划线不能直接相连),小写字母或数字结尾,1-128个字符。 is_public 是 Boolean 是否为公共仓库,可选值为true或false。 category 否 String 仓库类型,可设置为app_server, linux, framework_app, database, lang, other, arm。 description 否 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个字符。 self_auth UserAuth object 本用户权限 others_auths Array of UserAuth objects 其他用户的权限 表4 UserAuth 参数 参数类型 描述 user_id String 用户id,需要从IAM服务获取 user_name String 用户名,需要从IAM服务获取 auth Long 用户权限,7表示管理权限,3表示编辑权限,1表示读取权限
  • 响应示例 状态码: 200 查询成功 { "id" : 1422, "name" : "group", "self_auth" : { "user_id" : "3059e6b5562241fda3fa441cca6f228b", "user_name" : "liugenping", "auth" : 7 }, "others_auths" : [ { "user_id" : "fb3f175c1fd146ab8cdae3272be6107b", "user_name" : "liugenping01", "auth" : 7 } ] }
  • URI GET /v2/manage/namespaces/{namespace}/repos/{repository}/access 表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参数 参数 是否必选 参数类型 描述 source_tag 是 String 源镜像版本名称 destination_tag 是 String 目标镜像版本名称 override 否 Boolean 是否覆盖
  • URI POST /v2/manage/namespaces/{namespace}/repos/{repository}/tags 表1 路径参数 参数 是否必选 参数类型 描述 namespace 是 String 组织名称。小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,小数点、下划线、中划线不能直接相连),小写字母或数字结尾,1-64个字符。 repository 是 String 镜像仓库名称
共100000条