Description
You can call this operation to batch stop basic OCP Agent processes on a host.
Call description
Prerequisite
You have the HOST_MANAGER permissions.
Request path
POST /compute/hosts/batchStopAgents
Request parameters
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| hostIds | LongArray | Yes | [1001,1002] | The list of host IDs. |
Response parameters
Parameter |
Type |
Description |
|---|---|---|
| data | Object | The information about the asynchronous task. |
| successful | Boolean | Indicates 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. This trace ID is used for troubleshooting. |
| server | String | The address of the application server that responded to the request. |
Examples
Sample request
POST /compute/hosts/batchStopAgents
{
"hostIds": [2]
}
Sample response
{
"data": {
"context": {
"listMap": {
"host_ids": [
"2"
]
},
"parallel": false,
"parallelIdx": -1,
"stringMap": {
"prohibit_rollback": "false"
}
},
"creator": "admin",
"executor": "xxx.xxx.xxx.xxx",
"id": 31173,
"name": "Batch stop OCP agent",
"operation": "EXECUTE",
"startTime": "2021-09-03T15:01:10.636+08:00",
"status": "RUNNING",
"subtasks": [
{
"className": "com.alipay.ocp.service.task.business.WaitNode",
"description": "Wait node",
"downstreams": [
32855
],
"id": 32854,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 1,
"status": "PENDING",
"timeout": 30,
"upstreams": [
32857
]
},
{
"className": "com.alipay.ocp.service.task.business.WaitNode",
"description": "Wait node",
"downstreams": [
32857
],
"id": 32856,
"name": "Wait node",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 0,
"status": "PENDING",
"timeout": 30,
"upstreams": [
32858
]
},
{
"className": "com.alipay.ocp.service.task.business.obagent.PrepareStopOcpAgentTask",
"description": "Prepare stop OCP agent",
"downstreams": [
32856
],
"id": 32858,
"name": "Prepare stop OCP agent",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 4,
"status": "READY",
"timeout": 60,
"upstreams": []
},
{
"className": "com.alipay.ocp.service.task.business.obagent.StopAllOcpAgentProcessesTask",
"description": "Stop all OCP agent processes",
"downstreams": [
32854
],
"id": 32857,
"name": "Stop all OCP agent processes",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 3,
"status": "PENDING",
"timeout": 600,
"upstreams": [
32856
]
},
{
"className": "com.alipay.ocp.service.task.business.obagent.FinishOcpAgentOperationTask",
"description": "Finish OCP agent operation",
"downstreams": [],
"id": 32855,
"name": "Finish OCP agent operation",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": 0,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 2,
"status": "PENDING",
"timeout": 60,
"upstreams": [
32854
]
}
],
"taskDefinitionId": -1,
"type": "MANUAL"
},
"duration": 40,
"server": "xxx.xxx.xxx.xxx",
"status": 200,
"successful": true,
"timestamp": "2021-09-03T15:01:10.645+08:00",
"traceId": "688d3147a10b45e8"
}