Skip to main content

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

ParameterNameParameter DescriptionRequestTypeWhether RequiredDataType
clusterIdCluster IDBodyTrueLong
workersList of machines to operateBodyTrueList

Workers Parameter Description

ParameterNameParameter DescriptionRequestTypeWhether RequiredDataType
workerIdMachine IDBodyTrueLong
cloudOrIdcNameCloud service provider or IDC nameBodyTrueString
actionTypeAction typeBodyTrueString
remoteUserRemote user nameBodyFalseString
remotePasswordRemote passwordBodyFalseString

Public Response Results

ParameterNameParameter DescriptionType(Java)NotNull
code1: Success
0: Failure
StringTrue
dataObjectFalse
msgStringFalse
requestIdStringTrue

Response Example

{
"requestId": "89a71b85-2cb7-11ec-a410-1100c6102ca7",
"code": "1",
"msg": "request success",
"data": null
}