命名空间接口
更新时间：2024-02-27
使用前提
- 已成功创建企业版实例。
获取当前用户的命名空间列表
接口描述
返回当前用户的命名空间列表。
请求结构
GET /v1/instances/{instanceId}/projects?projectName={projectName}&pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | 实例ID |
| projectName | String | 否 | Query参数 | 命名空间名称，用于模糊查询 |
| pageNo | Integer | 否 | Query参数 | 当前页 |
| pageSize | Integer | 否 | Query参数 | 每页记录数，默认为10，最大100 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| pageNo | Integer | 当前页 |
| pageSize | Integer | 每页记录数 |
| projects | List<project> | 命名空间列表 |
| total | Integer | 用户命名空间总数 |
请求示例
GET /v1/instances/instances-test/projects HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-07-28T03:05:45Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Thu, 28 Jul 2022 03:05:46 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: b679248a-1004-42aa-b4a5-92be2952a1b8
{
"total": 3,
"pageNo": 1,
"pageSize": 10,
"projects": [
{
"chartCount": 0,
"creationTime": "2022-07-25T11:30:05.728Z",
"projectName": "ns1",
"projectId": 2,
"repoCount": 1,
"updateTime": "2022-07-25T11:30:05.728Z",
"autoScan": "true",
"public": "false"
},
{
"chartCount": 0,
"creationTime": "2022-07-25T11:30:13.936Z",
"projectName": "ns2",
"projectId": 3,
"repoCount": 0,
"updateTime": "2022-07-25T11:30:13.936Z",
"autoScan": "",
"public": "false"
},
{
"chartCount": 0,
"creationTime": "2022-07-25T11:30:21.322Z",
"projectName": "ns-public",
"projectId": 4,
"repoCount": 2,
"updateTime": "2022-07-25T11:30:21.322Z",
"autoScan": "false",
"public": "true"
}
]
}创建命名空间
接口描述
同时支持创建私有和公有命名空间，命名空间名字全局唯一。
请求结构
POST /v1/instances/{instanceId}/projects HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"projectName": {projectName},
"public": {public}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| projectName | String | 是 | Body参数 | 命名空间名称 |
| public | String | 是 | Body参数 | 命名空间类型，有两种类型。true表示公有，false表示私有 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| autoScan | String | 推送时是否自动扫描镜像，有效值为true、false |
| chartCount | Integer | 命名空间下的chart数量 |
| creationTime | String | 命名空间的创建时间，格式为date-time |
| projectId | Integer | 命名空间ID |
| projectName | String | 命名空间名字 |
| public | String | 命名空间类型，有两种类型。true表示公有，false表示私有 |
| repoCount | Integer | 命名空间下镜像仓库的数量 |
| updateTime | String | 命名空间更新时间，格式为date-time |
请求示例
POST /v1/instances/instances-test/projects HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-07-28T03:16:14Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"projectName": "ns-test",
"public": "false"
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Thu, 28 Jul 2022 03:16:14 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 4ad94983-4dbb-44e8-832e-a8ec8b5c3aec
{
"chartCount": 0,
"creationTime": "2022-07-28T03:16:14.551Z",
"projectName": "ns-test",
"projectId": 13,
"repoCount": 0,
"updateTime": "2022-07-28T03:16:14.551Z",
"autoScan": "",
"public": "false"
}批量删除命名空间
接口描述
批量删除命名空间。
请求结构
DELETE /v1/instances/{instanceId}/projects HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"items": {items}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | 实例ID |
| items | List<String> | 是 | Body参数 | 命名空间名称数组 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
DELETE /v1/instances/instances-test/projects HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-07-28T03:19:27Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"items": [
"ns-test1",
"ns-test2"
]
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Thu, 28 Jul 2022 03:19:27 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6a169a3e-c6ec-42dd-8522-43092cb84c5c通过命名空间名称查询命名空间
接口描述
通过命名空间名称projectName查询命名空间。
请求结构
GET /v1/instances/{instanceId}/projects/{projectName} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | 实例ID |
| projectName | String | 是 | Path参数 | 命名空间名称 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| autoScan | String | 推送时是否自动扫描镜像，有效值为true、false |
| chartCount | Integer | 命名空间下的chart数量 |
| creationTime | String | 命名空间的创建时间，格式为date-time |
| projectId | Integer | 命名空间ID |
| projectName | String | 命名空间名字 |
| public | String | 命名空间类型，有两种类型。true表示公有，false表示私有 |
| repoCount | Integer | 命名空间下镜像仓库的数量 |
| updateTime | String | 命名空间更新时间，格式为date-time |
请求示例
GET /v1/instances/instances-test/projects/ns-test HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-07-28T03:22:05Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Thu, 28 Jul 2022 03:22:05 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: e0c2fb91-04f6-4c55-ba3d-0844e081052b
{
"chartCount": 0,
"creationTime": "2022-07-25T11:30:13.936Z",
"projectName": "ns-test",
"projectId": 3,
"repoCount": 0,
"updateTime": "2022-07-25T11:30:13.936Z",
"autoScan": "",
"public": "false"
}更新命名空间
接口描述
更新命名空间。
请求结构
PUT /v1/instances/{instanceId}/projects/{projectName} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"autoScan": {autoScan},
"public": {public}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | 实例ID |
| projectName | String | 是 | Path参数 | 命名空间名称 |
| autoScan | String | 是 | Body参数 | 推送时是否自动扫描镜像，有效值为true、false |
| public | String | 是 | Body参数 | 命名空间类型，有两种类型。true表示公有，false表示私有 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| autoScan | String | 推送时是否自动扫描镜像，有效值为true、false |
| chartCount | Integer | 命名空间下的chart数量 |
| creationTime | String | 命名空间的创建时间，格式为date-time |
| projectId | Integer | 命名空间ID |
| projectName | String | 命名空间名字 |
| public | String | 命名空间类型，有两种类型。true表示公有，false表示私有 |
| repoCount | Integer | 命名空间下镜像仓库的数量 |
| updateTime | String | 命名空间更新时间，格式为date-time |
请求示例
PUT /v1/instances/instances-test/projects/ns-test HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-07-28T03:23:34Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"autoScan": "true",
"public": "true"
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Thu, 28 Jul 2022 03:23:35 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: df959f0d-a7c4-48b4-9dfe-f77fb9802e90
{
"chartCount": 0,
"creationTime": "2022-07-25T11:30:05.728Z",
"projectName": "ns-test",
"projectId": 2,
"repoCount": 1,
"updateTime": "2022-07-25T11:30:05.728Z",
"autoScan": "true",
"public": "true"
}删除命名空间
接口描述
删除命名空间。
请求结构
DELETE /v1/instances/{instanceId}/projects/{projectName} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | 实例ID |
| projectName | String | 是 | Path参数 | 命名空间名称 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
DELETE /v1/instances/instances-test/projects/ns-test HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-07-28T03:25:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
Content-Type: application/json; charset=utf-8
Date: Thu, 28 Jul 2022 03:25:43 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: b42840ec-a200-49c9-86bd-58687b7009bb