Overview
Enable the JVM environment dependency service for the cluster.
API details
Constraints
The caller must have the permission to take over the OceanBase cluster.
For more information about the permissions of the caller, see Users and Permissions Overview.
The caller must pass the authentication for the OCP application service.
Request path
POST /api/v2/ob/clusters/{id}/startJvmDepsService
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 | Yes | ODPS External Table,HDFS External Table,Java UDF,ODPS Catalog,MySQL Plugin | Environment-dependent services. Valid values: |
| maxJvmMemoryGiB | Integer | Yes | 1 | The maximum memory size entered by the user, in GiB. |
| javaHomePath | String | Yes | /usr/local/java/jdk-17.0.8 |
The JAVA_HOME path. |
| 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/startJvmDepsService
{
"jvmEnvServices": ["ODPS External Table", "HDFS External Table", "Java UDF", "ODPS Catalog", "MySQL Plugin"],
"maxJvmMemoryGiB": 1,
"javaHomePath": "/usr/local/java/jdk-17.0.8",
"restartMode": "FORCE",
"freezeServer": true
}
Response example
{
"data": {
"clusterId": 160,
"creator": "admin",
"executor": "xx.xx.xx.xx",
"id": 98021,
"name": "Start JVM dependencies service",
"operation": "EXECUTE",
"prohibitRollback": false,
"startTime": "2025-12-23T10:43:43.375377483+08:00",
"status": "RUNNING",
"subtasks": [{
"description": "Wait node",
"downstreams": [114060],
"id": 114055,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 3,
"status": "PENDING",
"taskId": 98021,
"timeout": 30,
"upstreams": [114057]
},
{
"description": "Freeze observer",
"downstreams": [114068],
"id": 114071,
"name": "Freeze observer",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 0,
"status": "PENDING",
"taskId": 98021,
"timeout": 1800,
"upstreams": [114049]
},
{
"description": "Wait node",
"downstreams": [114071],
"id": 114049,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 26,
"status": "PENDING",
"taskId": 98021,
"timeout": 30,
"upstreams": [114072]
},
{
"description": "Prepare enable JVM environment service",
"downstreams": [114073],
"id": 114077,
"name": "Prepare enable JVM environment service",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 9,
"status": "PENDING",
"taskId": 98021,
"timeout": 300,
"upstreams": [114074]
},
{
"description": "Start observer process",
"downstreams": [114056],
"id": 114052,
"name": "Start observer process",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 2,
"status": "PENDING",
"taskId": 98021,
"timeout": 1200,
"upstreams": [114065]
},
{
"description": "Wait observer active",
"downstreams": [114075],
"id": 114066,
"name": "Wait observer active",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 15,
"status": "PENDING",
"taskId": 98021,
"timeout": 1800,
"upstreams": [114056]
},
{
"description": "Wait node",
"downstreams": [114070],
"id": 114076,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 18,
"status": "PENDING",
"taskId": 98021,
"timeout": 30,
"upstreams": [114053]
},
{
"description": "Wait node",
"downstreams": [114063],
"id": 114061,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 11,
"status": "PENDING",
"taskId": 98021,
"timeout": 30,
"upstreams": [114075]
},
{
"description": "Update OB cluster status",
"downstreams": [114064],
"id": 114054,
"name": "Update OB cluster status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 14,
"status": "PENDING",
"taskId": 98021,
"timeout": 30,
"upstreams": [114067]
},
{
"description": "Sync cluster info",
"downstreams": [114067],
"id": 114060,
"name": "Sync cluster info",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 5,
"status": "PENDING",
"taskId": 98021,
"timeout": 300,
"upstreams": [114055]
},
{
"description": "Active agent modules",
"downstreams": [114061],
"id": 114075,
"name": "Active agent modules",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 4,
"status": "PENDING",
"taskId": 98021,
"timeout": 1800,
"upstreams": [114066]
},
{
"description": "Update ob cluster start time task",
"downstreams": [114059],
"id": 114063,
"name": "Update ob cluster start time task",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 20,
"status": "PENDING",
"taskId": 98021,
"timeout": 60,
"upstreams": [114061]
},
{
"description": "Wait node",
"downstreams": [114057],
"id": 114051,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 28,
"status": "PENDING",
"taskId": 98021,
"timeout": 30,
"upstreams": [114059]
},
{
"description": "Wait observer accessible",
"downstreams": [114066],
"id": 114056,
"name": "Wait observer accessible",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 24,
"status": "PENDING",
"taskId": 98021,
"timeout": 1200,
"upstreams": [114052]
},
{
"description": "Wait node",
"downstreams": [114052],
"id": 114065,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 19,
"status": "PENDING",
"taskId": 98021,
"timeout": 30,
"upstreams": [114070]
},
{
"description": "Wait node",
"downstreams": [114069],
"id": 114062,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 13,
"status": "PENDING",
"taskId": 98021,
"timeout": 30,
"upstreams": [114050]
},
{
"description": "Inactive agent modules",
"downstreams": [114076],
"id": 114053,
"name": "Inactive agent modules",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 16,
"status": "PENDING",
"taskId": 98021,
"timeout": 3600,
"upstreams": [114068]
},
{
"description": "Install JVM env environment service packages",
"downstreams": [114058],
"id": 114073,
"name": "Install JVM env environment service packages",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 8,
"status": "PENDING",
"taskId": 98021,
"timeout": 3600,
"upstreams": [114077]
},
{
"description": "Update zone status",
"downstreams": [114055],
"id": 114057,
"name": "Update zone status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 25,
"status": "PENDING",
"taskId": 98021,
"timeout": 1800,
"upstreams": [114051]
},
{
"description": "Wait node",
"downstreams": [114050],
"id": 114058,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 7,
"status": "PENDING",
"taskId": 98021,
"timeout": 30,
"upstreams": [114073]
},
{
"description": "Begin start JVM environment service",
"downstreams": [114072],
"id": 114069,
"name": "Begin start JVM environment service",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": true,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 23,
"status": "PENDING",
"taskId": 98021,
"timeout": 60,
"upstreams": [114062]
},
{
"description": "Stop observer process",
"downstreams": [114065],
"id": 114070,
"name": "Stop observer process",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 22,
"status": "PENDING",
"taskId": 98021,
"timeout": 1200,
"upstreams": [114076]
},
{
"description": "Set JVM environment dependency service parameters",
"downstreams": [114062],
"id": 114050,
"name": "Set JVM environment dependency service parameters",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 1,
"status": "PENDING",
"taskId": 98021,
"timeout": 1800,
"upstreams": [114058]
},
{
"description": "Prepare restart OB zone",
"downstreams": [114049],
"id": 114072,
"name": "Prepare restart OB zone",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 21,
"status": "PENDING",
"taskId": 98021,
"timeout": 1800,
"upstreams": [114069]
},
{
"description": "Sync all tenant information",
"downstreams": [114054],
"id": 114067,
"name": "Sync all tenant information",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 17,
"status": "PENDING",
"taskId": 98021,
"timeout": 300,
"upstreams": [114060]
},
{
"description": "Mc lock ob clusters",
"downstreams": [114077],
"id": 114074,
"name": "Mc lock ob clusters",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 12,
"status": "READY",
"taskId": 98021,
"timeout": 60,
"upstreams": []
},
{
"description": "Update observer status",
"downstreams": [114051],
"id": 114059,
"name": "Update observer status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 10,
"status": "PENDING",
"taskId": 98021,
"timeout": 300,
"upstreams": [114063]
},
{
"description": "Wait node",
"downstreams": [114053],
"id": 114068,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 27,
"status": "PENDING",
"taskId": 98021,
"timeout": 30,
"upstreams": [114071]
},
{
"description": "Mc unlock ob clusters",
"downstreams": [],
"id": 114064,
"name": "Mc unlock ob clusters",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 6,
"status": "PENDING",
"taskId": 98021,
"timeout": 60,
"upstreams": [114054]
}],
"taskDefinitionId": -1,
"type": "MANUAL"
},
"duration": 109,
"server": "5e11a5f435",
"status": 200,
"successful": true,
"timestamp": "2025-12-23T10:43:43.422761994+08:00",
"traceId": "ba1b5238154c565a"
}