Skip to content

Latest commit

 

History

History
621 lines (564 loc) · 17.2 KB

package.md

File metadata and controls

621 lines (564 loc) · 17.2 KB
Raw

Package制品包版本接口

[toc]

分页查询包列表

  • API: GET /repository/api/package/page/{projectId}/{repoName}?packageName=xxx&pageNumber=0&pageSize=20

  • API 名称: list_package_page

  • 功能说明：

    • 中文：分页查询包列表
    • English：list package page

  • 请求体 此接口请求体为空

  • 请求字段说明

    字段 类型 是否必须 默认值 说明 Description
    projectId string 是 无 项目名称 project name
    repoName string 是 无 仓库名称 repo name
    packageName string 否 无 包名称，支持前缀匹配模糊搜索 package name
    pageNumber Int 是 无 页码 page number
    pageSize Int 是 无 每页数量 page size

  • 响应体

    {
  "code": 0,
  "message": null,
  "data": {
    "pageNumber": 0,
    "pageSize": 1,
    "totalRecords": 18,
    "totalPages": 18,
    "records": [
      {
        "projectId" : "test",
        "repoName" : "generic-local",
        "name" : "test",
        "key" : "com.tencent.bkrepo",
        "type" : "MAVEN",
        "latest" : "0.0.9",
        "downloads" : 101,
        "versions" : 9,
        "description": null,
        "createdBy" : "admin",
        "createdDate" : "2020-07-27T16:02:31.394",
        "lastModifiedBy" : "admin",
        "lastModifiedDate" : "2020-07-27T16:02:31.394",
        "extension" : {
            "appVersion": "4.2.4"
        },
        "historyVersion" : [
            "7.8.10"
        ]
      }
    ]
  },
  "traceId":  null
}

  • records字段说明

    字段 类型 说明 Description
    projectId string 节点所属项目 project id
    repoName string 节点所属仓库 repository name
    name string 包名称 package name
    key string 包唯一key package unique key
    type string 包类别 package type
    latest string 最新上传版本名称 latest version name
    downloads Long 下载次数 download times
    versions Long 版本数量 version count
    description string 简要描述 brief description
    createdBy string 创建者 create user
    createdDate string 创建时间 create time
    lastModifiedBy string 上次修改者 last modify user
    extension object 扩展信息，key-value键值对 extension
    historyVersion list[string] 历史版本 history version

  • extension字段说明

    字段 类型 说明 Description
    appVersion string 软件版本 app version

查询包信息

  • API: GET /repository/api/package/info/{projectId}/{repoName}?packageKey=docker://nginx

  • API 名称: get_package_info

  • 功能说明：

    • 中文：查询包信息
    • English：get package info

  • 请求体 此接口请求体为空

  • 请求字段说明

    字段 类型 是否必须 默认值 说明 Description
    projectId string 是 无 项目名称 project name
    repoName string 是 无 仓库名称 repo name
    packageKey string 是 无 包唯一key package unique key

  • 响应体

    {
  "code": 0,
  "message": null,
  "data": {
    {
      "projectId" : "test",
      "repoName" : "generic-local",
      "name" : "test",
      "key" : "com.tencent.bkrepo",
      "type" : "MAVEN",
      "latest" : "0.0.9",
      "downloads" : 101,
      "versions": 9,
      "description": null,
      "createdBy" : "admin",
      "createdDate" : "2020-07-27T16:02:31.394",
      "lastModifiedBy" : "admin",
      "lastModifiedDate" : "2020-07-27T16:02:31.394",
      "extension" : {
          "appVersion": "4.2.4"
      },
      "historyVersion" : [
          "7.8.10"
      ]
    }
  },
  "traceId":  null
}

  • record字段说明

    字段 类型 说明 Description
    projectId string 节点所属项目 project id
    repoName string 节点所属仓库 repository name
    name string 包名称 package name
    key string 包唯一key package unique key
    type string 包类别 package type
    latest string 最新上传版本名称 latest version name
    downloads Long 下载次数 download times
    versions Long 版本数量 version count
    description string 简要描述 brief description
    createdBy string 创建者 create user
    createdDate string 创建时间 create time
    lastModifiedBy string 上次修改者 last modify user
    lastModifiedDate string 上次修改时间 last modify time
    extension object 扩展信息，key-value键值对 extension
    historyVersion list[string] 历史版本 history version

  • extension字段说明

    字段 类型 说明 Description
    appVersion string 软件版本 app version

删除包

  • API: DELETE /repository/api/package/delete/{projectId}/{repoName}?packageKey=gav://com.tencent:test

  • API 名称: delete_package

  • 功能说明：

    • 中文：删除包
    • English：delete package

  • 请求体 此接口请求体为空

  • 请求字段说明

    字段 类型 是否必须 默认值 说明 Description
    projectId string 是 无 项目名称 project name
    repoName string 是 无 仓库名称 repo name
    packageKey string 是 无 包唯一key package unique key

  • 响应体

    {
  "code": 0,
  "message": null,
  "data": null,
  "traceId":  null
}

