Description
The interface for starting an OBProxy server.
Call instructions
Interface constraints
The caller needs to be authenticated through the OCP application service.
Request path
POST /api/v2/obproxy/clusters/{id}/servers/start
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 ID list of OBProxy servers to be started. |
Return result
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 when the server finishes processing the request. |
| duration | Integer | The time taken by the server to process the request, in milliseconds. |
| status | Integer | An HTTP status code that conforms to the HTTP Status specification. |
| traceId | String | The Trace ID of the request, which is used to troubleshoot issues. |
| server | String | The address of the application service that responds to the request. |
Examples
Request example
POST /api/v2/obproxy/clusters/1/servers/start
{
"obproxyServerIds": [
1,
2,
3
]
}
Return example
{
"data": {
"creator": "admin",
"executor": "xxx.xxx.xxx.xxx",
"id": 13153187,
"name": "Start obproxy",
"operation": "EXECUTE",
"prohibitRollback": false,
"startTime": "2025-01-16T11:52:41.132+08:00",
"status": "RUNNING",
"subtasks": [
{
"description": "Start node",
"downstreams": [
13175740
],
"id": 13175741,
"name": "Start node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 13,
"status": "READY",
"taskId": 13153187,
"timeout": 30,
"upstreams": []
},
{
"description": "Restore obproxy weight",
"downstreams": [
13175746
],
"id": 13175744,
"name": "Restore obproxy weight",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 4,
"status": "PENDING",
"taskId": 13153187,
"timeout": 300,
"upstreams": [
13175743
]
},
{
"description": "Wait node",
"downstreams": [
13175745
],
"id": 13175738,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 6,
"status": "PENDING",
"taskId": 13153187,
"timeout": 30,
"upstreams": [
13175736
]
},
{
"description": "Start obproxyd process",
"downstreams": [
13175744
],
"id": 13175743,
"name": "Start obproxyd process",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 3,
"status": "PENDING",
"taskId": 13153187,
"timeout": 1800,
"upstreams": [
13175739
]
},
{
"description": "Update obproxy cluster lock status",
"downstreams": [],
"id": 13175745,
"name": "Update obproxy cluster lock status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 8,
"status": "PENDING",
"taskId": 13153187,
"timeout": 60,
"upstreams": [
13175738
]
},
{
"description": "Wait obproxy accessible",
"downstreams": [
13175739
],
"id": 13175733,
"name": "Wait obproxy accessible",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 7,
"status": "PENDING",
"taskId": 13153187,
"timeout": 1800,
"upstreams": [
13175735
]
},
{
"description": "Wait node",
"downstreams": [
13175736
],
"id": 13175742,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 12,
"status": "PENDING",
"taskId": 13153187,
"timeout": 30,
"upstreams": [
13175746
]
},
{
"description": "Wait node",
"downstreams": [
13175733
],
"id": 13175735,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 0,
"status": "PENDING",
"taskId": 13153187,
"timeout": 30,
"upstreams": [
13175734
]
},
{
"description": "Start obproxy process",
"downstreams": [
13175735
],
"id": 13175734,
"name": "Start obproxy process",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 11,
"status": "PENDING",
"taskId": 13153187,
"timeout": 600,
"upstreams": [
13175737
]
},
{
"description": "Wait node",
"downstreams": [
13175743
],
"id": 13175739,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 9,
"status": "PENDING",
"taskId": 13153187,
"timeout": 30,
"upstreams": [
13175733
]
},
{
"description": "Active agent modules",
"downstreams": [
13175742
],
"id": 13175746,
"name": "Active agent modules",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 5,
"status": "PENDING",
"taskId": 13153187,
"timeout": 1800,
"upstreams": [
13175744
]
},
{
"description": "Update obproxy status",
"downstreams": [
13175738
],
"id": 13175736,
"name": "Update obproxy status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 10,
"status": "PENDING",
"taskId": 13153187,
"timeout": 300,
"upstreams": [
13175742
]
},
{
"description": "Prepare start obproxy",
"downstreams": [
13175737
],
"id": 13175740,
"name": "Prepare start obproxy",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 1,
"status": "PENDING",
"taskId": 13153187,
"timeout": 1800,
"upstreams": [
13175741
]
},
{
"description": "Wait node",
"downstreams": [
13175734
],
"id": 13175737,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 2,
"status": "PENDING",
"taskId": 13153187,
"timeout": 30,
"upstreams": [
13175740
]
}
],
"taskDefinitionId": -1,
"type": "MANUAL"
},
"duration": 92,
"server": "74f95ea2f4",
"status": 200,
"successful": true,
"timestamp": "2025-01-16T11:52:41.184+08:00",
"traceId": "1b588013b5a23030"
}