镜像迁移接口
使用前提
查询镜像迁移规则
接口描述
查询镜像迁移规则。
请求结构
1GET /v1/instances/{instanceId}/replications?policyName={policyName}&pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | 实例ID |
policyName | String | 否 | Query参数 | 镜像迁移规则名称,支持模糊查询 |
pageNo | Integer | 否 | Query参数 | 当前页,默认为1 |
pageSize | Integer | 否 | Query参数 | 每页记录数,默认为10 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
total | Integer | 镜像迁移规则总数 |
pageNo | Integer | 当前页 |
pageSize | Integer | 每页记录数 |
items | List<Replication.PolicyResult> | 镜像迁移规则对象列表 |
请求示例
1GET /v1/instances/ccr-4k74gw7d/replications 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: Fri, 05 Aug 2022 07:23:56 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 228e31d4-f8fa-46d6-be36-e4fec9f10aed
6
7{
8 "total": 1,
9 "pageNo": 1,
10 "pageSize": 10,
11 "items": [
12 {
13 "creationTime": "2022-08-11T12:01:12.108Z",
14 "deletion": false,
15 "description": "",
16 "destProjectName": "ns-test",
17 "destRegistry": {
18 "creationTime": "0001-01-01T00:00:00.000Z",
19 "credential": {
20 "accessKey": "",
21 "accessSecret": "*****",
22 "type": "secret"
23 },
24 "description": "",
25 "id": 0,
26 "insecure": true,
27 "name": "Local",
28 "status": "healthy",
29 "type": "harbor",
30 "updateTime": "0001-01-01T00:00:00.000Z",
31 "url": "http://ccr-test-harbor-core:80",
32 "region": ""
33 },
34 "enabled": true,
35 "filters": [
36 {
37 "type": "name",
38 "value": "my-public/prepare"
39 },
40 {
41 "type": "tag",
42 "value": "1.0"
43 }
44 ],
45 "id": 1,
46 "name": "migrate1",
47 "override": false,
48 "srcRegistry": {
49 "creationTime": "2022-08-11T12:00:08.397Z",
50 "credential": {
51 "accessKey": "100e5554da9b46e589b4c71dcc0d858f",
52 "accessSecret": "*****",
53 "type": "basic"
54 },
55 "description": "",
56 "id": 1,
57 "insecure": false,
58 "name": "Local",
59 "status": "healthy",
60 "type": "harbor",
61 "updateTime": "2022-08-11T12:00:08.397Z",
62 "url": "https://registry.baidubce.com",
63 "region": "com"
64 },
65 "trigger": {
66 "triggerSettings": null,
67 "type": "manual"
68 },
69 "updateTime": "2022-08-12T08:19:52.212Z",
70 "executionTimes": 3
71 }
72 ]
73}
查询镜像迁移规则详情
接口描述
查询单个迁移规则详细信息。
请求结构
1GET /v1/instances/{instanceId}/replications/{policyId} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
policyId | String | 是 | Path参数 | 镜像迁移规则名称ID |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
creationTime | String | 镜像迁移规则创建时间 |
deletion | Boolean | 级联删除 |
description | String | 镜像迁移规则描述 |
destProjectName | String | 目的命名空间 |
destRegistry | Replication.Registry | 目的仓库 |
enabled | Boolean | 镜像迁移规则状态 |
executionTimes | Integer | 镜像迁移规则执行次数 |
filters | List<Replication.Filter> | 资源筛选 |
id | Integer | 镜像迁移规则ID |
name | String | 镜像迁移规则名称 |
override | Boolean | 是否覆盖目的仓库上的资源 |
srcRegistry | Replication.Registry | 源仓库 |
trigger | Replication.Trigger | 触发器 |
updateTime | String | 镜像迁移规则更新时间 |
请求示例
1GET /v1/instances/ccr-4k74gw7d/replications/6 HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 13:07:37 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: d8bb93db-9e4e-436e-b67c-91847b161c43
6
7{
8 "creationTime": "2022-08-12T08:22:16.866Z",
9 "deletion": false,
10 "description": "string",
11 "destProjectName": "ns-test",
12 "destRegistry": {
13 "creationTime": "0001-01-01T00:00:00.000Z",
14 "credential": {
15 "accessKey": "",
16 "accessSecret": "*****",
17 "type": "secret"
18 },
19 "description": "",
20 "id": 0,
21 "insecure": true,
22 "name": "Local",
23 "status": "healthy",
24 "type": "harbor",
25 "updateTime": "0001-01-01T00:00:00.000Z",
26 "url": "http://ccr-test-harbor-core:80",
27 "region": ""
28 },
29 "enabled": true,
30 "filters": [
31 {
32 "type": "name",
33 "value": "my-public/prepare"
34 }
35 ],
36 "id": 6,
37 "name": "migrate2",
38 "override": true,
39 "srcRegistry": {
40 "creationTime": "2022-08-11T12:00:08.397Z",
41 "credential": {
42 "accessKey": "100e5554da9b46e589b4c71dcc0d858f",
43 "accessSecret": "*****",
44 "type": "basic"
45 },
46 "description": "",
47 "id": 1,
48 "insecure": false,
49 "name": "Local",
50 "status": "healthy",
51 "type": "harbor",
52 "updateTime": "2022-08-11T12:00:08.397Z",
53 "url": "https://registry.baidubce.com",
54 "region": "com"
55 },
56 "trigger": {
57 "triggerSettings": null,
58 "type": "manual"
59 },
60 "updateTime": "2022-08-12T08:22:16.866Z",
61 "executionTimes": 0
62}
创建镜像迁移规则
接口描述
创建镜像迁移规则。
请求结构
1POST /v1/instances/{instanceId}/replications HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
4
5{
6 "description": {description},
7 "destProjectName": {destProjectName},
8 "filters": {filters}
9 "name": {name},
10 "override": {override},
11 "srcRegistry": {srcRegistry},
12 "trigger": {trigger}
13}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
description | String | 否 | Body参数 | 镜像迁移规则描述 |
destProjectName | String | 是 | Body参数 | 目的命名空间 |
filters | List<Replication.FilterReques> | 是 | Body参数 | 资源筛选 |
name | String | 是 | Body参数 | 镜像迁移规则名称 |
override | Boolean | 是 | Body参数 | 是否覆盖目的仓库上的资源 |
srcRegistry | Replication.RegistryRequest | 是 | Body参数 | 源仓库 |
trigger | Replication.TriggerRequest | 是 | Body参数 | 触发器 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
1POST /v1/instances/ccr-4k74gw7d/replications HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
4
5{
6 "description": "description",
7 "destProjectName": "ns-test",
8 "filters": [
9 {
10 "type": "name",
11 "value": "my-public/prepare"
12 }
13 ],
14 "name": "migrate2",
15 "override": true,
16 "srcRegistry": {
17 "id": 1
18 },
19 "trigger": {
20 "type": "manual"
21 }
22}
响应示例
1HTTP/1.1 200 OK
2Content-Type: text/plain; charset=utf-8
3Date: Mon, 08 Aug 2022 06:48:43 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: a89e0780-2b4c-44d2-84e8-ce55883a5cb7
更新镜像迁移规则
接口描述
更新镜像迁移规则。
请求结构
1PUT /v1/instances/{instanceId}/replications/{policyId} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
4
5{
6 "description": {description},
7 "destProjectName": {destProjectName},
8 "filters": {filters}
9 "name": {name},
10 "override": {override},
11 "srcRegistry": {srcRegistry},
12 "trigger": {trigger}
13}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
policyId | String | 是 | Path参数 | 镜像迁移规则ID |
description | String | 否 | Body参数 | 镜像迁移规则描述 |
destProjectName | String | 是 | Body参数 | 目的命名空间 |
filters | List<Replication.FilterReques> | 是 | Body参数 | 资源筛选 |
name | String | 是 | Body参数 | 镜像迁移规则名称 |
override | Boolean | 是 | Body参数 | 是否覆盖目的仓库上的资源 |
srcRegistry | Replication.RegistryRequest | 是 | Body参数 | 源仓库 |
trigger | Replication.TriggerRequest | 是 | Body参数 | 触发器 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
1PUT /v1/instances/ccr-4k74gw7d/replications/6 HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
4
5{
6 "description": "测试",
7 "destProjectName": "ns-test",
8 "filters": [
9 {
10 "type": "name",
11 "value": "my-public/prepare"
12 }
13 ],
14 "name": "migrate3",
15 "override": true,
16 "srcRegistry": {
17 "id": 1
18 },
19 "trigger": {
20 "type": "manual"
21 }
22}
响应示例
1HTTP/1.1 200 OK
2Content-Type: text/plain; charset=utf-8
3Date: Mon, 08 Aug 2022 06:48:43 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: b7fcf872-51d2-459d-96e9-e47ee3ae4d74
删除镜像迁移规则
接口描述
删除镜像迁移规则。
请求结构
1DELETE /v1/instances/{instanceId}/replications/{policyId} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
policyId | String | 是 | Path参数 | 镜像迁移规则ID |
响应头域
除公共头域外,无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
1DELETE /v1/instances/ccr-4k74gw7d/replications/1 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, 08 Aug 2022 07:37:59 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: b0313b16-3a75-4a4b-aa89-26d63bdd0f15
查询镜像迁移执行记录
接口描述
查询镜像迁移执行记录。
请求结构
1GET /v1/instances/{instanceId}/executions?policyId={policyId}&pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | 实例ID |
policyId | String | 否 | Query参数 | 镜像迁移规则ID |
pageNo | Integer | 否 | Query参数 | 当前页,默认为1 |
pageSize | Integer | 否 | Query参数 | 每页记录数,默认为10 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
total | Integer | 执行记录总数 |
pageNo | Integer | 当前页 |
pageSize | Integer | 每页记录数 |
items | List<ExecutionResult> | 执行记录列表 |
请求示例
1GET /v1/instances/ccr-4k74gw7d/executions?policyId=3&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
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Fri, 05 Aug 2022 07:23:56 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: b2840a4d-885b-4943-a7f6-a99aa160c327
6
7{
8 "total": 1,
9 "pageNo": 1,
10 "pageSize": 10,
11 "items": [
12 {
13 "endTime": "2022-08-12T07:58:44.000Z",
14 "failed": 0,
15 "id": 14,
16 "inProgress": 0,
17 "policyId": 3,
18 "startTime": "2022-08-12T07:58:22.503Z",
19 "status": "Succeed",
20 "statusText": "",
21 "stopped": 0,
22 "succeed": 2,
23 "total": 2,
24 "trigger": "manual"
25 }
26 ]
27}
查询镜像迁移执行记录详情
接口描述
查询镜像迁移任务详细信息。
请求结构
1GET /v1/instances/{instanceId}/executions/{executionId} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
executionId | String | 是 | Path参数 | 镜像迁移执行任务ID |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
endTime | String | 结束时间 |
failed | Integer | 执行失败的次数 |
id | Integer | 执行任务ID |
inProgress | Integer | 正在进行的任务数量 |
policyId | Integer | 执行任务所属的规则ID |
startTime | String | 开始时间 |
status | String | 执行状态 |
statusText | String | 状态文本 |
stopped | Integer | 停止执行的计数 |
succeed | Integer | 成功执行的计数 |
total | Integer | 所有执行的计数 |
trigger | String | 触发方式 |
请求示例
1GET /v1/instances/ccr-4k74gw7d/executions/14 HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 13:07:37 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: ddcbf3ac-7f21-497d-933c-76bab87f66df
6
7{
8 "endTime": "2022-08-12T07:58:44.000Z",
9 "failed": 0,
10 "id": 14,
11 "inProgress": 0,
12 "policyId": 3,
13 "startTime": "2022-08-12T07:58:22.503Z",
14 "status": "Succeed",
15 "statusText": "",
16 "stopped": 0,
17 "succeed": 2,
18 "total": 2,
19 "trigger": "manual"
20}
执行镜像迁移
接口描述
执行镜像迁移。
请求结构
1POST /instances/{instanceId}/executions HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
4
5{
6 "policyId": {policyId}
7}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
policyId | Integer | 是 | Body参数 | 执行任务所属的规则ID |
响应头域
除公共头域外,无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
1POST /v1/instances/ccr-4k74gw7d/executions HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
4
5{
6 "policyId": 1
7}
响应示例
1HTTP/1.1 200 OK
2Content-Type: text/plain; charset=utf-8
3Date: Mon, 08 Aug 2022 06:48:43 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 9aa8d595-3ded-444f-91ed-1deaf1d909dd
停止镜像迁移
接口描述
停止镜像迁移。
请求结构
1PUT /v1/instances/{instanceId}/executions/{executionId} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
executionId | String | 是 | Path参数 | 任务ID |
响应头域
除公共头域外,无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
1PUT /v1/instances/ccr-4k74gw7d/executions/12 HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
响应示例
1HTTP/1.1 200 OK
2Content-Type: text/plain; charset=utf-8
3Date: Mon, 08 Aug 2022 06:48:43 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: d650950d-7d0d-420f-8af9-319166e6514c
查询镜像迁移执行任务记录
接口描述
查询镜像迁移执行(execution)的一次任务(task)的记录。
请求结构
1GET /v1/instances/{instanceId}/executions/{executionId}/tasks?pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | 实例ID |
executionId | String | 是 | Path参数 | 任务ID |
pageNo | Integer | 否 | Query参数 | 当前页,默认为1 |
pageSize | Integer | 否 | Query参数 | 每页记录数,默认为10 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
total | Integer | 任务执行结果总数 |
pageNo | Integer | 当前页 |
pageSize | Integer | 每页记录数 |
items | List<TaskResult> | 任务执行结果列表 |
请求示例
1GET /v1/instances/ccr-4k74gw7d/executions/6/tasks 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: Fri, 05 Aug 2022 07:23:56 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: 401c4614-622d-42fe-9c88-e106eb3ab08e
6
7{
8 "total": 1,
9 "pageNo": 1,
10 "pageSize": 10,
11 "items": [
12 {
13 "destResource": "ns-test/prepare [1 item(s) in total]",
14 "endTime": "2022-08-11T12:01:40.000Z",
15 "executionId": 6,
16 "id": 6,
17 "jobId": "5f0453e61b33f2dba32209a9",
18 "operation": "copy",
19 "resourceType": "image",
20 "srcResource": "my-public/prepare [1 item(s) in total]",
21 "startTime": "2022-08-11T12:01:22.000Z",
22 "status": "Succeed"
23 }
24 ]
25}
查询镜像迁移执行任务日志
接口描述
查询镜像迁移执行任务日志。
请求结构
1GET /v1/instances/{instanceId}/executions/{executionId}/tasks/{taskId}/log HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
instanceId | String | 是 | Path参数 | CCR实例ID |
executionId | String | 是 | Path参数 | 实例镜像迁移任务ID |
taskId | String | 是 | Path参数 | 任务ID |
响应头域
除公共头域外,无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
1GET /v1/instances/ccr-4k74gw7d/executions/6/tasks/6/log HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3Date: Mon, 01 Aug 2022 13:07:37 GMT
4X-Bce-Gateway-Region: BJ
5X-Bce-Request-Id: ddcbf3ac-7f21-497d-933c-76bab87f66df