分页查询包版本

  • API: GET /repository/api/version/page/{projectId}/{repoName}?packageKey=gav://com.tencent:test&version=0.0.1&stageTag=release&pageNumber=0&pageSize=20&sortProperty=lastModifiedDate&direction=DESC

  • API 名称: list_version_page

  • 功能说明：

    • 中文：分页查询版本列表
    • English：list version page

  • 请求体 此接口请求体为空

  • 请求字段说明

    字段 类型 是否必须 默认值 说明 Description
    projectId string 是 无 项目名称 project name
    repoName string 是 无 仓库名称 repo name
    packageKey string 否 无 包唯一key package unique key
    version string 否 无 版本名称，前缀匹配 version name
    stageTag string 否 无 晋级标签， 逗号分隔 stage tag list
    pageNumber Int 是 无 页码 page number
    pageSize Int 是 无 每页数量 page size
    sortProperty string 否 无 排序字段 sort property
    direction string 否 DESC 排序方向(ASC、DESC) sort direction

  • 响应体

    {
  "code": 0,
  "message": null,
  "data": {
    "pageNumber": 0,
    "pageSize": 1,
    "totalRecords": 18,
    "totalPages": 18,
    "records": [
      {
        "name" : "0.0.9",
        "size" : 1024,
        "downloads" : 18,
        "stageTag" : ["@prerelease", "@release"],
        "createdBy" : "admin",
        "createdDate" : "2020-07-27T16:02:31.394",
        "lastModifiedBy" : "admin",
        "lastModifiedDate" : "2020-07-27T16:02:31.394",
        "metadata": {
          "apiVersion": "v1",
          "appVersion": "7.0",
          "description": "Deploy a basic tomcat application server with sidecar as web archive container",
          "home": "https://github.com/yahavb",
          "icon": "http://tomcat.apache.org/res/images/tomcat.png",
          "keywords": [],
          "maintainers": [
              {
                  "name": "yahavb",
                  "email": "[email protected]"
              }
          ],
          "name": "tomcat",
          "sources": [],
          "urls": [],
          "version": "0.4.2"
        },
        "nodeMetadata": [
           {
             "key": "apiVersion",
             "value": "v1",
             "description": "",
             "system": false
           },
           {
             "key": "appVersion",
             "value": "7.0",
             "description": "",
             "system": false
           },
           {
             "key": "description",
             "value": "Deploy a basic tomcat application server with sidecar as web archive container",
             "description": "",
             "system": false
           },
           {
             "key": "home",
             "value": "https://github.com/yahavb",
             "description": "",
             "system": false
           },
           {
             "key": "icon",
             "value": "http://tomcat.apache.org/res/images/tomcat.png",
             "description": "",
             "system": false
           },
           {
             "key": "keywords",
             "value": [],
             "description": "",
             "system": false
           },
           {
             "key": "maintainers",
             "value": [
                {
                  "name": "yahavb",
                  "email": "[email protected]"
                }
             ],
             "description": "",
             "system": false
           },
           {
             "key": "name",
             "value": "tomcat",
             "description": "",
             "system": false
           },
           {
             "key": "sources",
             "value": [],
             "description": "",
             "system": false
           },
           {
             "key": "urls",
             "value": [],
             "description": "",
             "system": false
           },
           {
             "key": "version",
             "value": "0.4.2",
             "description": "",
             "system": false
           }
        ]
      }
    ]
  },
  "traceId":  null
}

  • records字段说明

    字段 类型 说明 Description
    name string 版本名称 version name
    size long 版本大小 version size
    downloads long 版本下载次数 download times
    stageTag list[string] 晋级阶段标签列表 stage tag list
    metadata object 元数据，key-value键值对 metadata
    nodeMetadata object 元数据，key-value键值对 metadata
    createdBy string 创建者 create user
    createdDate string 创建时间 create time
    lastModifiedBy string 上次修改者 last modify user
    lastModifiedDate string 上次修改时间 last modify time

