Description
This topic describes how to batch stop the OCP Agent processes of hosts.
API call instructions
API constraints
The caller must have the management permissions on the host.
Request path
POST /compute/hosts/batchStopAgents
Request parameters
body:
Parameter |
Type |
Required |
Example Value |
Description |
|---|---|---|---|---|
| hostIds | LongArray | Yes | [1001,1002] | The list of host IDs. |
Return result
Parameter |
Type |
Description |
|---|---|---|
| data | Object | Asynchronous task information. |
| successful | Boolean | Indicates whether the request is successful. |
| timestamp | Datetime | The timestamp when the server finishes the request. |
| duration | Integer | The time taken by the server to process the request, in milliseconds. |
| status | Integer | The HTTP status code that conforms to the HTTP status code specification. |
| traceId | String | The Trace ID of the request, which is used to troubleshoot problems. |
| server | String | The address of the application service that responds to the request. |
Examples
Request example
POST /compute/hosts/batchStopAgents
{
"hostIds": [2]
}
Return example
{
"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": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-03T15:01:10.645+08:00",
"traceId": "688d3147a10b45e8"
}