This API 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
Request path
GET /api/v1/status
Response parameters
| Parameter | Type | Description |
|---|---|---|
| successful | Boolean | Indicates whether the request is successful. |
| timestamp | Datetime | 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 | Object | For more information, see the data structure of http.AgentStatus. |
| error | Object | The information about the error that occurred. |
The following table describes the data structure of http.AgentStatus.
| Parameter | Type | Description |
|---|---|---|
| agent | Object | The identity information of the OBServer node. Valid identity values are described below. |
| state | Integer | The status of the node service. Valid values: 1: Starting 2: Running 3: Stopping 4: Stopped |
| version | String | The version of OceanBase Shell (OBShell). |
| pid | Integer | The ID of the node service process. |
| startAt | Integer | The time when the node started to provide service. |
| port | Integer | The port number of the node. |
| obState | Integer | The current status of the observer process managed by the node. Valid values: 0: The observer process is not started. 1: The observer process is started. 2: The observer process is not initialized. 3: The observer process is initialized. |
| underMaintenance | Boolean | Indicates whether the node is under maintenance. |
The following table describes the valid identity values of a node.
| Identity | Description |
|---|---|
| SINGLE | The node does not belong to any cluster. |
| FOLLOWER or MASTER | The node belongs to an uninitialized cluster. |
| CLUSTER AGENT | The node belongs to an initialized cluster. |
| TAKE OVER MASTER or TAKE OVER FOLLOWER | The node is being undertaken by a cluster. |
| SCALING OUT | The node is being added to a cluster. |
| UNIDENTIFIED | The node identity is not defined. |
Examples
Sample request
GET xxx.xxx.xxx:2886/api/v1/status
Sample response
{
"successful": true,
"timestamp": "2024-01-09T20:01:52.466963232+08:00",
"duration": 3,
"status": 200,
"traceId": "",
"data": {
"agent": {
"ip": "xxx.xxx.1",
"port": 2886,
"identity": "CLUSTER AGENT"
},
"state": 2,
"version": "4.2.1.0-0",
"pid": 74314,
"startAt": 1704801582437828890,
"port": 2886,
"obState": 3,
"underMaintenance": false
}
}
In the sample response, the identity of the node is CLUSTER AGENT, and the OceanBase cluster normally provides services and is not under maintenance.