容器引擎CCE

    Image相关接口

    创建镜像仓库用户

    描述

    创建镜像仓库用户

    请求结构

    POST /v1/image/user HTTP/1.1
    Host: cce.bj.baidubce.com
    Authorization: authorization string

    请求头域

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

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    username String RequestBody参数 用户名字
    password String RequestBody参数 用户密码
    passwordConfirmation String RequestBody参数 重复密码

    返回头域

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

    返回参数

    无返回值

    请求示例

    POST /v1/image/user  HTTP/1.1
    Host: cce.bj.baidubce.com
    ContentType: application/json
    Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
    {
        "username": "ccetest",
        "password": "passwd@123",
        "passwordConfirmation": "passwd@123"
    }

    返回示例

    HTTP/1.1 200 OK     
    x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
    Date: Thu, 16 Mar 2019 06:29:48 GMT    
    Content Type: application/json;charset=UTF-8     
    Server: BWS

    获取镜像仓库用户

    描述

    获取镜像仓库用户

    请求结构

    GET /v1/image/user   HTTP/1.1   
    Host: cce.bj.baidubce.com      
    Authorization: authorization string

    请求头域

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

    请求参数

    无请求参数

    返回头域

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

    返回参数

    参数名称 类型 描述
    username String 镜像仓库用户名
    createTime Timestamp 镜像仓库用户创建时间
    updateTime TImestamp 镜像仓库用户更新时间

    请求示例

    GET /v1/image/user HTTP/1.1   
    Host: cce.bj.baidubce.com     
    ContentType: application/json     
    Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2019 03 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

    返回示例

    HTTP/1.1 200 OK     
    x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
    Date: Thu, 16 Mar 2019 06:29:48 GMT    
    Content Type: application/json;charset=UTF-8     
    Server: BWS        
    {
        "username": "ccetest",
        "createTime": "2019-07-13T06:04:16Z",
        "updateTime": "2019-07-21T03:55:46Z"
    }

    更新镜像仓库用户密码

    描述

    更新镜像仓库用户密码

    请求结构

    PUT /v1/image/user   HTTP/1.1   
    Host: cce.bj.baidubce.com      
    Authorization: authorization string

    请求头域

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

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    username String RequestBody参数 用户名字 (4-30个英文小写字母与数字组成)
    password String RequestBody参数 用户密码
    passwordConfirmation String RequestBody参数 重复密码 (密码要求8位以上,必须包含数字、字母及!@#$%^*()符号)

    返回头域

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

    返回参数

    请求示例

    PUT /v1/image/user  HTTP/1.1
    Host: cce.bj.baidubce.com
    ContentType: application/json
    Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
    {
        "username": "ccetest",
        "password": "passwd@123",
        "passwordConfirmation": "passwd@1123"
    }

    返回示例

    HTTP/1.1 200 OK     
    x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
    Date: Thu, 16 Mar 2019 06:29:48 GMT    
    Content Type: application/json;charset=UTF-8     
    Server: BWS

    创建命名空间

    描述

    创建命名空间

    请求结构

    POST /v1/image/namespace   HTTP/1.1   
    Host: cce.bj.baidubce.com      
    Authorization: authorization string

    请求头域

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

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    username String RequestBody参数 用户名字 (4-30个英文小写字母与数字组成)
    namespace String RequestBody参数 镜像所属域
    isPublic boolean RequestBody参数 是否为公有命名空间
    notificationUrl String RequestBody参数 镜像回调地址URL

    返回头域

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

    返回参数

    无返回值

    请求示例

    POST /v1/image/namespace  HTTP/1.1
    Host: cce.bj.baidubce.com
    ContentType: application/json
    Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
    {
        "username": "ccetest",
        "namespace": "namespace-bj",
        "isPublic": "false"
    }

    返回示例

    HTTP/1.1 200 OK     
    x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
    Date: Thu, 16 Mar 2019 06:29:48 GMT    
    Content Type: application/json;charset=UTF-8     
    Server: BWS

    根据用户名获取命名空间列表

    描述

    根据用户名获取命名空间列表

    请求结构

    GET /v1/image/namespace?user={user}   HTTP/1.1   
    Host: cce.bj.baidubce.com      
    Authorization: authorization string

    请求头域

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

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    marker String Query参数 namespace name值 标志分页开始点
    maxKeys String Query参数 一页条目数量 默认1000
    user String Query参数 镜像仓库用户名

    返回头域

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

    返回参数

    参数名称 类型 描述
    marker String 标记查询的起始位置
    isTruncated boolean true表示后面还有数据,false表示已经是最后一页
    nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现
    maxKeys Integer 每页包含的最大数量
    namespaces List<Namespace> namespace列表结果,其中Namespace说明见附录

    请求示例

    GET /v1/image/namespace?user=ccetest {'user': 'ccetest'} HTTP/1.1
    Host: cce.bj.baidubce.com
    ContentType: application/json
    Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

    返回示例

    HTTP/1.1 200 OK     
    x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
    Date: Thu, 16 Mar 2019 06:29:48 GMT    
    Content Type: application/json;charset=UTF-8     
    Server: BWS 
    {
        "marker": "",
        "isTruncated": false,
        "nextMarker": null,
        "maxKeys": 1000,
        "namespaces": [
            {
                "name": "test_ns",
                "createTime": "2019-07-24T15:11:00Z",
                "repositoryNum": 0,
                "isPublic": false,
                "notificationUrl": null
            }
        ]
    }

    检查一个命名空间是否存在

    描述

    检查一个命名空间是否存在

    请求结构

    GET  /v1/image/namespace/{namespace}   HTTP/1.1   
    Host: cce.bj.baidubce.com      
    Authorization: authorization string

    请求头域

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

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    namespace String URL参数 命名空间

    返回头域

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

    返回参数

    参数名称 类型 描述
    namespace String 命名空间
    isPublic String 是否公共
    user String 用户名

    无返回值

    请求示例

    GET /v1/image/namespace/namespace-bj HTTP/1.1   
    Host: cce.bj.baidubce.com     
    ContentType: application/json     
    Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2019 03 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

    返回示例

    HTTP/1.1 200 OK     
    x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
    Date: Thu, 16 Mar 2019 06:29:48 GMT    
    Content Type: application/json;charset=UTF-8     
    Server: BWS      
    {
        "namespace": "namespace-bj",
        "isPublic": "false",
        "user": "ccetest"
    }

    删除一个命名空间

    描述

    删除一个命名空间

    请求结构

    DELETE /v1/image/namespace/{namespace}   HTTP/1.1   
    Host: cce.bj.baidubce.com      
    Authorization: authorization string

    请求头域

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

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    namespace String URL参数 命名空间

    返回头域

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

    返回参数

    无返回值

    请求示例

    DELETE /v1/image/namespace/namespace-bj HTTP/1.1   
    Host: cce.bj.baidubce.com     
    ContentType: application/json     
    Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2019 03 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

    返回示例

    HTTP/1.1 200 OK     
    x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
    Date: Thu, 16 Mar 2019 06:29:48 GMT    
    Content Type: application/json;charset=UTF-8     
    Server: BWS

    根据用户名获取镜像列表

    描述

    根据用户名获取镜像列表

    请求结构

    GET  /v1/image?user={user}   HTTP/1.1   
    Host: cce.bj.baidubce.com      
    Authorization: authorization string

    请求头域

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

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    marker String Query参数 标志分页开始点
    maxKeys Integer Query参数 一页条目数量,默认1000
    user String Query参数 镜像仓库用户名

    返回头域

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

    返回参数

    参数名称 类型 描述
    marker String 标记查询的起始位置
    isTruncated boolean true表示后面还有数据,false表示已经是最后一页
    nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现
    maxKeys Integer 每页包含的最大数量
    images List<Image> image具体信息,其中Image说明见附录

    请求示例

    GET /v1/image?user=ccetest  HTTP/1.1
    Host: cce.bj.baidubce.com
    ContentType: application/json
    Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

    返回示例

    HTTP/1.1 200 OK     
    x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
    Date: Thu, 16 Mar 2019 06:29:48 GMT    
    Content Type: application/json;charset=UTF-8     
    Server: BWS 
    {
        "marker": "",
        "isTruncated": false,
        "nextMarker": null,
        "maxKeys": 1000,
        "images": [
            {
                "imageMeta": {
                    "namespace": "jpaas-public",
                    "repository": "alertmanager",
                    "tag": "v0.14.0-backup",
                    "description": "jpaas-public/alertmanager"
                },
                "createTime": "2019-05-13T15:56:53Z",
                "address": "hub.baidubce.com/jpaas-public/alertmanager:v0.14.0-backup",
                "isPublic": true
            }
        ]
    }

    新增一个镜像元数据

    描述

    新增一个镜像元数据

    请求结构

    POST /v1/image/meta   HTTP/1.1   
    Host: cce.bj.baidubce.com      
    Authorization: authorization string

    请求头域

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

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    imageMetaRequest ImageMeta RequestBody参数 新增镜像元数据

    返回头域

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

    返回参数

    无返回值

    请求示例

    POST /v1/image/meta HTTP/1.1   
    Host: cce.bj.baidubce.com     
    ContentType: application/json     
    Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2019 03 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de        
    {
        "imageMeta": {
            "namespace": "production-nn",
            "repository": "test_image",
            "tag": "1.0.2",
            "description": "description of image"
        }
    }

    返回示例

    HTTP/1.1 200 OK     
    x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
    Date: Thu, 16 Mar 2019 06:29:48 GMT    
    Content Type: application/json;charset=UTF-8     
    Server: BWS

    删除一个镜像元数据

    描述

    删除一个镜像元数据

    请求结构

    DELETE /v1/image/meta   HTTP/1.1   
    Host: cce.bj.baidubce.com      
    Authorization: authorization string

    请求头域

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

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    namespace String RequestBody参数 命名空间
    repository String RequestBody参数 所属仓库
    tag String RequestBody参数 标签tag

    返回头域

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

    返回参数

    无返回值

    请求示例

    DELETE /v1/image/meta HTTP/1.1   
    Host: cce.bj.baidubce.com     
    ContentType: application/json     
    Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2019 03 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de        
    {
        "namespace": "production-nn",
        "repository": "test_imagessss",
        "tag": "1.0.2"
    }

    返回示例

    HTTP/1.1 200 OK     
    x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
    Date: Thu, 16 Mar 2019 06:29:48 GMT    
    Content Type: application/json;charset=UTF-8     
    Server: BWS

    检查一个镜像元数据是否存在

    描述

    检查一个镜像元数据是否存在

    请求结构

    GET /v1/image/meta   HTTP/1.1   
    Host: cce.bj.baidubce.com      
    Authorization: authorization string

    请求头域

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

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    namespace String RequestBody参数 命名空间
    repository String RequestBody参数 所属仓库
    tag String RequestBody参数 标签tag

    返回头域

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

    返回参数

    参数名称 类型 描述
    namespace String 命名空间
    repository String 所属仓库
    tag String 标签tag
    user String 用户

    无返回值

    请求示例

    GET /v1/image/meta HTTP/1.1   
    Host: cce.bj.baidubce.com     
    ContentType: application/json     
    Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2019 03 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de        
    {
        "namespace": "production-nn",
        "repository": "test_imagessss",
        "tag": "1.0.2"
    }

    返回示例

    HTTP/1.1 200 OK     
    x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
    Date: Thu, 16 Mar 2019 06:29:48 GMT    
    Content Type: application/json;charset=UTF-8     
    Server: BWS      
    {
        "namespace": "namespace-bj",
        "repository": "repo-bj",
        "tag": "1.0.2",
        "user": "ccetest"
    }

    查询指定镜像image所有版本

    描述

    查询一个有权限镜像的所有版本列表

    请求结构

     GET /v1/image/tags   HTTP/1.1   
      Host: cce.bj.baidubce.com      
      Authorization: authorization string

    请求头域

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

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    namespace String Query参数 命名空间
    repository String Query参数 所属仓库

    返回头域

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

    返回参数

    参数名称 类型 描述
    namespace String 命名空间
    repository String 所属仓库
    tags List<ImageDetails> 镜像标签tag列表,其中ImageDetails说明见附录

    请求示例

      GET /v1/image/tags HTTP/1.1   
       Host: cce.bj.baidubce.com     
       ContentType: application/json     
       Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2019 03 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de        

    返回示例

    HTTP/1.1 200 OK     
    x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
    Date: Thu, 16 Mar 2019 06:29:48 GMT    
    Content Type: application/json;charset=UTF-8     
    Server: BWS
    
    {
        "namespace": "baidu-public",
        "repository": "nginx",
        "tags": [
            {
                "name": "stable",
                "digest": "sha256:3fda617a14130bef80244f97ebe174dcf4ef575fa55afeec8e17145add594908",
                "description": "baidu-public/nginx",
                "created_at": "2018-12-12T12:06:16.000+08:00",
                "updated_at": "2018-12-12T12:06:16.000+08:00"
            }
        ]
    }
    上一篇
    Cluster相关接口
    下一篇
    附录