Description
You can call this operation to query software packages managed by OCP. You can query software packages by keyword of their names, type, version, operating system, or architecture, or sort them by upload time.
Call description
Prerequisite
You have the PACKAGE_VIEWER permissions.
Request path
GET /api/v2/software-packages
Request parameters
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| keyword | String | No | agent | The keyword in the name of the software package. |
| type | StringArray | No | OB_SERVER_INSTALL_PACKAGE,OB_AGENT_INSTALL_PACKAGE | The type of the software package. You can specify multiple types. Valid values: * OB_SERVER_INSTALL_PACKAGE * OCP_AGENT_INSTALL_PACKAGE * OBPROXY_INSTALL_PACKAGE * OB_BACKUP_AGENT_INSTALL_PACKAGE |
| version | StringArray | No | 3.1.0,3.1.1 | The version of the software package. You can specify multiple versions. |
| operatingSystem | StringArray | No | alios,el7 | The operating system. You can specify multiple operating systems. |
| architecture | StringArray | No | x84_64,arm | The system architecture. You can specify multiple system architectures. |
| page | Integer | No | 1 | The number of the page to return. Pages start from page 1. Default value: 1. |
| size | Integer | No | 10 | The number of entries to return on each page. Maximum value: 2000. |
| sort | String | No | name,asc | The rule for sorting the requested data. |
Response parameters
Parameter |
Type |
Description |
|---|---|---|
| data | Object | The requested data. |
| ├─ contents | Array | The SoftwarePackageMeta array. For more information about the data structure, see the following table. |
| ├─ page | Object | The page information. |
| ├─ totalElements | Integer | The total number of entries. |
| ├─ totalPage | Integer | The total number of pages. |
| ├─ number | Integer | The page number of the returned page. |
| ├─ size | Integer | The number of entries returned per page. |
| successful | Boolean | Indicates whether the request was successful. |
| timestamp | Datetime | The timestamp when the server completed the request. |
| duration | Integer | The time taken by the server to process the request, in milliseconds. |
| status | Integer | An HTTP status code. |
| traceId | String | The trace ID of the request. This trace ID is used for troubleshooting. |
| server | String | The address of the application server that responded to the request. |
Data structure of SoftwarePackageMeta
Parameter |
Type |
Description |
|---|---|---|
| id | Integer | The ID of the software package. |
| name | String | The name of the software package. |
| fileName | String | The full file name of the software package. |
| extension | String | The file name extension of the software package. |
| size | Integer | The size of the software package, in bytes. |
| sha1 | String | The SHA1 value of the software package. |
| downloadUrl | String | The download URL of the software package. |
| type | String | The type of the software package. * OB_SERVER_INSTALL_PACKAGE * OCP_AGENT_INSTALL_PACKAGE * OBPROXY_INSTALL_PACKAGE * OB_BACKUP_AGENT_INSTALL_PACKAGE |
| version | String | The version of the software package. |
| buildNumber | String | The build number of the software package. |
| operatingSystem | String | The operating system supported by the software package. |
| architecture | String | The system architecture of the software package. |
| deletable | Boolean | Indicates whether the software package can be deleted. |
Examples
Sample request
GET /api/v2/software-packages?page=1&size=10&type=OCP_AGENT_INSTALL_PACKAGE
Sample response
{
"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"
}