This API operation is used to check whether the conditions for an OceanBase Database upgrade are met. Specifically, OceanBase Shell (obshell) checks whether the required environment is prepared, whether the OceanBase Database upgrade package is uploaded, and whether all required products are ready.
Call description
Limitations
The obshell server verifies the security of requests to this API operation. For more information, see Hybrid encryption for API operations.
Request path
POST /api/v1/ob/upgrade/check
Request parameters
| Parameter | Type | Required? | Example value | Description |
|---|---|---|---|---|
| version | String | Yes | 4.2.1.1 | The target version of the upgrade. |
| release | String | Yes | 101000062023110109.el7 | The release version and build version of the software package for the upgrade. |
| upgradeDir | String | No | /data/upgrade | The directory used for the upgrade check task. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| successful | Boolean | Indicates whether the request is successful. |
| timestamp | time.Time | The timestamp when the server completed the request. |
| duration | Integer | The amount of time taken by the server to process the request, in milliseconds. |
| status | Integer | The HTTP status code. |
| traceId | String | The trace ID of the request. |
| data | DagDetailDTO | The details of the directed acyclic graph (DAG) task. For more information, see the data structure of DagDetailDTO. |
| error | ApiError | The error caused by the request, which contains the following information:
|
The following table describes the data structure of DagDetailDTO.
| Parameter | Type | Description |
|---|---|---|
| id | String | The general ID of the DAG task. |
| dag_id | Integer | The ID of the DAG task, which is the primary key recorded in OceanBase Database. |
| name | String | The name of the DAG task. |
| stage | Integer | The current stage of the DAG task. |
| max_stage | Integer | The total number of stages of the DAG task during execution. |
| state | String | The execution status of the DAG task. |
| operator | String | The operation type of the DAG task. |
| start_time | time.Time | The time when the execution of the DAG task started. |
| end_time | time.Time | The time when the execution of the DAG task ended. |
| additional_data | map[string]any | Other data of the DAG task. |
| nodes | []NodeDetailDTO | The information about all OBServer nodes involved in the DAG task. For more information, see GetNodeDetails. |
Examples
Sample request
"{
"version":"4.2.1.1",
"release": "101000062023110109.el7"
}"
Sample response
{
"successful": true,
"timestamp": "2024-01-09T16:55:58.588435165+08:00",
"duration": 75,
"status": 200,
"traceId": "8daee52899b845b8",
"data": {
"id": "11",
"dag_id": 1,
"name": "Upgrade check OB 4.2.1.1-101000062023110109.el7",
"stage": 1,
"max_stage": 6,
"state": "READY",
"operator": "RUN",
"start_time": "0001-01-01T00:00:00Z",
"end_time": "0001-01-01T00:00:00Z",
"additional_data": null,
"nodes": null
}
}
References
In addition to using the CLI, you can use SDKs to call the API operation.
For more information about how to call the API operation by using obshell-sdk-python, see Perform an OceanBase Database upgrade check.
For more information about how to call the API operation by using obshell-sdk-go, see Perform an OceanBase Database upgrade check.
