Overview
You can call this API to query the history of parameter modifications at the instance level.
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
GET /api/v2/instances/{instanceId}/parameters/history
Request parameters
Path
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | string | Yes | The ID of the instance. | obcluster-***** |
Query
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| requestId | string | Yes | The ID of the request. | dc302d76-66b5-48d8-ab53-a035******** |
| openRequest | unknown | Yes | The Open request parameter. | N/A |
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. | location_refresh_thread_count |
| oldValue | string | The original value of the parameter. | 2 |
| newValue | string | The new value of the parameter. | 4 |
| dimensionValue | string | The dimension of the parameter. | DEFAULT_DIMENSION_VALUE |
| status | string | The status of the parameter modification history. | APPLIED |
| createTime | string | The creation time of the parameter modification history. | 2025-06-09T08:48:38Z |
| updateTime | string | The last update time of the parameter modification history. | 2025-06-09T08:48:47Z |
| message | string | The message. |
Examples
Request example
curl --digest -u '<Your ak:sk>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/parameters/history?requestId={requestId}&openRequest={openRequest}'
Response example
JSON format
{
"pageNumber": 1,
"totalCount": 1,
"parameters": [
{
"name": "location_refresh_thread_count",
"oldValue": "2",
"newValue": "4",
"dimensionValue": "DEFAULT_DIMENSION_VALUE",
"status": "APPLIED",
"createTime": "2025-06-09T08:48:38Z",
"updateTime": "2025-06-09T08:48:47Z"
}
]
}