镜像同步接口
更新时间：2022-08-23
使用前提
查询实例同步规则
接口描述
查询实例同步规则。
请求结构
Plain Text
1GET /v1/instances/{instanceId}/syncs?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.SyncPolicyResult> | 同步规则对象列表 |
请求示例
Plain Text
1GET /v1/instances/ccr-4k74gw7d/syncs HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
Plain Text
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 "id": 2,
14 "name": "bd2gz",
15 "description": "保定向广州同步镜像",
16 "syncType": "image",
17 "srcProjectName": "ns-test",
18 "srcRepositoryName": "**",
19 "srcTagName": "**",
20 "srcRegion": "bd",
21 "creationTime": "2022-08-12T02:47:39.812Z",
22 "updateTime": "2022-08-12T07:46:54.559Z",
23 "destInstanceId": "ccr-gz",
24 "destProjectName": "ns-test-gz",
25 "destRegion": "gz",
26 "trigger": {
27 "type": "event_based"
28 },
29 "override": false
30 }
31 ]
32}查询实例同步规则详情
接口描述
查询单个同步规则详细信息。
请求结构
Plain Text
1GET /v1/instances/{instanceId}/syncs/{policyId} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| policyId | String | 是 | Path参数 | 实例同步规则ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| creationTime | String | 同步规则创建时间 |
| description | String | 同步规则备注 |
| destInstanceId | String | 同步目标实例ID |
| destProjectName | String | 同步目标命名空间 |
| destRegion | String | 同步目标实例所在地域 |
| id | Integer | 同步规则ID |
| name | String | 同步规则名称 |
| override | Boolean | 是否覆盖目标实例已有的同名镜像 |
| srcProjectName | String | 源实例命名空间 |
| srcRegion | String | 源实例所在地域 |
| srcRepositoryName | String | 源仓库名称 |
| srcTagName | String | 源镜像版本 |
| syncType | String | 同步类型 |
| trigger | Replication.SyncTrigger | 触发器 |
| updateTime | String | 同步规则更新时间 |
请求示例
Plain Text
1GET /v1/instances/ccr-4k74gw7d/syncs/3 HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
Plain Text
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 "id": 3,
9 "name": "name",
10 "description": "description",
11 "syncType": "",
12 "srcProjectName": "ns-test",
13 "srcRepositoryName": "**",
14 "srcTagName": "**",
15 "srcRegion": "bd",
16 "creationTime": "2022-08-12T03:50:16.948Z",
17 "updateTime": "2022-08-12T03:50:16.948Z",
18 "destInstanceId": "ccr-gz",
19 "destProjectName": "ns-test-gz",
20 "destRegion": "gz",
21 "trigger": {
22 "type": "manual"
23 },
24 "override": true
25}创建实例同步规则
接口描述
创建实例同步规则。
请求结构
Plain Text
1POST /v1/instances/{instanceId}/syncs HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
4
5{
6 "description": {description},
7 "destInstanceId": {destInstanceId},
8 "destProjectName": {destProjectName},
9 "name": {name},
10 "override": {override},
11 "srcProjectName": {srcProjectName},
12 "srcRepository": {srcRepository},
13 "srcTag": {srcTag},
14 "syncType": {syncType},
15 "trigger": {trigger}
16}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| description | String | 否 | Body参数 | 同步规则备注 |
| destInstanceId | String | 是 | Body参数 | 同步目标实例ID |
| destProjectName | String | 否 | Body参数 | 同步目标命名空间 |
| name | String | 是 | Body参数 | 同步规则名称 |
| override | Boolean | 是 | Body参数 | 是否覆盖目标实例已有的同名镜像 |
| srcProjectName | String | 是 | Body参数 | 源实例命名空间 |
| srcRepository | String | 否 | Body参数 | 源仓库名称 |
| srcTag | String | 否 | Body参数 | 源镜像版本 |
| syncType | String | 否 | Body参数 | 同步类型 |
| trigger | SyncTriggerRequest | 是 | Body参数 | 触发器 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
Plain Text
1POST /v1/instances/ccr-4k74gw7d/syncs 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 "destInstanceId": "ccr-gz",
8 "destProjectName": "ns-test-gz",
9 "name": "bd2gz5",
10 "override": false,
11 "srcProjectName": "ns-test",
12 "srcRepository": "**",
13 "srcTag": "**",
14 "syncType": "image",
15 "trigger": {
16 "type": "event_based"
17 }
18}响应示例
Plain Text
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更新实例同步规则
接口描述
更新实例同步规则。
请求结构
Plain Text
1PUT /v1/instances/{instanceId}/syncs/{policyId} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string
4
5{
6 "description": {description},
7 "destInstanceId": {destInstanceId},
8 "destProjectName": {destProjectName},
9 "name": {name},
10 "override": {override},
11 "srcProjectName": {srcProjectName},
12 "srcRepository": {srcRepository},
13 "srcTag": {srcTag},
14 "syncType": {syncType},
15 "trigger": {trigger}
16}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| policyId | String | 是 | Path参数 | 同步规则ID |
| description | String | 否 | Body参数 | 同步规则备注 |
| destInstanceId | String | 是 | Body参数 | 同步目标实例ID |
| destProjectName | String | 否 | Body参数 | 同步目标命名空间 |
| name | String | 是 | Body参数 | 同步规则名称 |
| override | Boolean | 是 | Body参数 | 是否覆盖目标实例已有的同名镜像 |
| srcProjectName | String | 是 | Body参数 | 源实例命名空间 |
| srcRepository | String | 否 | Body参数 | 源仓库名称 |
| srcTag | String | 否 | Body参数 | 源镜像版本 |
| syncType | String | 否 | Body参数 | 同步类型 |
| trigger | SyncTriggerRequest | 是 | Body参数 | 触发器 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
Plain Text
1PUT /v1/instances/ccr-4k74gw7d/syncs/5 HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
4
5{
6 "name": "bd2gz7",
7 "description": "保定向广州同步镜像2",
8 "syncType": "image",
9 "srcProjectName": "ns-test",
10 "srcRepositoryName": "**",
11 "srcTagName": "**",
12 "destInstanceId": "ccr-gz",
13 "destProjectName": "ns-test-gz",
14 "trigger": {
15 "type": "event_based"
16 },
17 "override": false
18}响应示例
Plain Text
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删除实例同步规则
接口描述
删除实例同步规则。
请求结构
Plain Text
1DELETE /v1/instances/{instanceId}/syncs/{policyId} HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| policyId | String | 是 | Path参数 | 同步规则ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
Plain Text
1DELETE /v1/instances/ccr-4k74gw7d/syncs/1 HTTP/1.1
2Host: ccr.bd.baidubce.com
3Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
Plain Text
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查询实例同步执行记录
接口描述
查询实例同步执行记录。
请求结构
Plain Text
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 | 执行记录总数 |
| pageSize | Integer | 每页记录数 |
| items | List<ExecutionResult> | 执行记录列表 |
请求示例
Plain Text
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响应示例
Plain Text
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}查询实例同步执行记录详情
接口描述
查询单个实例同步任务详细信息。
请求结构
Plain Text
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 | 触发方式 |
请求示例
Plain Text
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响应示例
Plain Text
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}执行实例同步
接口描述
执行实例同步。
请求结构
Plain Text
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 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
Plain Text
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}响应示例
Plain Text
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停止实例同步
接口描述
停止实例同步。
请求结构
Plain Text
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 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
Plain Text
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响应示例
Plain Text
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)的记录。
请求结构
Plain Text
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> | 任务执行结果列表 |
请求示例
Plain Text
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响应示例
Plain Text
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}查询实例同步执行任务日志
接口描述
查询实例同步执行任务日志。
请求结构
Plain Text
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 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
Plain Text
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响应示例
Plain Text
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