This API operation is used to query the current status of the specified OBServer node, such as the identity, process information, and service status of the node.
Call description
Limitations
The OceanBase Shell (obshell) server verifies the security of requests to this API operation. For more information, see Hybrid encryption for API operations.
Request path
GET /api/v1/status
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 | AgentStatus | The agent status. For more information, see the data structure of AgentStatus. |
| error | ApiError | The error caused by the request, which contains the following information:
|
The following table describes the data structure of AgentStatus.
| Parameter | Type | Description |
|---|---|---|
| agent | AgentInfoWithIdentity | The identity information of the OBServer node, which contains the following parameters:
|
| state | Integer | The status of the observer process. Valid values:
|
| version | String | The version of obshell. |
| pid | Integer | The ID of the observer process. |
| startAt | Integer | The time when the OBServer node started to provide service. |
| port | Integer | The port number of the OBServer node. |
| obState | Integer | The current status of OceanBase Database on the OBServer node. Valid values:
|
| underMaintenance | Boolean | Indicates whether the OBServer node is under O&M. |
The following table describes the valid identities of an OBServer node.
| Identity | Description |
|---|---|
SINGLE |
The node does not belong to any cluster. |
FOLLOWER/MASTER |
The node belongs to an uninitialized cluster. |
CLUSTER AGENT |
The node belongs to an initialized cluster. |
TAKE OVER MASTER/TAKE OVER FOLLOWER |
The node is being taken over. |
SCALING OUT |
The node is being added to a cluster. |
UNIDENTIFIED |
The node identity is not defined. |
Examples
Sample request
GET 10.10.10.1:2886/api/v1/status
Sample response
The API operation returns the status of an OBServer node identified as CLUSTER AGENT. The response shows that the current node is running normally and not under O&M.
{
"successful": true,
"timestamp": "2024-01-09T20:01:52.466963232+08:00",
"duration": 3,
"status": 200,
"traceId": "",
"data": {
"agent": {
"ip": "10.10.10.1",
"port": 2886,
"identity": "CLUSTER AGENT"
},
"state": 2,
"version": "4.2.1.0-0",
"pid": 74314,
"startAt": 1704801582437828890,
"port": 2886,
"obState": 3,
"underMaintenance": false
}
}
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 Query the status of a node.
For more information about how to call the API operation by using obshell-sdk-go, see Query the status of a node.