---
title: "查询软件包列表 - 云平台 OCP V4.2.1 | OceanBase 文档中心"
description: 查询软件包列表 功能说明 查询 OCP 所管理的软件包信息。可以通过软件包名称关键字、类型、版本、操作系统、架构信息过滤软件包列表，也可以通过上传时间针对列表进行排序。 调用说明 接口约束 调用者需要具备 PACKAGE_VIEWER 权限。 请求路径 GET /api/v2/software-packages 请求…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*lJTmRZ61jSUAAAAAAAAAAAAADiGDAQ/original) 云平台 OCPV 4.2.1

# 查询软件包列表

更新时间：2025-08-04 14:35:46

[编辑](https://github.com/oceanbase/ocp-doc/edit/V4.2.1/zh-CN/1900.reference-guide/200.api-reference/700.software-package/100.query-the-list-of-software-packages.md)  

## 功能说明

查询 OCP 所管理的软件包信息。可以通过软件包名称关键字、类型、版本、操作系统、架构信息过滤软件包列表，也可以通过上传时间针对列表进行排序。

## 调用说明

### 接口约束

调用者需要具备 PACKAGE_VIEWER 权限。

### 请求路径

`GET /api/v2/software-packages`

### 请求参数

**body：**

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| keyword | String | 否 | agent | 软件包检索关键字，会根据此信息过滤软件包名称。 |
| type | StringArray | 否 | OB_SERVER_INSTALL_PACKAGE,OB_AGENT_INSTALL_PACKAGE | 软件包类型字段，支持多种类型过滤，取值范围： - OB_SERVER_INSTALL_PACKAGE：OceanBase 安装包 - OCP_AGENT_INSTALL_PACKAGE：OCP Agent 安装包 - OBPROXY_INSTALL_PACKAGE：OBProxy 安装包 - OB_BACKUP_AGENT_INSTALL_PACKAGE：备份恢复软件安装包 |
| version | StringArray | 否 | 3.1.0,3.1.1 | 软件包版本，支持多个版本过滤。 |
| operatingSystem | StringArray | 否 | alios,el7 | 操作系统类型，支持多种类型同时过滤。 |
| architecture | StringArray | 否 | x84_64,arm | 系统架构，支持多种架构同时过滤。 |
| page | Integer | 否 | 1 | 请求数据的分页页码。值从 1 开始，默认值：1。 |
| size | Integer | 否 | 10 | 请求数据的分页大小。默认值：10，最大值：2000。 |
| sort | String | 否 | name,asc | 请求数据的排序规则。 |

### 返回结果

**基础数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| data | Object | 请求的数据。 |
| ├─ contents | Array | SoftwarePackageMeta 的数组，详情参见 **SoftwarePackageMeta 数据结构**。 |
| ├─ page | Object | 分页信息。 |
| ├─ totalElements | Integer | 总记录数。 |
| ├─ totalPage | Integer | 总页数。 |
| ├─ number | Integer | 当前页码。 |
| ├─ size | Integer | 当前页大小。 |
| successful | Boolean | 请求是否成功。 |
| timestamp | Datetime | 服务端完成请求的时间戳。 |
| duration | Integer | 服务端处理请求的时间（毫秒）。 |
| status | Integer | 符合 HTTP Status 规范的编码。 |
| traceId | String | 请求的 Trace ID，用于排查问题。 |
| server | String | 响应请求的应用服务的地址、 |

**SoftwarePackageMeta 数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| id | Integer | 软件包 ID。 |
| name | String | 软件包名称。 |
| fileName | String | 软件包的文件全名。 |
| extension | String | 软件包扩展名。 |
| size | Integer | 软件包大小，单位字节。 |
| sha1 | String | 软件包的 SHA1。 |
| downloadUrl | String | 软件包下载地址。 |
| type | String | 软件包类型，取值范围：- `OB_SERVER_INSTALL_PACKAGE`：OceanBase 安装包。 - `OCP_AGENT_INSTALL_PACKAGE`：OCP Agent 安装包。 - `OBPROXY_INSTALL_PACKAGE`：OBProxy 安装包。 - `OB_BACKUP_AGENT_INSTALL_PACKAGE`：备份恢复安装包。 - `OTHERS_RPM`：其它安装包。 |
| version | String | 软件包版本。 |
| buildNumber | String | 软件包编译号。 |
| operatingSystem | String | 软件包支持的操作系统。 |
| architecture | String | 软件包架构。 |
| deletable | Boolean | 软件包是否可以删除 。 |

## 示例

### 请求示例

`GET /api/v2/software-packages?page=1&size=10&type=OCP_AGENT_INSTALL_PACKAGE`

### 返回示例

```javascript
{
  "data": {
    "contents": [
      {
        "architecture": "x86_64",
        "buildNumber": "1898294",
        "createTime": "2020-08-10T15:16:50+08:00",
        "deletable": true,
        "downloadUrl": "http://xxx.xxx.xxx.xxx:8080/api/v2/files/sys-package/t-oceanbase-ocp-agent-2.4.2-1898294.alios7.x86_64.rpm",
        "extension": "rpm",
        "fileName": "t-oceanbase-ocp-agent-2.4.2-1898294.alios7.x86_64.rpm",
        "id": 12,
        "installationDataList": [],
        "name": "t-oceanbase-ocp-agent",
        "operatingSystem": "alios7",
        "sha1": "e3277366579eac7ecf7a5b6313f2807229567a12",
        "size": 31017340,
        "type": "OCP_AGENT_INSTALL_PACKAGE",
        "version": "2.4.2"
      },
      {
        "architecture": "x86_64",
        "buildNumber": "1884049",
        "createTime": "2020-05-25T16:32:51+08:00",
        "deletable": true,
        "downloadUrl": "http://xxx.xxx.xxx.xxx:8080/api/v2/files/sys-package/t-oceanbase-ocp-agent-2.4.0-1884049.alios7.x86_64.rpm",
        "extension": "rpm",
        "fileName": "t-oceanbase-ocp-agent-2.4.0-1884049.alios7.x86_64.rpm",
        "id": 10,
        "installationDataList": [],
        "name": "t-oceanbase-ocp-agent",
        "operatingSystem": "alios7",
        "sha1": "4a6c96b46268121b32a0590729bf44ad9068b6b9",
        "size": 29867460,
        "type": "OCP_AGENT_INSTALL_PACKAGE",
        "version": "2.4.0"
      }
    ],
    "page": {
      "number": 1,
      "size": 10,
      "totalElements": 2,
      "totalPages": 1
    }
  },
  "duration": 9,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-08-24T21:15:45.533+08:00",
  "traceId": "b31aec4d58104ecd"
}

```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线