查询包版本

  • API: POST /repository/api/version/list/{projectId}/{repoName}?packageKey=gav://com.tencent:test
  • API 名称: list_version
  • 功能说明：
    • 中文：查询版本列表
    • English：list version
  • 请求体
  {
    "pageNumber": 1,
    "pageSize": 20,
    "version": "1.0.0",
    "stageTag": "release",
    "metadata": [
      {
        "key": "apiVersion",
        "value": "v1"
      }
    ],
    "sortProperty": "lastModifiedDate",
    "direction": "DESC"
  }

  • 请求字段说明

    字段 类型 是否必须 默认值 说明 Description
    projectId string 是 无 项目名称 project name
    repoName string 是 无 仓库名称 repo name
    packageKey string 否 无 包唯一key package unique key
    version string 否 无 版本名称，前缀匹配 version name
    stageTag string 否 无 晋级标签， 逗号分隔 stage tag list
    metadata List 否 无 版本元数据 package version metadata
    pageNumber Int 是 无 页码 page number
    pageSize Int 是 无 每页数量 page size
    sortProperty string 否 无 排序字段 sort property
    direction string 否 DESC 排序方向(ASC、DESC) sort direction

  • 响应体

    {
  "code": 0,
  "message": null,
  "data": {
    "name" : "0.0.9",
    "size" : 1024,
    "downloads" : 18,
    "stageTag" : ["@prerelease", "@release"],
    "createdBy" : "admin",
    "createdDate" : "2020-07-27T16:02:31.394",
    "lastModifiedBy" : "admin",
    "lastModifiedDate" : "2020-07-27T16:02:31.394",
    "metadata": {
      "apiVersion": "v1",
      "appVersion": "7.0",
      "description": "Deploy a basic tomcat application server with sidecar as web archive container",
      "home": "https://github.com/yahavb",
      "icon": "http://tomcat.apache.org/res/images/tomcat.png",
      "keywords": [],
      "maintainers": [
          {
              "name": "yahavb",
              "email": "[email protected]"
          }
      ],
      "name": "tomcat",
      "sources": [],
      "urls": [],
      "version": "0.4.2"
    },
    "nodeMetadata": [
        {
          "key": "apiVersion",
          "value": "v1",
          "description": "",
          "system": false
        },
        {
          "key": "appVersion",
          "value": "7.0",
          "description": "",
          "system": false
        },
        {
          "key": "description",
          "value": "Deploy a basic tomcat application server with sidecar as web archive container",
          "description": "",
          "system": false
        },
        {
          "key": "home",
          "value": "https://github.com/yahavb",
          "description": "",
          "system": false
        },
        {
          "key": "icon",
          "value": "http://tomcat.apache.org/res/images/tomcat.png",
          "description": "",
          "system": false
        },
        {
          "key": "keywords",
          "value": [],
          "description": "",
          "system": false
        },
        {
          "key": "maintainers",
          "value": [
            {
              "name": "yahavb",
              "email": "[email protected]"
            }
          ],
          "description": "",
          "system": false
        },
        {
          "key": "name",
          "value": "tomcat",
          "description": "",
          "system": false
        },
        {
          "key": "sources",
          "value": [],
          "description": "",
          "system": false
        },
        {
          "key": "urls",
          "value": [],
          "description": "",
          "system": false
        },
        {
          "key": "version",
          "value": "0.4.2",
          "description": "",
          "system": false
        }
    ]
  },
  "traceId":  null
}

删除版本

  • API: DELETE /repository/api/version/delete/{projectId}/{repoName}?packageKey=npm://test&version=0.0.1

  • API 名称: delete_version

  • 功能说明：

    • 中文：删除版本
    • English：delete version

  • 请求体 此接口请求体为空

  • 请求字段说明

    字段 类型 是否必须 默认值 说明 Description
    projectId string 是 无 项目名称 project name
    repoName string 是 无 仓库名称 repo name
    packageKey string 是 无 包唯一key package unique key
    version string 是 无 版本名称 version name

  • 响应体

    {
  "code": 0,
  "message": null,
  "data": null,
  "traceId":  null
}

自定义搜索包

  • API: POST /repository/api/package/search

  • API 名称: package search

  • 功能说明：

    • 中文：节点自定义搜索。最外层的查询条件中必须包含projectId条件，可以传入repoType指定仓库类型或者repoName指定仓库查询。
    • English：search package

  • 请求体 参考自定义搜索接口公共说明

     查询在项目test下, 仓库类型为MAVEN，包名为spring开头的包，并按照包名排序，查询结果包含name、key、latest、donwloads、versions字段
{
  "select": ["name", "key", "latest", "downloads", "versions"],
  "page": {
    "pageNumber": 1,
    "pageSize": 20
  },
  "sort": {
    "properties": ["name"],
    "direction": "ASC"
  },
  "rule": {
    "rules": [
      {
        "field": "projectId",
        "value": "test",
        "operation": "EQ"
      },
      {
        "field": "repoType",
        "value": "MAVEN",
        "operation": "EQ"
      },
      {
        "field": "name",
        "value": "spring",
        "operation": "PREFIX"
      }
    ],
    "relation": "AND"
  }
}

下载版本

  • API: GET /repository/api/version/download/{projectId}/{repoName}?packageKey=npm://test&version=0.0.1

  • API 名称: download_version

  • 功能说明：

    • 中文：下载版本
    • English：download version

  • 请求体 此接口请求体为空

  • 请求字段说明

    字段 类型 是否必须 默认值 说明 Description
    projectId string 是 无 项目名称 project name
    repoName string 是 无 仓库名称 repo name
    packageKey string 是 无 包唯一key package unique key
    version string 是 无 版本名称 version name

  • 响应体 [文件流]

公共说明

包类型枚举

用于标识构件包类型

枚举值 说明
DOCKER Docker包
MAVEN Maven包
PYPI Pypi包
NPM Npm包
HELM Helm包
COMPOSER Composer包
RPM Rpm包

package key 格式

因为同个仓库下包名称不唯一， 所以使用package key来确定包的唯一性。 pakcage key的格式为: {type}://{value}

type类型 value格式 例子
gav (maven采用此格式) groupId:artifactId gav://com.tencent.bkrepo:test
docker name(包名称，docker中名称唯一) docker://test
npm name npm://test