Updated on 2022-08-05 GMT+08:00

Obtaining Source Server Overview

Function

This API is used to obtain server overview.

URI

GET /v3/sources/overview

Request

Table 1 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1 character

Maximum length: 16,384 characters

Response

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

waiting

Integer

Specifies the number of servers that are in the waiting status.

Minimum value: 0

Maximum value: 1000

replicating

Integer

Specifies the number of servers that are in the replicating status.

Minimum value: 0

Maximum value: 1000

syncing

Integer

Specifies the number of servers that are in the synchronizing status.

Minimum value: 0

Maximum value: 1000

other

Integer

Specifies the number of servers in other statuses.

Minimum value: 0

Maximum value: 1000

Example Request

Query the overview of servers.

GET https://{endpoint}/v3/sources/overview

Example Response

Status code: 200

OK

{
  "waiting" : 5,
  "replicating" : 6,
  "syncing" : 3,
  "other" : 2
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.