Description
You can call this operation to upgrade 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/upgrade
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 upgraded. |
| shortRpmName | String | Yes | obproxy-1.9.1.1-1919579 | The name of the software package of the target version without the .rpm extension. |
| packageOperatingSystem | String | No | el8 | The operating system of the software package. If you do not specify this parameter, cluster settings are used by default. |
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/upgrade
{
"obproxyServerIds": [
1,
2,
3
],
"shortRpmName": "obproxy-1.8.4-1915266",
"packageOperatingSystem": "el8"
}
Sample response
{
"data": {
"creator": "admin",
"executor": "xxx.xxx.xxx.xxx",
"id": 13153302,
"name": "Upgrade obproxy",
"operation": "EXECUTE",
"prohibitRollback": true,
"startTime": "2025-01-16T17:19:06.339+08:00",
"status": "RUNNING",
"subtasks": [
{
"description": "Wait node",
"downstreams": [
13176022
],
"id": 13176023,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 24,
"status": "PENDING",
"taskId": 13153302,
"timeout": 30,
"upstreams": [
13176015
]
},
{
"description": "Wait node",
"downstreams": [
13176001
],
"id": 13176012,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 0,
"status": "PENDING",
"taskId": 13153302,
"timeout": 30,
"upstreams": [
13176013
]
},
{
"description": "Hot restart obproxy",
"downstreams": [
13176014
],
"id": 13176005,
"name": "Hot restart obproxy",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 23,
"status": "PENDING",
"taskId": 13153302,
"timeout": 1800,
"upstreams": [
13176008
]
},
{
"description": "Set obproxy cluster version",
"downstreams": [
13176017
],
"id": 13176018,
"name": "Set obproxy cluster version",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 25,
"status": "PENDING",
"taskId": 13153302,
"timeout": 1800,
"upstreams": [
13176020
]
},
{
"description": "Wait node",
"downstreams": [
13176008
],
"id": 13176006,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 13,
"status": "PENDING",
"taskId": 13153302,
"timeout": 30,
"upstreams": [
13175999
]
},
{
"description": "Check and reset proxy_id if need",
"downstreams": [
13176018
],
"id": 13176020,
"name": "Check and reset proxy_id if need",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": true,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 14,
"status": "PENDING",
"taskId": 13153302,
"timeout": 1800,
"upstreams": [
13176019
]
},
{
"description": "Wait node",
"downstreams": [
13175998
],
"id": 13176016,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 6,
"status": "PENDING",
"taskId": 13153302,
"timeout": 30,
"upstreams": [
13176022
]
},
{
"description": "Uninstall obproxy package",
"downstreams": [
13176011
],
"id": 13176001,
"name": "Uninstall obproxy package",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 2,
"status": "PENDING",
"taskId": 13153302,
"timeout": 1800,
"upstreams": [
13176012
]
},
{
"description": "Wait node",
"downstreams": [
13176013
],
"id": 13176000,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 1,
"status": "PENDING",
"taskId": 13153302,
"timeout": 30,
"upstreams": [
13176021
]
},
{
"description": "Wait node",
"downstreams": [
13175999
],
"id": 13176011,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 21,
"status": "PENDING",
"taskId": 13153302,
"timeout": 30,
"upstreams": [
13176001
]
},
{
"description": "Start node",
"downstreams": [
13176002
],
"id": 13176010,
"name": "Start node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 8,
"status": "READY",
"taskId": 13153302,
"timeout": 30,
"upstreams": []
},
{
"description": "Finish node",
"downstreams": [],
"id": 13176003,
"name": "Finish node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 18,
"status": "PENDING",
"taskId": 13153302,
"timeout": 0,
"upstreams": [
13176017
]
},
{
"description": "Prepare upgrade obproxy",
"downstreams": [
13176007
],
"id": 13176002,
"name": "Prepare upgrade obproxy",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 19,
"status": "PENDING",
"taskId": 13153302,
"timeout": 1800,
"upstreams": [
13176010
]
},
{
"description": "Check proxy version",
"downstreams": [
13176023
],
"id": 13176015,
"name": "Check proxy version",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 9,
"status": "PENDING",
"taskId": 13153302,
"timeout": 1800,
"upstreams": [
13176004
]
},
{
"description": "Wait node",
"downstreams": [
13176015
],
"id": 13176004,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 7,
"status": "PENDING",
"taskId": 13153302,
"timeout": 30,
"upstreams": [
13176009
]
},
{
"description": "Prepare etc for obproxy",
"downstreams": [
13176000
],
"id": 13176021,
"name": "Prepare etc for obproxy",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 5,
"status": "PENDING",
"taskId": 13153302,
"timeout": 600,
"upstreams": [
13176007
]
},
{
"description": "Copy obproxy config db file",
"downstreams": [
13176012
],
"id": 13176013,
"name": "Copy obproxy config db file",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 11,
"status": "PENDING",
"taskId": 13153302,
"timeout": 1800,
"upstreams": [
13176000
]
},
{
"description": "Restart obproxyd process",
"downstreams": [
13176016
],
"id": 13176022,
"name": "Restart obproxyd process",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 10,
"status": "PENDING",
"taskId": 13153302,
"timeout": 1800,
"upstreams": [
13176023
]
},
{
"description": "Upgrade Obproxy Rpm",
"downstreams": [
13176006
],
"id": 13175999,
"name": "Upgrade Obproxy Rpm",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 22,
"status": "PENDING",
"taskId": 13153302,
"timeout": 3600,
"upstreams": [
13176011
]
},
{
"description": "Wait node",
"downstreams": [
13176021
],
"id": 13176007,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 15,
"status": "PENDING",
"taskId": 13153302,
"timeout": 30,
"upstreams": [
13176002
]
},
{
"description": "Wait node",
"downstreams": [
13176020
],
"id": 13176019,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 12,
"status": "PENDING",
"taskId": 13153302,
"timeout": 30,
"upstreams": [
13175998
]
},
{
"description": "Wait hot restart obproxy finish",
"downstreams": [
13176004
],
"id": 13176009,
"name": "Wait hot restart obproxy finish",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 20,
"status": "PENDING",
"taskId": 13153302,
"timeout": 1800,
"upstreams": [
13176014
]
},
{
"description": "Record obproxy info",
"downstreams": [
13176005
],
"id": 13176008,
"name": "Record obproxy info",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 16,
"status": "PENDING",
"taskId": 13153302,
"timeout": 1800,
"upstreams": [
13176006
]
},
{
"description": "Update obproxy status",
"downstreams": [
13176003
],
"id": 13176017,
"name": "Update obproxy status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 3,
"status": "PENDING",
"taskId": 13153302,
"timeout": 300,
"upstreams": [
13176018
]
},
{
"description": "Set obproxy version",
"downstreams": [
13176019
],
"id": 13175998,
"name": "Set obproxy version",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 17,
"status": "PENDING",
"taskId": 13153302,
"timeout": 1800,
"upstreams": [
13176016
]
},
{
"description": "Wait node",
"downstreams": [
13176009
],
"id": 13176014,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 4,
"status": "PENDING",
"taskId": 13153302,
"timeout": 30,
"upstreams": [
13176005
]
}
],
"taskDefinitionId": -1,
"type": "MANUAL"
},
"duration": 91,
"server": "74f95ea2f4",
"status": 200,
"successful": true,
"timestamp": "2025-01-16T17:19:06.41+08:00",
"traceId": "d566483d84513775"
}