Obtaining Source Server Overview

Updated on 2024-09-04 GMT+08:00

View PDF

For details, see Calling APIs.

GET /v3/sources/overview

**Table 1** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	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

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
waiting	Integer	The number of servers that are in waiting status. Minimum value: 0 Maximum value: 1000
replicating	Integer	The number of servers that are in replicating status. Minimum value: 0 Maximum value: 1000
syncing	Integer	The number of servers that are in synchronizing status. Minimum value: 0 Maximum value: 1000
other	Integer	The number of servers in other statuses. Minimum value: 0 Maximum value: 1000

Query the overview of servers.

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

Status code: 200

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

Status Code	Description
200	Response returned.

For details, see Error Codes.

Parent topic: Source Server Management

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel