Overview
Call ListOpenApis to retrieve a paginated list of public API summaries. You can filter the results by category, keyword, and version.
API details
Constraints
This API requires authentication with an AccessKey ID and an AccessKey Secret. For information about obtaining these credentials, see Manage AccessKeys. For common request headers and authentication details, see Using API.
Request path
GET /api/v2/openapis
Request parameters
Query
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| requestId | String | Yes | Request ID. | d04eabba**** |
| category | String | No | API category, derived from the API's tags. Use a category value returned in the list. |
MultiCloudOpenAPI |
| keyword | String | No | Keyword for filtering results. | DescribeInstance |
| apiVersion | String | No | API version. Only v2 is currently supported. |
v2 |
| pageNumber | Integer | No | Page number. Must be a positive integer. Default: 1. | 1 |
| pageSize | Integer | No | Number of records per page. Must be a positive integer. Default: 10. Values greater than 300 are capped at 300, which is also used to calculate the pagination offset. | 10 |
Response parameters
Field |
Type |
Description |
Example value |
|---|---|---|---|
| success | Boolean | Whether the request succeeded. | true |
| errorCode | String | Error code. | InvalidParameter |
| errorMessage | String | Error message. | Invalid parameter |
| data | Object | Response data. | — |
| cost | Number | Time taken to process the request. | 1.0 |
| server | String | Server address. | 10.0.0.10 |
| requestId | String | Request ID. | d04eabba**** |
| extra | Object | Additional information. | {} |
data object fields
Field |
Type |
Description |
Example value |
|---|---|---|---|
| total | Integer | Total number of records that match the filters. | 16 |
| items | Array | List of API summaries on the current page. | — |
data.items[] object fields
Field |
Type |
Description |
Example value |
|---|---|---|---|
| apiKey | String | API name. Matches operationId in the API definition. |
DescribeInstance |
| apiVersion | String | API version, currently v2. |
v2 |
| category | String | API category, derived from the API's tags. |
MultiCloudOpenAPI |
| summary | String | API summary. | DescribeInstance |
| method | String | HTTP method. | GET |
| deprecated | Boolean | Whether the API is deprecated. | false |
Examples
Request example
The following example retrieves the first page of results for the keyword DescribeInstance and version v2, with one record per page. Replace <AccessKey ID> and <AccessKey Secret> with your credentials.
curl --digest -u '<AccessKey ID>:<AccessKey Secret>' \
--get 'https://api-cloud.oceanbase.com/api/v2/openapis' \
--data-urlencode 'requestId=332b6fef****' \
--data-urlencode 'keyword=DescribeInstance' \
--data-urlencode 'apiVersion=v2' \
--data-urlencode 'pageNumber=1' \
--data-urlencode 'pageSize=1'
Response example
In this example, 16 records match the filters, and the current page contains one record.
{
"data": {
"items": [
{
"apiKey": "DescribeInstance",
"apiVersion": "v2",
"category": "MultiCloudOpenAPI",
"deprecated": false,
"method": "GET",
"summary": "DescribeInstance"
}
],
"total": 16
},
"requestId": "332b6fef****",
"success": true
}