Operate Worker
Interface Overview
Manipulating machines includes installing, uninstalling, upgrading, and starting the client.
Interface Address
/cloudcanal/console/api/v1/openapi/worker/operateworkersclient
Request Manner
POST
Request Parameters
| ParameterName | Parameter Description | RequestType | Whether Required | DataType |
|---|---|---|---|---|
| clusterId | Cluster ID | Body | True | Long |
| workers | List of machines to operate | Body | True | List |
Workers Parameter Description
| ParameterName | Parameter Description | RequestType | Whether Required | DataType |
|---|---|---|---|---|
| workerId | Machine ID | Body | True | Long |
| cloudOrIdcName | Cloud service provider or IDC name | Body | True | String |
| actionType | Action type | Body | True | String |
| remoteUser | Remote user name | Body | False | String |
| remotePassword | Remote password | Body | False | String |
Public Response Results
| ParameterName | Parameter Description | Type(Java) | NotNull |
|---|---|---|---|
| code | 1: Success 0: Failure | String | True |
| data | Object | False | |
| msg | String | False | |
| requestId | String | True |
Response Example
{
"requestId": "89a71b85-2cb7-11ec-a410-1100c6102ca7",
"code": "1",
"msg": "request success",
"data": null
}