Obtaining the Summary of Source Servers

Function

This API is used to obtain the summary of source servers.

Calling Method

For details, see Calling APIs.

URI

GET /v3/sources/overview

Request

**Table 1** Request header parameter
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

**Table 2** Response body parameters
Parameter	Type	Description
waiting	Integer	The number of servers that are in a waiting migration status. Minimum value: 0 Maximum value: 1000
replicate	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
stopped	Integer	The number of servers that are in a paused migration status. Minimum value: 0 Maximum value: 1000
deleting	Integer	The number of servers that are in a deleting migration status. Minimum value: 0 Maximum value: 1000
cutovering	Integer	The number of servers whose paired target servers are being launched. Minimum value: 0 Maximum value: 1000
unavailable	Integer	The number of servers that fail the environment check. Minimum value: 0 Maximum value: 1000
stopping	Integer	The number of servers that are in a pausing migration status. Minimum value: 0 Maximum value: 1000
finished	Integer	The number of servers whose paired target servers have been launched. Minimum value: 0 Maximum value: 1000
initialize	Integer	The number of servers that are in an initializing migration status. Minimum value: 0 Maximum value: 1000
error	Integer	The number of servers that are in an error migration status. Minimum value: 0 Maximum value: 1000
cloning	Integer	The number of servers whose paired target servers are being cloned. Minimum value: 0 Maximum value: 1000
unconfigured	Integer	The number of servers that do not have target server configurations. Minimum value: 0 Maximum value: 1000

Status code: 403

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum length: 0 characters Maximum length: 255 characters
error_msg	String	The error message. Minimum length: 0 characters Maximum length: 255 characters
encoded_authorization_message	String	Encrypted authorization information. Minimum length: 0 characters Maximum length: 65,535 characters
error_param	Array of strings	Invalid parameter. Minimum length: 0 characters Maximum length: 65,535 characters Array length: 1 to 20
details	Array of details objects	The error message. Array length: 1 to 20

**Table 4** details
Parameter	Type	Description
error_code	String	The SMS error code. Minimum length: 0 characters Maximum length: 65,535 characters
error_msg	String	The SMS error message. Minimum length: 0 characters Maximum length: 65,535 characters

Example Request

Query the overview of servers.

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

Example Response

Status code: 200

The summary of source servers was obtained.

{
  "replicate" : 0,
  "stopped" : 0,
  "unconfigured" : 13,
  "waiting" : 0,
  "syncing" : 0,
  "unavailable" : 0,
  "cutovering" : 0,
  "finished" : 6,
  "error" : 3,
  "deleting" : 1,
  "stopping" : 1,
  "initialize" : 0,
  "cloning" : 0
}

Status code: 403

Authentication failed.

{
  "error_code" : "SMS.9004",
  "error_msg" : "The current account does not have the permission to execute policy You do not have permission to perform action XXX on resource XXX.",
  "encoded_authorization_message" : "XXXXXX",
  "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
  "details" : [ {
    "error_code" : "SMS.9004",
    "error_msg" : "You do not have permission to perform action XXX on resource XXX."
  } ]
}