HelmChart管理接口
使用前提
查询Helm Chart列表
接口描述
查询指定命名空间下Helm Chart仓库中的Chart包列表。
请求结构
1GET /v1/instances/{instanceId}/projects/{projectName}/charts?pageNo={pageNo}&pageSize={pageSize}&chartName={chartName} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
projectName | String | 是 | Path参数 | 命名空间名称 |
chartName | String | 否 | Query参数 | Chart名称,支持模糊查询 |
pageNo | Integer | 否 | Query参数 | 当前页码,默认1 |
pageSize | Integer | 否 | Query参数 | 每页记录数,默认10 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
total | String | 结果记录条数 |
pageNo | String | 当前页码 |
pageSize | String | 每页记录数 |
items | List<HelmChart> | HelmChart结果列表 |
请求示例
1GET /v1/instances/ccr-4k74gw7d/projects/ns-test/charts HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 08:26:41 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7
6
7{
8 "total": 2,
9 "pageNo": 1,
10 "pageSize": 2,
11 "items": [
12 {
13 "created": "2022-08-01T06:39:05.756871973Z",
14 "deprecated": false,
15 "home": "",
16 "icon": "",
17 "latestVersion": "0.3.0",
18 "name": "helm-demo",
19 "totalVersions": 3,
20 "updated": "0001-01-01T00:00:00Z"
21 },
22 {
23 "created": "2022-08-01T07:13:54.692336735Z",
24 "deprecated": false,
25 "home": "",
26 "icon": "",
27 "latestVersion": "0.2.0",
28 "name": "helm-test",
29 "totalVersions": 2,
30 "updated": "0001-01-01T00:00:00Z"
31 }
32 ]
33}
上传Helm Chart文件
接口描述
上传一个Chart包到Helm Chart仓库中。
请求结构
1POST /v1/instances/{instanceId}/projects/{projectName}/charts HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
4Content-Length: <ContentLength>
5Content-Type: multipart/form-data
6Content-Disposition: form-data; name="chart"; filename="{chart}"
7Content-Disposition: form-data; name="prov"; filename="{prov}"
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
projectName | String | 是 | Path参数 | 命名空间名称 |
chart | File | 是 | Body参数 | Chart文件压缩包,仅支持 .tgz格式 |
prov | File | 否 | Body参数 | Chart出处文件,若Chart文件被签名,则需要上传出处(Provenance)文件 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
success | Boolean | 上传文件是否成功 |
result | String | 结果信息 |
请求示例
1GET /v1/instances/instances-test/projects/ns-test/repositories/ubuntu/tags?tagName=18.051&pageNo=1&pageSize=10 HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
4Content-Length: 802
5Content-Type: multipart/form-data
6Content-Disposition: form-data; name="chart"; filename="helm-test-0.2.0.tgz"
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 08:26:41 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7
6
7{
8 "result":null,
9 "success":true
10}
批量删除Helm Chart
接口描述
从Helm Chart仓库中批量删除Chart包。
请求结构
1DELETE /v1/instances/{instanceId}/projects/{projectName}/charts HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
4{
5 "items": {items}
6}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
projectName | String | 是 | Path参数 | 命名空间名称 |
items | List<String> | 是 | Body参数 | Chart名称数组 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
无响应参数
请求示例
1DELETE /v1/instances/ccr-4k74gw7d/projects/ns-test/charts HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
4{
5 "items": [
6 "helm-test2",
7 "helm-test3"
8 ]
9}
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 08:26:41 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7
删除Helm Chart
接口描述
从Helm Chart仓库中删除指定Chart包。
请求结构
1DELETE /v1/instances/{instanceId}/projects/{projectName}/charts/{chartName} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
projectName | String | 是 | Path参数 | 命名空间名称 |
chartName | String | 是 | Path参数 | Chart名称 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
无响应参数。
请求示例
1DELETE /v1/instances/ccr-4k74gw7d/projects/ns-test/charts/helm-test HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 08:26:41 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7
查询Helm Chart版本列表
接口描述
从Helm Chart仓库中查询特定Chart的版本列表。
请求结构
1GET /v1/instances/{instanceId}/projects/{projectName}/charts/{chartName}/versions?pageNo={pageNo}&pageSize={pageSize}&chartVersion={chartVersion} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
projectName | String | 是 | Path参数 | 命名空间名称 |
chartName | String | 是 | Path参数 | Chart名称 |
chartVersion | String | 否 | Query参数 | Chart版本号,支持模糊查询 |
pageNo | Integer | 否 | Query参数 | 当前页码,默认1 |
pageSize | Integer | 否 | Query参数 | 每页记录数,默认10 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
total | String | 私有网络域名 |
pageNo | String | 当前页码 |
pageSize | String | 每页记录数 |
items | List<HelmChartVersion> | Chart版本结果列表 |
请求示例
1GET /v1/instances/ccr-4k74gw7d/projects/ns-test/charts/helm-test/versions HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 08:26:41 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7
6
7{
8 "total": 2,
9 "pageNo": 1,
10 "pageSize": 5,
11 "items": [
12 {
13 "apiVersion": "v2",
14 "appVersion": "1.16.0",
15 "deprecated": false,
16 "description": "A Helm chart for Kubernetes",
17 "engine": null,
18 "home": "",
19 "icon": null,
20 "name": "helm-test",
21 "sources": [],
22 "version": "0.2.0",
23 "created": "2022-08-16T07:14:26.854394381Z",
24 "digest": "56d2e2ab42167c5bf7e28e4e8c73a87df43b8a48aa4bd3afb36a275566b77ae3",
25 "removed": false,
26 "urls": [
27 "helm-test-0.2.0.tgz"
28 ],
29 "maintainers": null
30 },
31 {
32 "apiVersion": "v2",
33 "appVersion": "1.16.0",
34 "deprecated": false,
35 "description": "A Helm chart for Kubernetes",
36 "engine": null,
37 "home": "",
38 "icon": null,
39 "name": "helm-test",
40 "sources": [],
41 "version": "0.1.0",
42 "created": "2022-08-16T07:13:54.692336735Z",
43 "digest": "bcf2ee71d357fc466b9f31d326f5aac41bae8c06d770114d4cfd99b6982c68a9",
44 "removed": false,
45 "urls": [
46 "helm-test-0.1.0.tgz"
47 ],
48 "maintainers": null
49 }
50 ]
51}
下载Helm Chart包
接口描述
从Helm Chart仓库中下载一个Chart包。
请求结构
1GET /v1/instances/{instanceId}/projects/{projectName}/charts/download/{filename} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
projectName | String | 是 | Path参数 | 命名空间名称 |
filename | String | 是 | Path参数 | Helm Chart文件名称,从Helm Chart版本列表返回结果中的urls字段查看Chart文件名称文件名称 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
响应结果为二进制文件流,无响应参数。
请求示例
1GET /v1/instances/ccr-4k74gw7d/projects/ns-test/charts/download/helm-test-0.1.0.tgz HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/x-tar
3Date: Mon, 01 Aug 2022 08:26:41 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7
6Transfer-Encoding:chunked
批量删除Helm Chart版本
接口描述
从Helm Chart仓库中批量删除Chart版本。
请求结构
1DELETE /v1/instances/{instanceId}/projects/{projectName}/charts/{chartName}/versions HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
4
5{
6 "items": {items}
7}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
projectName | String | 是 | Path参数 | 命名空间名称 |
chartName | String | 是 | Path参数 | Chart名称 |
items | List<String> | 是 | Body参数 | Chart版本号数组 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
无响应参数。
请求示例
1DELETE /v1/instances/ccr-4k74gw7d/projects/ns-test/charts/helm-test/versions HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
4
5{
6 "items": [
7 "0.4.0",
8 "0.3.0"
9 ]
10}
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 08:26:41 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7
删除Helm Chart版本
接口描述
从Helm Chart仓库中删除Chart包的指定版本。
请求结构
1DELETE /v1/instances/{instanceId}/projects/{projectName}/charts/{chartName}/versions/{chartVersion} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
projectName | String | 是 | Path参数 | 命名空间名称 |
chartName | String | 是 | Path参数 | Chart名称 |
chartVersion | String | 是 | Path参数 | Chart版本号 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
无响应参数。
请求示例
1DELETE /v1/instances/ccr-4k74gw7d/projects/ns-test/charts/helm-test/versions/0.2.0 HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 08:26:41 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7