镜像同步接口

更新时间：2022-08-23

使用前提

已成功创建两个企业版实例。
同步源中至少存在一个命名空间，具体信息请参见管理命名空间。

查询实例同步规则

接口描述

查询实例同步规则。

请求结构

GET /v1/instances/{instanceId}/syncs?policyName={policyName}&pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: 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>	同步规则对象列表

请求示例

GET /v1/instances/ccr-4k74gw7d/syncs 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: 401c4614-622d-42fe-9c88-e106eb3ab08e

{
    "total": 1,
    "pageNo": 1,
    "pageSize": 10,
    "items": [
        {
            "id": 2,
            "name": "bd2gz",
            "description": "保定向广州同步镜像",
            "syncType": "image",
            "srcProjectName": "ns-test",
            "srcRepositoryName": "**",
            "srcTagName": "**",
            "srcRegion": "bd",
            "creationTime": "2022-08-12T02:47:39.812Z",
            "updateTime": "2022-08-12T07:46:54.559Z",
            "destInstanceId": "ccr-gz",
            "destProjectName": "ns-test-gz",
            "destRegion": "gz",
            "trigger": {
                "type": "event_based"
            },
            "override": false
        }
    ]
}

查询实例同步规则详情

接口描述

查询单个同步规则详细信息。

请求结构

