镜像按需加载接口
更新时间：2022-08-23
使用前提
- 已成功创建企业版实例。按需加载容器镜像功能当前仅限高级版实例开启使用。
查询镜像加速规则
接口描述
查询镜像加速规则。
请求结构
GET /v1/instances/{instanceId}/accelerators/policies?policyName={policyName}&pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| policyName | String | 否 | Query参数 | 镜像加速规则名称，支持模糊查询 |
| pageNo | Integer | 否 | Query参数 | 当前页，默认为1 |
| pageSize | Integer | 否 | Query参数 | 每页记录数，默认为10 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| total | Integer | 镜像加速规则总数 |
| pageNo | Integer | 当前页 |
| pageSize | Integer | 每页记录数 |
| policies | List<AcceleratorPolicy> | 镜像加速规则对象列表 |
请求示例
GET /v1/instances/ccr-4k74gw7d/accelerators/policies 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: Fri, 05 Aug 2022 07:23:56 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 2ab7066b-3061-43dc-ac2e-ca360cab1dd4
{
"total": 1,
"pageNo": 1,
"pageSize": 10,
"policies": [
{
"creationTime": "2022-08-12T10:16:05.300603Z",
"description": "镜像加速规则测试",
"enabled": true,
"filters": [
{
"type": "project_name",
"value": "ns-test"
},
{
"type": "repository_name",
"value": "ubuntu"
}
],
"id": 1,
"name": "accelerators-test",
"updateTime": "2022-08-12T10:16:05.300603Z"
}
]
}查询镜像加速规则详情
接口描述
查询镜像加速规则详情。
请求结构
GET /v1/instances/{instanceId}/accelerators/policies/{policyId} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| policyId | String | 是 | Path参数 | 镜像加速规则ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| creationTime | String | 镜像加速规则创建时间 |
| description | String | 备注 |
| enabled | Boolean | 镜像加速规则是否开启 |
| filters | AcceleratorFilter | 触发规则 |
| id | Integer | 镜像加速规则ID |
| name | String | 镜像加速规则名称 |
| updateTime | String | 镜像加速规则更新时间 |
请求示例
GET /v1/instances/ccr-4k74gw7d/accelerators/policies/1 HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Fri, 05 Aug 2022 13:04:25 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 0f00a3b8-8be8-486e-8a6d-78c0c7d212bb
{
"creationTime": "2022-08-12T10:16:05.300603Z",
"description": "镜像加速规则测试",
"enabled": true,
"filters": [
{
"type": "project_name",
"value": "ns-test"
},
{
"type": "repository_name",
"value": "ubuntu"
}
],
"id": 1,
"name": "accelerators-test",
"updateTime": "2022-08-12T10:16:05.300603Z"
}创建镜像加速规则
接口描述
创建镜像加速规则。
请求结构
POST /v1/instances/{instanceId}/accelerators/policies HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"description": {description},
"filters": {filters},
"name": {name}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| description | String | 否 | Body参数 | 备注 |
| filters | AcceleratorFilter | 是 | Body参数 | 触发规则 |
| name | String | 是 | Body参数 | 镜像加速规则名称 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
POST /v1/instances/ccr-4k74gw7d/accelerators/policies HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"description": "镜像加速规则测试",
"filters": [
{
"type": "project_name",
"value": "ns-test"
},
{
"type": "repository_name",
"value": "ubuntu"
}
],
"name": "accelerators-test"
}响应示例
HTTP/1.1 200 OK
Content-Type: text/plain; charset=utf-8
Date: Mon, 08 Aug 2022 06:48:43 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: cc64f6f0-c1a5-4104-84d3-d7046ef758b4更新镜像加速规则
接口描述
更新镜像加速规则。
请求结构
PUT /v1/instances/{instanceId}/accelerators/policies/{policyId} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"description": {description},
"filters": {filters},
"name": {name}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| policyId | String | 是 | Path参数 | 镜像加速规则ID |
| description | String | 否 | Body参数 | 备注 |
| filters | AcceleratorFilter | 是 | Body参数 | 触发规则 |
| name | String | 是 | Body参数 | 镜像加速规则名称 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
PUT /v1/instances/ccr-4k74gw7d/accelerators/policies/4 HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"description": "镜像加速规则测试",
"filters": [
{
"type": "project_name",
"value": "ns-test"
},
{
"type": "repository_name",
"value": "ubuntu"
}
],
"name": "accelerators-test"
}响应示例
HTTP/1.1 200 OK
Content-Type: text/plain; charset=utf-8
Date: Mon, 08 Aug 2022 06:48:43 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: f1f82848-fd1a-4cb7-b955-dc6a2e582b14批量删除镜像加速规则
接口描述
批量删除镜像加速规则。
请求结构
DELETE /v1/instances/{instanceId}/accelerators/policies HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"items": {items}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| items | List<Integer> | 是 | Body参数 | 触发器策略ID数组 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
DELETE /v1/instances/ccr-4k74gw7d/accelerators/policies HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"items": [
1,
2
]
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 08 Aug 2022 07:28:25 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 8f21c375-ce7e-4ed7-b9a9-9499e9e1262d删除镜像加速规则
接口描述
根据镜像加速规则ID，删除镜像加速规则。
请求结构
DELETE /v1/instances/{instanceId}/accelerators/policies/{policyId} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| policyId | String | 是 | Path参数 | 镜像加速规则ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
DELETE /v1/instances/ccr-4k74gw7d/accelerators/policies/1 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, 08 Aug 2022 07:37:59 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 6d9c00f1-a7f5-4574-a012-c5d93ff4db2d测试镜像加速规则
接口描述
测试镜像加速规则。
请求结构
POST /v1/accelerators/policies/filters HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"filters": {filters},
"repository": {repository}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| filters | AcceleratorFilter | 是 | Body参数 | 触发规则 |
| repository | String | 是 | Body参数 | 镜像地址 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| matched | Boolean | 验证是否满足加速规则 |
请求示例
POST /v1/accelerators/policies/filters HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"filters": [ {
"type": "project_name",
"value": "ns-test"
},
{
"type": "repository_name",
"value": "ubuntu"
}],
"repository": "ccr-test-pub.cnc.bd.baidubce.com/ns-test/ubuntu"
}响应示例
HTTP/1.1 200 OK
Content-Type: text/plain; charset=utf-8
Date: Mon, 08 Aug 2022 06:48:43 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: a89e0780-2b4c-44d2-84e8-ce55883a5cb7
{
"matched": true
}启动或关闭镜像加速规则
接口描述
启动或关闭镜像加速规则。
请求结构
PUT /v1/instances/{instanceId}/accelerators/policies/{policyId}/enable?enabled={enabled} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| policyId | String | 是 | Path参数 | 镜像加速规则ID |
| enabled | String | 是 | Query参数 | 是否开启 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
PUT /v1/instances/ccr-4k74gw7d/accelerators/policies/1/enable?enabled=false HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 08 Aug 2022 08:07:21 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: d74d9f98-b00e-4e5e-a4ce-45bf0c998f39