镜像迁移接口
所有文档
menu

容器镜像服务 CCR

镜像迁移接口

产品详情

使用前提

查询镜像迁移规则

接口描述

查询镜像迁移规则。

请求结构

GET /v1/instances/{instanceId}/replications?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.PolicyResult> 镜像迁移规则对象列表

请求示例

GET /v1/instances/ccr-4k74gw7d/replications 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: 228e31d4-f8fa-46d6-be36-e4fec9f10aed

{
    "total": 1,
    "pageNo": 1,
    "pageSize": 10,
    "items": [
        {
            "creationTime": "2022-08-11T12:01:12.108Z",
            "deletion": false,
            "description": "",
            "destProjectName": "ns-test",
            "destRegistry": {
                "creationTime": "0001-01-01T00:00:00.000Z",
                "credential": {
                    "accessKey": "",
                    "accessSecret": "*****",
                    "type": "secret"
                },
                "description": "",
                "id": 0,
                "insecure": true,
                "name": "Local",
                "status": "healthy",
                "type": "harbor",
                "updateTime": "0001-01-01T00:00:00.000Z",
                "url": "http://ccr-test-harbor-core:80",
                "region": ""
            },
            "enabled": true,
            "filters": [
                {
                    "type": "name",
                    "value": "my-public/prepare"
                },
                {
                    "type": "tag",
                    "value": "1.0"
                }
            ],
            "id": 1,
            "name": "migrate1",
            "override": false,
            "srcRegistry": {
                "creationTime": "2022-08-11T12:00:08.397Z",
                "credential": {
                    "accessKey": "100e5554da9b46e589b4c71dcc0d858f",
                    "accessSecret": "*****",
                    "type": "basic"
                },
                "description": "",
                "id": 1,
                "insecure": false,
                "name": "Local",
                "status": "healthy",
                "type": "harbor",
                "updateTime": "2022-08-11T12:00:08.397Z",
                "url": "https://registry.baidubce.com",
                "region": "com"
            },
            "trigger": {
                "triggerSettings": null,
                "type": "manual"
            },
            "updateTime": "2022-08-12T08:19:52.212Z",
            "executionTimes": 3
        }
    ]
}

查询镜像迁移规则详情

接口描述

查询单个迁移规则详细信息。

请求结构

GET /v1/instances/{instanceId}/replications/{policyId} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: 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 镜像迁移规则更新时间

请求示例

GET /v1/instances/ccr-4k74gw7d/replications/6 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: d8bb93db-9e4e-436e-b67c-91847b161c43

{
    "creationTime": "2022-08-12T08:22:16.866Z",
    "deletion": false,
    "description": "string",
    "destProjectName": "ns-test",
    "destRegistry": {
        "creationTime": "0001-01-01T00:00:00.000Z",
        "credential": {
            "accessKey": "",
            "accessSecret": "*****",
            "type": "secret"
        },
        "description": "",
        "id": 0,
        "insecure": true,
        "name": "Local",
        "status": "healthy",
        "type": "harbor",
        "updateTime": "0001-01-01T00:00:00.000Z",
        "url": "http://ccr-test-harbor-core:80",
        "region": ""
    },
    "enabled": true,
    "filters": [
        {
            "type": "name",
            "value": "my-public/prepare"
        }
    ],
    "id": 6,
    "name": "migrate2",
    "override": true,
    "srcRegistry": {
        "creationTime": "2022-08-11T12:00:08.397Z",
        "credential": {
            "accessKey": "100e5554da9b46e589b4c71dcc0d858f",
            "accessSecret": "*****",
            "type": "basic"
        },
        "description": "",
        "id": 1,
        "insecure": false,
        "name": "Local",
        "status": "healthy",
        "type": "harbor",
        "updateTime": "2022-08-11T12:00:08.397Z",
        "url": "https://registry.baidubce.com",
        "region": "com"
    },
    "trigger": {
        "triggerSettings": null,
        "type": "manual"
    },
    "updateTime": "2022-08-12T08:22:16.866Z",
    "executionTimes": 0
}

创建镜像迁移规则

接口描述

创建镜像迁移规则。

请求结构

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

{
  	"description": {description},
  	"destProjectName": {destProjectName},
  	"filters": {filters}
  	"name": {name},
  	"override": {override},
  	"srcRegistry": {srcRegistry},
  	"trigger": {trigger}
}

请求头域

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

请求参数

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

响应头域

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

响应参数

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

请求示例

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

{
    "description": "description",
    "destProjectName": "ns-test",
    "filters": [
        {
            "type": "name",
            "value": "my-public/prepare"
        }
    ],
    "name": "migrate2",
    "override": true,
    "srcRegistry": {
        "id": 1
    },
    "trigger": {
        "type": "manual"
    }
}

响应示例

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}/replications/{policyId} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string

{
  	"description": {description},
  	"destProjectName": {destProjectName},
  	"filters": {filters}
  	"name": {name},
  	"override": {override},
  	"srcRegistry": {srcRegistry},
  	"trigger": {trigger}
}

请求头域

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

请求参数

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

响应头域

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

响应参数

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

请求示例

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

{
      "description": "测试",
      "destProjectName": "ns-test",
      "filters": [
        {
          "type": "name",
          "value": "my-public/prepare"
        }
      ],
      "name": "migrate3",
      "override": true,
      "srcRegistry": {
        "id": 1
      },
      "trigger": {
        "type": "manual"
      }
}

响应示例

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}/replications/{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/replications/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 执行记录总数
pageNo 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
上一篇
镜像访问控制接口
下一篇
镜像同步接口