Overview
Disable 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 OCP application services.
Request path
POST /api/v2/ob/clusters/{id}/disableJvmDepsService
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 |
|---|---|---|---|---|
| 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/disableJvmDepsService
{
"restartMode":"FORCE",
"freezeServer":true
}
Response example
{
"data": {
"clusterId": 160,
"creator": "admin",
"executor": "xx.xx.xx.xx",
"id": 98016,
"name": "Disable JVM dependencies service",
"operation": "EXECUTE",
"prohibitRollback": false,
"startTime": "2025-12-23T10:37:50.421719926+08:00",
"status": "RUNNING",
"subtasks": [{
"description": "Update zone status",
"downstreams": [114038],
"id": 114029,
"name": "Update zone status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 8,
"status": "PENDING",
"taskId": 98016,
"timeout": 1800,
"upstreams": [114031]
},
{
"description": "Sync all tenant information",
"downstreams": [114026],
"id": 114035,
"name": "Sync all tenant information",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 9,
"status": "PENDING",
"taskId": 98016,
"timeout": 300,
"upstreams": [114042]
},
{
"description": "Wait node",
"downstreams": [114029],
"id": 114031,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 25,
"status": "PENDING",
"taskId": 98016,
"timeout": 30,
"upstreams": [114034]
},
{
"description": "Wait node",
"downstreams": [114042],
"id": 114038,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 12,
"status": "PENDING",
"taskId": 98016,
"timeout": 30,
"upstreams": [114029]
},
{
"description": "Wait node",
"downstreams": [114028],
"id": 114024,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 13,
"status": "PENDING",
"taskId": 98016,
"timeout": 30,
"upstreams": [114043]
},
{
"description": "Prepare disable JVM environment service",
"downstreams": [114032],
"id": 114021,
"name": "Prepare disable JVM environment service",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 3,
"status": "PENDING",
"taskId": 98016,
"timeout": 300,
"upstreams": [114040]
},
{
"description": "Wait observer accessible",
"downstreams": [114036],
"id": 114027,
"name": "Wait observer accessible",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 6,
"status": "PENDING",
"taskId": 98016,
"timeout": 1200,
"upstreams": [114023]
},
{
"description": "Sync cluster info",
"downstreams": [114035],
"id": 114042,
"name": "Sync cluster info",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 18,
"status": "PENDING",
"taskId": 98016,
"timeout": 300,
"upstreams": [114038]
},
{
"description": "Wait node",
"downstreams": [114033],
"id": 114030,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 23,
"status": "PENDING",
"taskId": 98016,
"timeout": 30,
"upstreams": [114032]
},
{
"description": "Update OB cluster status",
"downstreams": [114020],
"id": 114026,
"name": "Update OB cluster status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 4,
"status": "PENDING",
"taskId": 98016,
"timeout": 30,
"upstreams": [114035]
},
{
"description": "Wait node",
"downstreams": [114039],
"id": 114022,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 7,
"status": "PENDING",
"taskId": 98016,
"timeout": 30,
"upstreams": [114041]
},
{
"description": "Stop observer process",
"downstreams": [114044],
"id": 114019,
"name": "Stop observer process",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 17,
"status": "PENDING",
"taskId": 98016,
"timeout": 1200,
"upstreams": [114018]
},
{
"description": "Wait node",
"downstreams": [114023],
"id": 114044,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 24,
"status": "PENDING",
"taskId": 98016,
"timeout": 30,
"upstreams": [114019]
},
{
"description": "Wait node",
"downstreams": [114019],
"id": 114018,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 26,
"status": "PENDING",
"taskId": 98016,
"timeout": 30,
"upstreams": [114039]
},
{
"description": "Wait node",
"downstreams": [114041],
"id": 114037,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 10,
"status": "PENDING",
"taskId": 98016,
"timeout": 30,
"upstreams": [114025]
},
{
"description": "Prepare restart OB zone",
"downstreams": [114037],
"id": 114025,
"name": "Prepare restart OB zone",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 15,
"status": "PENDING",
"taskId": 98016,
"timeout": 1800,
"upstreams": [114033]
},
{
"description": "Active agent modules",
"downstreams": [114024],
"id": 114043,
"name": "Active agent modules",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 2,
"status": "PENDING",
"taskId": 98016,
"timeout": 1800,
"upstreams": [114036]
},
{
"description": "Mc unlock ob clusters",
"downstreams": [],
"id": 114020,
"name": "Mc unlock ob clusters",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 22,
"status": "PENDING",
"taskId": 98016,
"timeout": 60,
"upstreams": [114026]
},
{
"description": "Reset JVM environment dependency service parameters",
"downstreams": [114030],
"id": 114032,
"name": "Reset JVM environment dependency service parameters",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 11,
"status": "PENDING",
"taskId": 98016,
"timeout": 1800,
"upstreams": [114021]
},
{
"description": "Update ob cluster start time task",
"downstreams": [114034],
"id": 114028,
"name": "Update ob cluster start time task",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 14,
"status": "PENDING",
"taskId": 98016,
"timeout": 60,
"upstreams": [114024]
},
{
"description": "Update observer status",
"downstreams": [114031],
"id": 114034,
"name": "Update observer status",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 1,
"status": "PENDING",
"taskId": 98016,
"timeout": 300,
"upstreams": [114028]
},
{
"description": "Begin start JVM environment service",
"downstreams": [114025],
"id": 114033,
"name": "Begin start JVM environment service",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": true,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 21,
"status": "PENDING",
"taskId": 98016,
"timeout": 60,
"upstreams": [114030]
},
{
"description": "Inactive agent modules",
"downstreams": [114018],
"id": 114039,
"name": "Inactive agent modules",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 5,
"status": "PENDING",
"taskId": 98016,
"timeout": 3600,
"upstreams": [114022]
},
{
"description": "Start observer process",
"downstreams": [114027],
"id": 114023,
"name": "Start observer process",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 20,
"status": "PENDING",
"taskId": 98016,
"timeout": 1200,
"upstreams": [114044]
},
{
"description": "Freeze observer",
"downstreams": [114022],
"id": 114041,
"name": "Freeze observer",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 16,
"status": "PENDING",
"taskId": 98016,
"timeout": 1800,
"upstreams": [114037]
},
{
"description": "Mc lock ob clusters",
"downstreams": [114021],
"id": 114040,
"name": "Mc lock ob clusters",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 19,
"status": "READY",
"taskId": 98016,
"timeout": 60,
"upstreams": []
},
{
"description": "Wait observer active",
"downstreams": [114043],
"id": 114036,
"name": "Wait observer active",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"prohibitSkip": false,
"runTime": 1,
"seriesId": 0,
"status": "PENDING",
"taskId": 98016,
"timeout": 1800,
"upstreams": [114027]
}],
"taskDefinitionId": -1,
"type": "MANUAL"
},
"duration": 119,
"server": "5e11a5f435",
"status": 200,
"successful": true,
"timestamp": "2025-12-23T10:37:50.470994626+08:00",
"traceId": "32a2029a0431c44b"
}