Obtaining a Summary of Source Servers
Function
This API is used to obtain a summary of source servers.
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. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. 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 a waiting migration status. Minimum value: 0 Maximum value: 1000 |
replicating |
Integer |
The number of servers that are in a replicating migration status. Minimum value: 0 Maximum value: 1000 |
syncing |
Integer |
The number of servers that are in a synchronizing migration status. Minimum value: 0 Maximum value: 1000 |
other |
Integer |
The number of servers in other statuses. Minimum value: 0 Maximum value: 1000 |
Example Request
This example queries a summary of source 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
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.