Overview
Modify the cluster's JVM environment dependency service configuration.
API details
Constraints
You must have the permission to take over an OceanBase cluster.
For more information about the permissions of the caller, see Overview.
The caller must pass the authentication for OCP application services.
Request path
POST /api/v2/ob/clusters/{id}/modifyJvmDepsService
Request parameters
path:
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| id | Long | Yes | 160 | The ID of the target cluster in OCP. |
body:
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| jvmEnvServices | Array | No | ODPS External Table,HDFS External Table,Java UDF,ODPS Catalog,MySQL Plugin | Environment-dependent services. Valid values: |
| maxJvmMemoryGiB | Integer | No | 1 | The maximum memory size entered by the user, in GiB. |
| restartMode | String | Yes | FORCE | Restart method. Valid values: |
| freezeServer | Boolean | Yes | true | Whether to perform a minor compaction before stopping the process. Valid values: |
Response parameters
Basic data structures
Parameter |
Type |
Description |
|---|---|---|
| data | Object | Information about the asynchronous task. For more information, see Task return structure. |
| successful | Boolean | Whether the request was successful. |
| timestamp | Datetime | The timestamp when the server completed the request. |
| duration | Integer | The time taken by the server to process the request, in milliseconds. |
| status | Integer | An HTTP status code. |
| traceId | String | The trace ID of the request, used for troubleshooting. |
| server | String | The address of the application service that responded to the request. |
Examples
Request example
POST /api/v2/ob/clusters/160/modifyJvmDepsService
{
"jvmEnvServices": ["ODPS External Table", "HDFS External Table", "Java UDF", "ODPS Catalog", "MySQL Plugin"],
"maxJvmMemoryGiB": 1,
"restartMode": "FORCE",
"freezeServer": true
}
Response example
{
"data": {
"clusterId": 160,
"creator": "admin",
"executor": "xx.xx.xx.xx",
"id": 98026,
"name": "Modify JVM dependencies service",
"operation": "EXECUTE",
"prohibitRollback": false,
"startTime": "2025-12-23T10:48:16.805675377+08:00",
"status": "RUNNING",
"subtasks": [{
"description": "Wait node",
"downstreams": [114146],
"id": 114133,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 0,
"status": "PENDING",
"taskId": 98026,
"timeout": 30,
"upstreams": [114137]
},
{
"description": "Update zone status",
"downstreams": [114133],
"id": 114137,
"name": "Update zone status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 24,
"status": "PENDING",
"taskId": 98026,
"timeout": 1800,
"upstreams": [114130]
},
{
"description": "Prepare modify JVM environment service",
"downstreams": [114128],
"id": 114142,
"name": "Prepare modify JVM environment service",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 15,
"status": "PENDING",
"taskId": 98026,
"timeout": 300,
"upstreams": [114134]
},
{
"description": "Freeze observer",
"downstreams": [114145],
"id": 114139,
"name": "Freeze observer",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 4,
"status": "PENDING",
"taskId": 98026,
"timeout": 1800,
"upstreams": [114126]
},
{
"description": "Wait node",
"downstreams": [114127],
"id": 114131,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 25,
"status": "PENDING",
"taskId": 98026,
"timeout": 30,
"upstreams": [114128]
},
{
"description": "Wait observer active",
"downstreams": [114144],
"id": 114143,
"name": "Wait observer active",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 8,
"status": "PENDING",
"taskId": 98026,
"timeout": 1800,
"upstreams": [114148]
},
{
"description": "Wait node",
"downstreams": [114140],
"id": 114132,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 27,
"status": "PENDING",
"taskId": 98026,
"timeout": 30,
"upstreams": [114127]
},
{
"description": "Wait node",
"downstreams": [114125],
"id": 114145,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 18,
"status": "PENDING",
"taskId": 98026,
"timeout": 30,
"upstreams": [114139]
},
{
"description": "Prepare restart OB zone",
"downstreams": [114126],
"id": 114147,
"name": "Prepare restart OB zone",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 2,
"status": "PENDING",
"taskId": 98026,
"timeout": 1800,
"upstreams": [114140]
},
{
"description": "Wait node",
"downstreams": [114129],
"id": 114141,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 12,
"status": "PENDING",
"taskId": 98026,
"timeout": 30,
"upstreams": [114125]
},
{
"description": "Wait node",
"downstreams": [114137],
"id": 114130,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 21,
"status": "PENDING",
"taskId": 98026,
"timeout": 30,
"upstreams": [114149]
},
{
"description": "Update ob cluster start time task",
"downstreams": [114149],
"id": 114124,
"name": "Update ob cluster start time task",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 28,
"status": "PENDING",
"taskId": 98026,
"timeout": 60,
"upstreams": [114122]
},
{
"description": "Install JVM env environment service packages",
"downstreams": [114131],
"id": 114128,
"name": "Install JVM env environment service packages",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 3,
"status": "PENDING",
"taskId": 98026,
"timeout": 3600,
"upstreams": [114142]
},
{
"description": "Update observer status",
"downstreams": [114130],
"id": 114149,
"name": "Update observer status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 19,
"status": "PENDING",
"taskId": 98026,
"timeout": 300,
"upstreams": [114124]
},
{
"description": "Set JVM environment dependency service parameters",
"downstreams": [114132],
"id": 114127,
"name": "Set JVM environment dependency service parameters",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 14,
"status": "PENDING",
"taskId": 98026,
"timeout": 1800,
"upstreams": [114131]
},
{
"description": "Stop observer process",
"downstreams": [114150],
"id": 114129,
"name": "Stop observer process",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 5,
"status": "PENDING",
"taskId": 98026,
"timeout": 1200,
"upstreams": [114141]
},
{
"description": "Active agent modules",
"downstreams": [114122],
"id": 114144,
"name": "Active agent modules",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 23,
"status": "PENDING",
"taskId": 98026,
"timeout": 1800,
"upstreams": [114143]
},
{
"description": "Mc unlock ob clusters",
"downstreams": [],
"id": 114136,
"name": "Mc unlock ob clusters",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 17,
"status": "PENDING",
"taskId": 98026,
"timeout": 60,
"upstreams": [114138]
},
{
"description": "Wait observer accessible",
"downstreams": [114143],
"id": 114148,
"name": "Wait observer accessible",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 7,
"status": "PENDING",
"taskId": 98026,
"timeout": 1200,
"upstreams": [114123]
},
{
"description": "Begin start JVM environment service",
"downstreams": [114147],
"id": 114140,
"name": "Begin start JVM environment service",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": true,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 1,
"status": "PENDING",
"taskId": 98026,
"timeout": 60,
"upstreams": [114132]
},
{
"description": "Inactive agent modules",
"downstreams": [114141],
"id": 114125,
"name": "Inactive agent modules",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 10,
"status": "PENDING",
"taskId": 98026,
"timeout": 3600,
"upstreams": [114145]
},
{
"description": "Mc lock ob clusters",
"downstreams": [114142],
"id": 114134,
"name": "Mc lock ob clusters",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 20,
"status": "READY",
"taskId": 98026,
"timeout": 60,
"upstreams": []
},
{
"description": "Start observer process",
"downstreams": [114148],
"id": 114123,
"name": "Start observer process",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 6,
"status": "PENDING",
"taskId": 98026,
"timeout": 1200,
"upstreams": [114150]
},
{
"description": "Wait node",
"downstreams": [114139],
"id": 114126,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 11,
"status": "PENDING",
"taskId": 98026,
"timeout": 30,
"upstreams": [114147]
},
{
"description": "Update OB cluster status",
"downstreams": [114136],
"id": 114138,
"name": "Update OB cluster status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 13,
"status": "PENDING",
"taskId": 98026,
"timeout": 30,
"upstreams": [114135]
},
{
"description": "Sync all tenant information",
"downstreams": [114138],
"id": 114135,
"name": "Sync all tenant information",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 9,
"status": "PENDING",
"taskId": 98026,
"timeout": 300,
"upstreams": [114146]
},
{
"description": "Wait node",
"downstreams": [114123],
"id": 114150,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 22,
"status": "PENDING",
"taskId": 98026,
"timeout": 30,
"upstreams": [114129]
},
{
"description": "Wait node",
"downstreams": [114124],
"id": 114122,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 26,
"status": "PENDING",
"taskId": 98026,
"timeout": 30,
"upstreams": [114144]
},
{
"description": "Sync cluster info",
"downstreams": [114135],
"id": 114146,
"name": "Sync cluster info",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 16,
"status": "PENDING",
"taskId": 98026,
"timeout": 300,
"upstreams": [114133]
}],
"taskDefinitionId": -1,
"type": "MANUAL"
},
"duration": 123,
"server": "5e11a5f435",
"status": 200,
"successful": true,
"timestamp": "2025-12-23T10:48:16.850126845+08:00",
"traceId": "e0fc494ba0671193"
}