Add Worker

Interface Overview

Provisioning machines for task scheduling or database information retrieval purposes leveraging operational machines.

Interface Address

/cloudcanal/console/api/v1/openapi/worker/createandinstall

Request Manner

POST

Request Parameters

ParameterName	Parameter Description	RequestType	Whether Required	DataType
cloudOrIdcName	SELF_MAINTENANCE ALIBABA_CLOUD	Body	True	String
clusterId	Cluster id	Body	True	Long
region	The region where the cluster is located. hangzhou shanghai beijing shenzhen qingdao zhangjiakou huhehaote hongkong singapore silicon_valley london mq_internet_access customer	Body	True	String
executeTag	Remote execution mode DEFAULT_REMOTE	Body	True	String
remoteUser	Remote machine username	Body	False	String
remotePassword	The remote machine password.	Body	False	String
remoteIp	Machine ip	Body	False	String

Common Response Result.

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
}