Helm接口

更新时间：2023-06-14

获取指定命名空间下的所有chart

接口描述

返回查询到指定项目下的所有chart列表

权限说明

所有API的安全认证一律采用Access Key与请求签名机制。 Access Key由Access Key ID和Secret Access Key组成，均为字符串。对于每个HTTP请求，使用下面所描述的算法生成一个认证字符串。提交认证字符串放在Authorization头域里。服务端根据生成算法验证认证字符串的正确性。认证字符串的格式为bce-auth-v{version}/{accessKeyId}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}。

version是正整数。
timestamp是生成签名时的UTC时间。
expirationPeriodInSeconds表示签名有效期限。
signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号（;）分隔，如host;x-bce-date。列表按照字典序排列。（本API签名仅使用host和x-bce-date两个header）
signature是256位签名的十六进制表示，由64个小写字母组成。

当百度智能云接收到用户的请求后，系统将使用相同的SK和同样的认证机制生成认证字符串，并与用户请求中包含的认证字符串进行比对。如果认证字符串相同，系统认为用户拥有指定的操作权限，并执行相关操作；如果认证字符串不同，系统将忽略该操作并返回错误码。

鉴权认证机制的详细内容请参见鉴权认证。

请求结构

 GET /v1/ccr/chartrepo/{projectName}/charts
 Host: ccr.baidubce.com
 Authorization: authorization string
 x-bce-date:yyyy-MM-dd'T'HH:mm:ss'Z'

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
projectName	String	是	param路径	命名空间名字
projectId	long	是	param路径	命名空间ID
keyword	String	否	Query参数	查询关键字
keywordType	String	否	Query参数	查询关键字类型，目前仅支持name(默认)
order	String	否	Query参数	排序方式，支持 asc，desc
orderBy	String	否	Query参数	用于排序字段，支持updateTime（默认）
pageNo	int	否	Query参数	当前页
pageSize	int	否	Query参数	每页记录数，最大100

响应参数

参数名称	类型	描述
result	List	结果列表
order	String	排序方式
orderBy	String	排序字段
pageNo	int	当前页
pageSize	int	每页记录数
totalCount	int	记录总数
name	String	chart名字
totalVersions	Integer	总共版本数
lastVersion	String	最后一个版本
created	String	创建时间
updated	String	更新时间
deprecated	boolean	是否弃用
home	String	所在目录
icon	String	图标

错误码

错误码	错误描述	HTTP状态码	中文解释
Internal server error	Failed to generate CCR resource.	500	内部错误

请求示例

 GET /v1/ccr/chartrepo/helm_test/charts?projectId=100&pageNo=1&pageSize=10&projectId=5 HTTP/1.1
 Host: ccr.baidubce.com
 Authorization: authorization string
 x-bce-date:yyyy-MM-dd'T'HH:mm:ss'Z'

响应示例

{
    "result": [
        {
            "name": "mychart",
            "totalVersions": 1,
            "latestVersion": "0.1.0",
        "created": "2020-03-13T06:54:30.741360483Z",
            "updated": "0001-01-01T00:00:00Z",
            "icon": "",
            "home": "",
            "deprecated": false
        }
    ],
    "orders": null,
    "orderBy": "created",
    "order": "asc",
    "pageNo": 1,
    "pageSize": 100,
    "totalCount": 1
}

获取指定chart下的所有版本

接口描述

返回查询到指定chart下的所有版本列表

权限说明

version是正整数。
timestamp是生成签名时的UTC时间。
expirationPeriodInSeconds表示签名有效期限。
signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号（;）分隔，如host;x-bce-date。列表按照字典序排列。（本API签名仅使用host和x-bce-date两个header）
signature是256位签名的十六进制表示，由64个小写字母组成。

鉴权认证机制的详细内容请参见鉴权认证。

请求结构

 GET /v1/ccr/chartrepo/{projectName}/charts/{name}
 Host: ccr.baidubce.com
 Authorization: authorization string
 x-bce-date:yyyy-MM-dd'T'HH:mm:ss'Z'

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
projectName	String	是	param路径	命名空间名字
name	String	是	param路径	chart名字
projectId	long	是	param路径	命名空间ID
keyword	String	否	Query参数	查询关键字
keywordType	String	否	Query参数	查询关键字类型，目前仅支持name
order	String	否	Query参数	排序方式，支持 asc，desc
orderBy	String	否	Query参数	用于排序字段，目前仅支持updateTime
pageNo	int	否	Query参数	当前页
pageSize	int	否	Query参数	每页记录数，最大100

响应参数

参数名称	类型	描述
result	List	结果列表
order	String	排序方式
orderBy	String	排序字段
pageNo	int	当前页
pageSize	int	每页记录数
totalCount	int	记录总数
name	String	chart名字
home	String	所在目录
sources	List	来源
version	String	版本
description	String	描述
engine	String	引擎
apiVersion	String	apiVersion
appVersion	String	appVersion
created	String	创建时间
digest	String	chart的sha256sum
urls	List	所在url
maintainers	List	维护者
keywords	List	关键字
deprecated	boolean	是否弃用

错误码

错误码	错误描述	HTTP状态码	中文解释
Internal server error	Failed to generate CCR resource.	500	内部错误

