Description
This topic describes the API for deleting an OBProxy cluster.
Syntax
Constraints
You must use the OCP application service for authentication.
Request path
DELETE /api/v2/obproxy/clusters/{id}
Request parameters
path:
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| id | Long | Yes | 1 | The ID of the OBProxy cluster. |
Response
Basic data structure
Parameter |
Type |
Description |
|---|---|---|
| data | Object | Asynchronous task information. For more information, see Task information. |
| successful | Boolean | Indicates whether the request is successful. |
| timestamp | Datetime | The timestamp indicating the time when the server finishes processing the request. |
| duration | Integer | The time taken by the server to process the request, in milliseconds. |
| status | Integer | The HTTP status code that conforms to the HTTP standard. |
| traceId | String | The Trace ID of the request, which is used for troubleshooting. |
| server | String | The address of the application service that responds to the request. |
Examples
Request example
DELETE /api/v2/obproxy/clusters/27
Response example
{
"data": {
"creator": "admin",
"executor": "xxx.xxx.xxx.xxx",
"id": 31440,
"name": "Offline obproxy",
"operation": "EXECUTE",
"startTime": "2021-09-03T15:13:22.655+08:00",
"status": "RUNNING",
"subtasks": [{
"description": "Finish node",
"downstreams": [],
"id": 33148,
"name": "Finish node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 1,
"status": "PENDING",
"timeout": 0,
"upstreams": [33147]
}, {
"description": "Start node",
"downstreams": [33148],
"id": 33147,
"name": "Start node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 0,
"status": "READY",
"timeout": 30,
"upstreams": []
}],
"taskDefinitionId": -1,
"type": "MANUAL"
},
"duration": 46,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-03T15:13:22.679+08:00",
"traceId": "54e4e962c95d4e3e"
}