GET /v1/instances/{instanceId}/syncs/{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	同步规则备注
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	同步规则更新时间

请求示例

GET /v1/instances/ccr-4k74gw7d/syncs/3 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, 01 Aug 2022 13:07:37 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: ddcbf3ac-7f21-497d-933c-76bab87f66df

{
    "id": 3,
    "name": "name",
    "description": "description",
    "syncType": "",
    "srcProjectName": "ns-test",
    "srcRepositoryName": "**",
    "srcTagName": "**",
    "srcRegion": "bd",
    "creationTime": "2022-08-12T03:50:16.948Z",
    "updateTime": "2022-08-12T03:50:16.948Z",
    "destInstanceId": "ccr-gz",
    "destProjectName": "ns-test-gz",
    "destRegion": "gz",
    "trigger": {
        "type": "manual"
    },
    "override": true
}

创建实例同步规则

接口描述

创建实例同步规则。

请求结构

POST /v1/instances/{instanceId}/syncs HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string

{
  	"description": {description},
  	"destInstanceId": {destInstanceId},
  	"destProjectName": {destProjectName},
  	"name": {name},
  	"override": {override},
  	"srcProjectName": {srcProjectName},
  	"srcRepository": {srcRepository},
  	"srcTag": {srcTag},
  	"syncType": {syncType},
  	"trigger": {trigger}
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
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参数	触发器

响应头域

除公共头域外，无其它特殊头域。

响应参数

如果请求成功无响应参数。如果请求失败则返回标准错误结构。

请求示例

POST /v1/instances/ccr-4k74gw7d/syncs HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6

{
    "description": "保定向广州同步镜像",
    "destInstanceId": "ccr-gz",
    "destProjectName": "ns-test-gz",
    "name": "bd2gz5",
    "override": false,
    "srcProjectName": "ns-test",
    "srcRepository": "**",
    "srcTag": "**",
    "syncType": "image",
    "trigger": {
        "type": "event_based"
    }
}

响应示例

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

更新实例同步规则

接口描述

更新实例同步规则。

请求结构

PUT /v1/instances/{instanceId}/syncs/{policyId} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string

{
  	"description": {description},
  	"destInstanceId": {destInstanceId},
  	"destProjectName": {destProjectName},
  	"name": {name},
  	"override": {override},
  	"srcProjectName": {srcProjectName},
  	"srcRepository": {srcRepository},
  	"srcTag": {srcTag},
  	"syncType": {syncType},
  	"trigger": {trigger}
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
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参数	触发器

响应头域

除公共头域外，无其它特殊头域。

响应参数

如果请求成功无响应参数。如果请求失败则返回标准错误结构。

请求示例

PUT /v1/instances/ccr-4k74gw7d/syncs/5 HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6

{
    "name": "bd2gz7",
    "description": "保定向广州同步镜像2",
    "syncType": "image",
    "srcProjectName": "ns-test",
    "srcRepositoryName": "**",
    "srcTagName": "**",
    "destInstanceId": "ccr-gz",
    "destProjectName": "ns-test-gz",
    "trigger": {
        "type": "event_based"
    },
    "override": false
}

响应示例

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: b7fcf872-51d2-459d-96e9-e47ee3ae4d74

删除实例同步规则

接口描述

删除实例同步规则。

请求结构

DELETE /v1/instances/{instanceId}/syncs/{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/syncs/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: b0313b16-3a75-4a4b-aa89-26d63bdd0f15

查询实例同步执行记录

接口描述

查询实例同步执行记录。

请求结构

GET /v1/instances/{instanceId}/executions?policyId={policyId}&pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: 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>	执行记录列表

请求示例

GET /v1/instances/ccr-4k74gw7d/executions?policyId=3&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

响应示例

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: b2840a4d-885b-4943-a7f6-a99aa160c327

{
    "total": 1,
    "pageNo": 1,
    "pageSize": 10,
    "items": [
        {
            "endTime": "2022-08-12T07:58:44.000Z",
            "failed": 0,
            "id": 14,
            "inProgress": 0,
            "policyId": 3,
            "startTime": "2022-08-12T07:58:22.503Z",
            "status": "Succeed",
            "statusText": "",
            "stopped": 0,
            "succeed": 2,
            "total": 2,
            "trigger": "manual"
        }
    ]
}

查询实例同步执行记录详情

接口描述

查询单个实例同步任务详细信息。

请求结构

GET /v1/instances/{instanceId}/executions/{executionId} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: 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	触发方式

请求示例

GET /v1/instances/ccr-4k74gw7d/executions/14 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, 01 Aug 2022 13:07:37 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: ddcbf3ac-7f21-497d-933c-76bab87f66df

{
    "endTime": "2022-08-12T07:58:44.000Z",
    "failed": 0,
    "id": 14,
    "inProgress": 0,
    "policyId": 3,
    "startTime": "2022-08-12T07:58:22.503Z",
    "status": "Succeed",
    "statusText": "",
    "stopped": 0,
    "succeed": 2,
    "total": 2,
    "trigger": "manual"
}

执行实例同步

接口描述

执行实例同步。

请求结构

POST /instances/{instanceId}/executions HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string

{
  	"policyId": {policyId}
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
instanceId	String	是	Path参数	CCR实例ID
policyId	Integer	是	Body参数	执行任务所属的规则ID

响应头域

除公共头域外，无其它特殊头域。

响应参数

如果请求成功无响应参数。如果请求失败则返回标准错误结构。

请求示例

POST /v1/instances/ccr-4k74gw7d/executions HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6

{
		"policyId": 1
}

响应示例

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: 9aa8d595-3ded-444f-91ed-1deaf1d909dd

停止实例同步

接口描述

停止实例同步。

请求结构

PUT /v1/instances/{instanceId}/executions/{executionId} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
instanceId	String	是	Path参数	CCR实例ID
executionId	String	是	Path参数	任务ID

响应头域

除公共头域外，无其它特殊头域。

响应参数

如果请求成功无响应参数。如果请求失败则返回标准错误结构。

请求示例

PUT /v1/instances/ccr-4k74gw7d/executions/12 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: text/plain; charset=utf-8
Date: Mon, 08 Aug 2022 06:48:43 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: d650950d-7d0d-420f-8af9-319166e6514c

查询实例同步执行任务记录

接口描述

查询实例同步执行(execution)的一次任务(task)的记录。

请求结构

GET /v1/instances/{instanceId}/executions/{executionId}/tasks?pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: 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>	任务执行结果列表

请求示例

GET /v1/instances/ccr-4k74gw7d/executions/6/tasks 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: 401c4614-622d-42fe-9c88-e106eb3ab08e

{
    "total": 1,
    "pageNo": 1,
    "pageSize": 10,
    "items": [
        {
            "destResource": "ns-test/prepare [1 item(s) in total]",
            "endTime": "2022-08-11T12:01:40.000Z",
            "executionId": 6,
            "id": 6,
            "jobId": "5f0453e61b33f2dba32209a9",
            "operation": "copy",
            "resourceType": "image",
            "srcResource": "my-public/prepare [1 item(s) in total]",
            "startTime": "2022-08-11T12:01:22.000Z",
            "status": "Succeed"
        }
    ]
}

查询实例同步执行任务日志

接口描述

查询实例同步执行任务日志。

请求结构

GET /v1/instances/{instanceId}/executions/{executionId}/tasks/{taskId}/log HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
instanceId	String	是	Path参数	CCR实例ID
executionId	String	是	Path参数	实例同步执行任务ID
taskId	String	是	Path参数	任务ID

响应头域

除公共头域外，无其它特殊头域。

响应参数

如果请求成功无响应参数。如果请求失败则返回标准错误结构。

请求示例

GET /v1/instances/ccr-4k74gw7d/executions/6/tasks/6/log 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, 01 Aug 2022 13:07:37 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: ddcbf3ac-7f21-497d-933c-76bab87f66df

镜像迁移接口

附录

百度智能云

容器镜像服务 CCR

容器镜像服务 CCR

镜像同步接口

使用前提

查询实例同步规则

查询实例同步规则详情

创建实例同步规则

更新实例同步规则

删除实例同步规则

查询实例同步执行记录

查询实例同步执行记录详情

执行实例同步

停止实例同步

查询实例同步执行任务记录

查询实例同步执行任务日志