This API operation is used to query the information about an OBServer 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/task/node/{id}
Here, id indicates the general ID of the OBServer node.
Response parameters
Parameter |
Type |
Description |
|---|---|---|
| successful | Boolean | Indicates whether the request was 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 | NodeDetailDTO | The information about the OBServer node. For more information, see the data structure of NodeDetailDTO. |
| error | ApiError | The error caused by the request, which contains the following information:
|
The following table describes the data structure of NodeDetailDTO.
Parameter |
Type |
Description |
|---|---|---|
| id | String | The general ID of the OBServer node. |
| node_id | Integer | The ID of the OBServer node, which is the primary key recorded in OceanBase Database. |
| name | String | The name of the OBServer node. |
| state | String | The execution status of the OBServer node. |
| operator | String | The operation type of the OBServer node. |
| start_time | time.Time | The time when the operation execution started. |
| end_time | time.Time | The time when the operation execution ended. |
| additional_data | map[string]any | Other data of the OBServer node. |
| sub_tasks | []TaskDetailDTO | The information about all subtasks on the OBServer node. For more information, see the data structure of TaskDetailDTO. |
The following table describes the data structure of TaskDetailDTO.
Parameter |
Type |
Description |
|---|---|---|
| id | String | The general ID of the subtask. |
| task_id | Integer | The ID of the subtask, which is the primary key recorded in OceanBase Database. |
| name | String | The name of the subtask. |
| state | String | The execution status of the subtask. |
| operator | String | The operation type of the subtask. |
| start_time | time.Time | The time when the execution of the subtask started. |
| end_time | time.Time | The time when the execution of the subtask ended. |
| additional_data | map[string]any | Other data of the subtask. |
| execute_times | Integer | The number of executions. |
| execute_agent | AgentInfo | The agent information of the OBServer node that executed the subtask, including the following parameters:
|
| task_logs | []string | The execution logs. |
Examples
Sample request
GET 10.10.10.1:2886/api/v1/task/node/11
Sample response
The sample response displays the information about a node named Integrate server config. The operation type is RUN, and the execution result is SUCCEED.
{
"successful": true,
"timestamp": "2024-01-09T21:18:19.721587522+08:00",
"duration": 10,
"status": 200,
"traceId": "cd6c87efd848bb02",
"data": {
"id": "11",
"node_id": 1,
"name": "Integrate server config",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:01.718882+08:00",
"end_time": "2024-01-09T20:40:02.751743+08:00",
"additional_data": null,
"sub_tasks": [
{
"id": "11",
"task_id": 1,
"name": "Integrate server config",
"state": "SUCCEED",
"operator": "RUN",
"start_time": "2024-01-09T20:40:01.74723+08:00",
"end_time": "2024-01-09T20:40:01.76717+08:00",
"additional_data": null,
"execute_times": 1,
"execute_agent": {
"ip": "10.10.10.1",
"port": 2886
},
"task_logs": []
}
]
}
}
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 Obtain the information about a node.
For more information about how to call the API operation by using obshell-sdk-go, see Obtain the information about a node.