HelmChart管理接口
更新时间：2022-08-23
使用前提
查询Helm Chart列表
接口描述
查询Helm Chart仓库中的Chart包列表。
请求结构
GET /v1/instances/{instanceId}/projects/{projectName}/charts?pageNo={pageNo}&pageSize={pageSize}&chartName={chartName} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: 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结果列表 |
请求示例
GET /v1/instances/ccr-4k74gw7d/projects/ns-test/charts HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 01 Aug 2022 08:26:41 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7
{
"total": 2,
"pageNo": 1,
"pageSize": 2,
"items": [
{
"created": "2022-08-01T06:39:05.756871973Z",
"deprecated": false,
"home": "",
"icon": "",
"latestVersion": "0.3.0",
"name": "helm-demo",
"totalVersions": 3,
"updated": "0001-01-01T00:00:00Z"
},
{
"created": "2022-08-01T07:13:54.692336735Z",
"deprecated": false,
"home": "",
"icon": "",
"latestVersion": "0.2.0",
"name": "helm-test",
"totalVersions": 2,
"updated": "0001-01-01T00:00:00Z"
}
]
}上传Helm Chart文件
接口描述
上传一个Chart包到Helm Chart仓库中。
请求结构
POST /v1/instances/{instanceId}/projects/{projectName}/charts HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
Content-Length: <ContentLength>
Content-Type: multipart/form-data
Content-Disposition: form-data; name="chart"; filename="{chart}"
Content-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 | 结果信息 |
请求示例
GET /v1/instances/instances-test/projects/ns-test/repositories/ubuntu/tags?tagName=18.051&pageNo=1&pageSize=10 HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
Content-Length: 802
Content-Type: multipart/form-data
Content-Disposition: form-data; name="chart"; filename="helm-test-0.2.0.tgz"响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 01 Aug 2022 08:26:41 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7
{
"result":null,
"success":true
}批量删除Helm Chart
接口描述
从Helm Chart仓库中批量删除Chart包。
请求结构
DELETE /v1/instances/{instanceId}/projects/{projectName}/charts HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"items": {items}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| projectName | String | 是 | Path参数 | 命名空间名称 |
| items | List<String> | 是 | Body参数 | Chart名称数组 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无响应参数
请求示例
DELETE /v1/instances/ccr-4k74gw7d/projects/ns-test/charts HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"items": [
"helm-test2",
"helm-test3"
]
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 01 Aug 2022 08:26:41 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7删除Helm Chart
接口描述
从Helm Chart仓库中删除指定Chart包。
请求结构
DELETE /v1/instances/{instanceId}/projects/{projectName}/charts/{chartName} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| projectName | String | 是 | Path参数 | 命名空间名称 |
| chartName | String | 是 | Path参数 | Chart名称 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无响应参数。
请求示例
DELETE /v1/instances/ccr-4k74gw7d/projects/ns-test/charts/helm-test HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 01 Aug 2022 08:26:41 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7查询Helm Chart版本列表
接口描述
从Helm Chart仓库中查询特定Chart的版本列表。
请求结构
GET /v1/instances/{instanceId}/projects/{projectName}/charts/{chartName}/versions?pageNo={pageNo}&pageSize={pageSize}&chartVersion={chartVersion} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: 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版本结果列表 |
请求示例
GET /v1/instances/ccr-4k74gw7d/projects/ns-test/charts/helm-test/versions HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 01 Aug 2022 08:26:41 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7
{
"total": 2,
"pageNo": 1,
"pageSize": 5,
"items": [
{
"apiVersion": "v2",
"appVersion": "1.16.0",
"deprecated": false,
"description": "A Helm chart for Kubernetes",
"engine": null,
"home": "",
"icon": null,
"name": "helm-test",
"sources": [],
"version": "0.2.0",
"created": "2022-08-16T07:14:26.854394381Z",
"digest": "56d2e2ab42167c5bf7e28e4e8c73a87df43b8a48aa4bd3afb36a275566b77ae3",
"removed": false,
"urls": [
"helm-test-0.2.0.tgz"
],
"maintainers": null
},
{
"apiVersion": "v2",
"appVersion": "1.16.0",
"deprecated": false,
"description": "A Helm chart for Kubernetes",
"engine": null,
"home": "",
"icon": null,
"name": "helm-test",
"sources": [],
"version": "0.1.0",
"created": "2022-08-16T07:13:54.692336735Z",
"digest": "bcf2ee71d357fc466b9f31d326f5aac41bae8c06d770114d4cfd99b6982c68a9",
"removed": false,
"urls": [
"helm-test-0.1.0.tgz"
],
"maintainers": null
}
]
}下载Helm Chart包
接口描述
从Helm Chart仓库中下载一个Chart包。
请求结构
GET /v1/instances/{instanceId}/projects/{projectName}/charts/download/{filename} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| projectName | String | 是 | Path参数 | 命名空间名称 |
| filename | String | 是 | Path参数 | Helm Chart文件名称，从Helm Chart版本列表返回结果中的urls字段查看Chart文件名称文件名称 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
响应结果为二进制文件流，无响应参数。
请求示例
GET /v1/instances/ccr-4k74gw7d/projects/ns-test/charts/download/helm-test-0.1.0.tgz HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/x-tar
Date: Mon, 01 Aug 2022 08:26:41 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7
Transfer-Encoding:chunked批量删除Helm Chart版本
接口描述
从Helm Chart仓库中批量删除Chart版本。
请求结构
DELETE /v1/instances/{instanceId}/projects/{projectName}/charts/{chartName}/versions HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"items": {items}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| projectName | String | 是 | Path参数 | 命名空间名称 |
| chartName | String | 是 | Path参数 | Chart名称 |
| items | List<String> | 是 | Body参数 | Chart版本号数组 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无响应参数。
请求示例
DELETE /v1/instances/ccr-4k74gw7d/projects/ns-test/charts/helm-test/versions HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"items": [
"0.4.0",
"0.3.0"
]
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 01 Aug 2022 08:26:41 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7删除Helm Chart版本
接口描述
从Helm Chart仓库中删除Chart包的指定版本。
请求结构
DELETE /v1/instances/{instanceId}/projects/{projectName}/charts/{chartName}/versions/{chartVersion} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| projectName | String | 是 | Path参数 | 命名空间名称 |
| chartName | String | 是 | Path参数 | Chart名称 |
| chartVersion | String | 是 | Path参数 | Chart版本号 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无响应参数。
请求示例
DELETE /v1/instances/ccr-4k74gw7d/projects/ns-test/charts/helm-test/versions/0.2.0 HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 01 Aug 2022 08:26:41 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6cee2df3-0505-4044-9f12-65db07ebbcd7