Description
You can call this operation to delete an OBProxy.
Call description
Prerequisites
You have passed the authentication for the OceanBase Cloud Platform (OCP) application service.
Request path
POST /api/v2/obproxy/clusters/{id}/servers/delete
Request parameters
path:
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| id | Long | Yes | 1 | The ID of the OBProxy cluster. |
body:
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| obproxyServerIds | Long | Yes | 1,2,3 | The IDs of the OBProxies to be deleted. |
| skipHostOperationServerIds | Long | No | 1 | The IDs of OBProxies that skip host operations. You can specify this parameter when the corresponding hosts are offline, and then manually clean up the hosts. |
Response parameters
Basic data structure
| Parameter | Type | Description |
|---|---|---|
| data | Object | The information about the asynchronous task. For more information, see Task return structure. |
| successful | Boolean | Indicates whether the request was 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. This trace ID is used for troubleshooting. |
| server | String | The address of the application server that responded to the request. |
Examples
Sample request
POST /api/v2/obproxy/clusters/1/servers/delete
{
"obproxyServerIds": [
1,
2,
3
],
"skipHostOperationServerIds": [
1
]
}
Sample response
{
"data": {
"creator": "admin",
"executor": "xxx.xxx.xxx.xxx",
"id": 13153297,
"name": "Delete obproxy server",
"operation": "EXECUTE",
"prohibitRollback": false,
"startTime": "2025-01-16T17:08:22.719+08:00",
"status": "RUNNING",
"subtasks": [
{
"description": "Wait node",
"downstreams": [
13175954
],
"id": 13175952,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 11,
"status": "PENDING",
"taskId": 13153297,
"timeout": 30,
"upstreams": [
13175943
]
},
{
"description": "Delete obproxy client load balance info",
"downstreams": [
13175951
],
"id": 13175949,
"name": "Delete obproxy client load balance info",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 12,
"status": "PENDING",
"taskId": 13153297,
"timeout": 300,
"upstreams": [
13175954
]
},
{
"description": "Clear ocp agent configs",
"downstreams": [
13175955
],
"id": 13175944,
"name": "Clear ocp agent configs",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 0,
"status": "PENDING",
"taskId": 13153297,
"timeout": 120,
"upstreams": [
13175942
]
},
{
"description": "Delete obproxy info",
"downstreams": [
13175958
],
"id": 13175951,
"name": "Delete obproxy info",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 4,
"status": "PENDING",
"taskId": 13153297,
"timeout": 300,
"upstreams": [
13175949
]
},
{
"description": "Update obproxy cluster lock status",
"downstreams": [
13175946
],
"id": 13175955,
"name": "Update obproxy cluster lock status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 9,
"status": "PENDING",
"taskId": 13153297,
"timeout": 60,
"upstreams": [
13175944
]
},
{
"description": "Finish node",
"downstreams": [],
"id": 13175946,
"name": "Finish node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 17,
"status": "PENDING",
"taskId": 13153297,
"timeout": 0,
"upstreams": [
13175955
]
},
{
"description": "Stop obproxy",
"downstreams": [
13175950
],
"id": 13175940,
"name": "Stop obproxy",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": true,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 3,
"status": "PENDING",
"taskId": 13153297,
"timeout": 1800,
"upstreams": [
13175948
]
},
{
"description": "Wait node",
"downstreams": [
13175942
],
"id": 13175957,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 18,
"status": "PENDING",
"taskId": 13153297,
"timeout": 30,
"upstreams": [
13175958
]
},
{
"description": "Prepare operate obproxy task",
"downstreams": [
13175956
],
"id": 13175941,
"name": "Prepare operate obproxy task",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 6,
"status": "READY",
"taskId": 13153297,
"timeout": 60,
"upstreams": []
},
{
"description": "Wait node",
"downstreams": [
13175943
],
"id": 13175950,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 10,
"status": "PENDING",
"taskId": 13153297,
"timeout": 30,
"upstreams": [
13175940
]
},
{
"description": "remove obproxy from load balance resource pool",
"downstreams": [
13175947
],
"id": 13175953,
"name": "remove obproxy from load balance resource pool",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 15,
"status": "PENDING",
"taskId": 13153297,
"timeout": 300,
"upstreams": [
13175945
]
},
{
"description": "Offline obproxy exporter",
"downstreams": [
13175957
],
"id": 13175958,
"name": "Offline obproxy exporter",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 16,
"status": "PENDING",
"taskId": 13153297,
"timeout": 30,
"upstreams": [
13175951
]
},
{
"description": "Wait node",
"downstreams": [
13175953
],
"id": 13175945,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 5,
"status": "PENDING",
"taskId": 13153297,
"timeout": 30,
"upstreams": [
13175956
]
},
{
"description": "Uninstall obproxy package",
"downstreams": [
13175949
],
"id": 13175954,
"name": "Uninstall obproxy package",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 13,
"status": "PENDING",
"taskId": 13153297,
"timeout": 1800,
"upstreams": [
13175952
]
},
{
"description": "Prepare delete obproxy",
"downstreams": [
13175945
],
"id": 13175956,
"name": "Prepare delete obproxy",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 1,
"status": "PENDING",
"taskId": 13153297,
"timeout": 1800,
"upstreams": [
13175941
]
},
{
"description": "Clean obproxy files",
"downstreams": [
13175952
],
"id": 13175943,
"name": "Clean obproxy files",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 19,
"status": "PENDING",
"taskId": 13153297,
"timeout": 1800,
"upstreams": [
13175950
]
},
{
"description": "Wait node",
"downstreams": [
13175940
],
"id": 13175948,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 8,
"status": "PENDING",
"taskId": 13153297,
"timeout": 30,
"upstreams": [
13175959
]
},
{
"description": "Wait node",
"downstreams": [
13175959
],
"id": 13175947,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 7,
"status": "PENDING",
"taskId": 13153297,
"timeout": 30,
"upstreams": [
13175953
]
},
{
"description": "Unreserve host",
"downstreams": [
13175944
],
"id": 13175942,
"name": "Unreserve host",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 2,
"status": "PENDING",
"taskId": 13153297,
"timeout": 1800,
"upstreams": [
13175957
]
},
{
"description": "Inactive agent modules",
"downstreams": [
13175948
],
"id": 13175959,
"name": "Inactive agent modules",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 14,
"status": "PENDING",
"taskId": 13153297,
"timeout": 3600,
"upstreams": [
13175947
]
}
],
"taskDefinitionId": -1,
"type": "MANUAL"
},
"duration": 85,
"server": "74f95ea2f4",
"status": 200,
"successful": true,
"timestamp": "2025-01-16T17:08:22.78+08:00",
"traceId": "debd595a13b904b7"
}