请求示例

 GET /v1/ccr/chartrepo/helm_test/charts/mychart?projectId=100&pageNo=1&pageSize=10&projectId=5 HTTP/1.1
 Host: ccr.baidubce.com
 Authorization: authorization string
 x-bce-date:yyyy-MM-dd'T'HH:mm:ss'Z'

响应示例

{
    "result": [
        {
            "name": "mychart",
            "home": null,
            "sources": null,
            "version": "0.1.0",
            "description": "A Helm chart for Kubernetes",
            "keywords": null,
            "engine": null,
            "icon": null,
            "apiVersion": "v2",
            "appVersion": "1.16.0",
            "deprecated": null,
            "created": "2020-03-13T06:54:30.741360483Z",
            "removed": null,
            "digest": "896935a875c8fe8f8b9b81e5862413de316f8da3d6d9a7e0f6f1e90f6204f551",
            "urls": [
                "http://106.13.184.24/chartrepo/helm_test/charts/mychart-0.1.0.tgz"
            ],
            "maintainers": null
        }
    ],
    "orders": null,
    "orderBy": "created",
    "order": "asc",
    "pageNo": 1,
    "pageSize": 100,
    "totalCount": 1
}

将chart文件上传到指定项目

接口描述

返回上传结果

权限说明

version是正整数。
timestamp是生成签名时的UTC时间。
expirationPeriodInSeconds表示签名有效期限。
signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号（;）分隔，如host;x-bce-date。列表按照字典序排列。（本API签名仅使用host和x-bce-date两个header）
signature是256位签名的十六进制表示，由64个小写字母组成。

鉴权认证机制的详细内容请参见鉴权认证。

请求结构

 POST /v1/ccr/chartrepo/{projectId}/charts
 Host: ccr.baidubce.com
 Authorization: authorization string
 x-bce-date:yyyy-MM-dd'T'HH:mm:ss'Z'

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
projectId	long	是	param路径	命名空间ID
chart	MultipartFile	是	param参数	chart文件
prov	MultipartFile	是	param参数	prov文件

响应参数

参数名称	类型	描述
action	String	动作
targetName	String	操作对象

错误码

错误码	错误描述	HTTP状态码	中文解释
Internal server error	Failed to generate CCR resource.	500	内部错误

请求示例

 POST /v1/ccr/chartrepo/100/charts/mychart HTTP/1.1
 Host: ccr.baidubce.com
 Authorization: authorization string
 x-bce-date:yyyy-MM-dd'T'HH:mm:ss'Z'

响应示例

{
    "targetName": "100",
    "action": "upload"
}

删除指定chart的所有版本

接口描述

返回删除结果

权限说明

version是正整数。
timestamp是生成签名时的UTC时间。
expirationPeriodInSeconds表示签名有效期限。
signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号（;）分隔，如host;x-bce-date。列表按照字典序排列。（本API签名仅使用host和x-bce-date两个header）
signature是256位签名的十六进制表示，由64个小写字母组成。

鉴权认证机制的详细内容请参见鉴权认证。

请求结构

 DELETE /v1/ccr/chartrepo/{projectName}/charts/{name}
 Host: ccr.baidubce.com
 Authorization: authorization string
 x-bce-date:yyyy-MM-dd'T'HH:mm:ss'Z'

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
projectName	String	是	param路径	命名空间名字
name	String	是	param路径	chart名字
projectId	long	是	param路径	命名空间ID

响应参数

参数名称	类型	描述
action	String	动作
targetName	String	操作对象

错误码

错误码	错误描述	HTTP状态码	中文解释
Internal server error	Failed to generate CCR resource.	500	内部错误

请求示例

 DELETE /v1/ccr/chartrepo/helm_test/charts/mychart?projectId=100 HTTP/1.1
 Host: ccr.baidubce.com
 Authorization: authorization string
 x-bce-date:yyyy-MM-dd'T'HH:mm:ss'Z'

响应示例

{
    "targetName": "mychart",
    "action": "delete"
}

##删除指定chart版本

接口描述

返回删除结果

请求结构

 DELETE /v1/ccr/chartrepo/{projectName}/charts/{name}/{version}
 Host: ccr.baidubce.com
 Authorization: authorization string
 x-bce-date:yyyy-MM-dd'T'HH:mm:ss'Z'

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
projectName	String	是	param路径	命名空间名字
name	String	是	param路径	chart名字
version	String	是	param路径	chart版本
projectId	long	是	param路径	命名空间ID

响应参数

参数名称	类型	描述
action	String	动作
targetName	String	操作对象

错误码

错误码	错误描述	HTTP状态码	中文解释
Internal server error	Failed to generate CCR resource.	500	内部错误

请求示例

DELETE /v1/ccr/chartrepo/helm_test/charts/mychart/0.1.0?projectId=100 HTTP/1.1
Host: ccr.baidubce.com
Authorization: authorization string
x-bce-date:yyyy-MM-dd'T'HH:mm:ss'Z'

响应示例

{
    "targetName": "0.1.0",
    "action": "delete"
}

镜像迁移接口

镜像版本和镜像版本扫描接口

容器镜像服务 CCR

容器镜像服务 CCR

Helm接口

获取指定命名空间下的所有chart

获取指定chart下的所有版本

将chart文件上传到指定项目

删除指定chart的所有版本