Register

Description

Receives a registration request from the client in the job information subscription scenario.

If the client needs to subscribe to cluster job information, the client needs to call this API to obtain the returned UUID and then call SubscribeJobSummarySignal to obtain cluster job information.

A maximum of 20 subscribers can exist in a cluster.

Prototype

rpc Register(ClientInfo) returns (Status) {}

Input Parameters

Parameter

Type (Defined by Protobuf)

Description

ClientInfo

message ClientInfo{

string role = 1;

string clientId = 3;

}

ClientInfo.role: client role Currently, only the following client roles are supported. If other values are passed, registration will fail.

  • CCAgent
  • DefaultUser1
  • DefaultUser2
  • FdAgent

ClientInfo.clientId: client ID

Return Value

Return Value

Type (Defined by Protobuf)

Description

Status

message Status{

int32 code = 1;

string info = 2;

string clientId = 3;

}

Status.code: status code of the calling result, including:

  • 200: successful query
  • 429: rate limiting on the server
  • 500: server error

Status.info: description of the calling result

Status.clientId: returned UUID