Overview
You can call this API to query the modification history of tenant-level parameters.
API details
Constraints
The caller must have an AccessKey for accessing APIs of OceanBase Cloud. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/parameters/history
Request parameters
Path
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the instance. | obxxx |
| tenantId | String | Yes | The ID of the tenant. | txxx |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| pageNumber | int | The page number. | 1 |
| totalCount | int | The total number of items. | 1 |
| parameters | array | The list of parameters. | |
| name | string | The name of the parameter. | connect_timeout |
| oldValue | string | The original value of the parameter. | 10 |
| newValue | string | The new value of the parameter. | 9 |
| dimensionValue | string | The dimension of the parameter. | txxx |
| status | string | The status of the modification history. | APPLIED |
| createTime | string | The creation time of the modification history. | 2025-06-09T09:00:18Z |
| updateTime | string | The update time of the modification history. | 2025-06-09T09:00:30Z |
| message | string | "" |
Examples
Request example
curl --digest -u 'ak:sk' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/parameters/history' \
-G -d 'startTime=xxx' -d 'endTime=xxx' -d 'page=xxx' -d 'size=xxx'
Response example
JSON format
{
"pageNumber": 1,
"totalCount": 1,
"parameters": [
{
"name": "connect_timeout",
"oldValue": "10",
"newValue": "9",
"dimensionValue": "txxx",
"status": "APPLIED",
"createTime": "2025-06-09T09:00:18Z",
"updateTime": "2025-06-09T09:00:30Z",
"message": ""
}
]
}