Description
You can call this operation to restart the OCP Agent process on a host.
Call description
Prerequisite
You have the HOST_MANAGER permissions.
Request path
POST /compute/hosts/{hostId}/agent/restart
Request parameters
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| hostId | Long | Yes | 100 | The ID of the host. |
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/2/agent/restart
Sample response
{
"data": {
"context": {
"listMap": {},
"parallel": false,
"parallelIdx": -1,
"stringMap": {
"prohibit_rollback": "false",
"host_id": "2"
}
},
"creator": "admin",
"executor": "xxx.xxx.xxx.xxx",
"hostId": 2,
"id": 30208,
"name": "Restart OCP agent",
"operation": "EXECUTE",
"startTime": "2021-09-03T14:17:06.328+08:00",
"status": "RUNNING",
"subtasks": [
{
"className": "com.alipay.ocp.service.task.business.obagent.RestartPosProxyTask",
"description": "Restart pos proxy",
"downstreams": [
31816
],
"id": 31813,
"name": "Restart pos proxy",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 0,
"status": "PENDING",
"timeout": 60,
"upstreams": [
31817
]
},
{
"className": "com.alipay.ocp.service.task.business.obagent.StopAllOcpAgentProcessesTask",
"description": "Stop all OCP agent processes",
"downstreams": [
31814
],
"id": 31816,
"name": "Stop all OCP agent processes",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 4,
"status": "PENDING",
"timeout": 600,
"upstreams": [
31813
]
},
{
"className": "com.alipay.ocp.service.task.business.obagent.StartAllOcpAgentProcessesTask",
"description": "Start all OCP agent processes",
"downstreams": [
31815
],
"id": 31814,
"name": "Start all OCP agent processes",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 1,
"status": "PENDING",
"timeout": 600,
"upstreams": [
31816
]
},
{
"className": "com.alipay.ocp.service.task.business.obagent.FinishOcpAgentOperationTask",
"description": "Finish OCP agent operation",
"downstreams": [],
"id": 31815,
"name": "Finish OCP agent operation",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 3,
"status": "PENDING",
"timeout": 60,
"upstreams": [
31814
]
},
{
"className": "com.alipay.ocp.service.task.business.obagent.PrepareRestartOcpAgentTask",
"description": "Prepare restart OCP agent",
"downstreams": [
31813
],
"id": 31817,
"name": "Prepare restart OCP agent",
"nodeType": "JAVA_TASK",
"operation": "EXECUTE",
"parallelIdx": -1,
"prohibitRollback": false,
"runTime": 1,
"seriesId": 2,
"status": "READY",
"timeout": 60,
"upstreams": []
}
],
"taskDefinitionId": -1,
"type": "MANUAL"
},
"duration": 832,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-03T14:17:06.342+08:00",
"traceId": "deca90b54a244106"
}
