Obtaining Source Server Overview
Function
Obtaining Source Server Overview
Calling Method
For details, see Calling APIs.
URI
GET /v3/sources/overview
Request
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 |
Response
Status code: 200
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 |
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 | Response returned. |
Error Codes
For details, see Error Codes.
- Function
- Calling Method
- URI
- Request
- Response
- Example Request
- Example Response
- Status Codes
- Error Codes