Obtaining an Overview of Source Servers

Function

Calling Method

For details, see Calling APIs.

URI

GET /v3/sources/overview

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 1 Maximum: 16384

Response Parameters

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: 0 Maximum: 1000
replicate	Integer	The number of servers that are in a replicating migration status. Minimum: 0 Maximum: 1000
syncing	Integer	The number of servers that are in a synchronizing migration status. Minimum: 0 Maximum: 1000
stopped	Integer	The number of servers that are in a paused migration status. Minimum: 0 Maximum: 1000
deleting	Integer	The number of servers that are in a deleting migration status. Minimum: 0 Maximum: 1000
cutovering	Integer	The number of servers whose paired target servers are being launched. Minimum: 0 Maximum: 1000
unavailable	Integer	The number of servers that fail the environment check. Minimum: 0 Maximum: 1000
stopping	Integer	The number of servers that are in a stopping migration status. Minimum: 0 Maximum: 1000
skipping	Integer	The number of servers that are being skipped. Minimum: 0 Maximum: 1000
finished	Integer	The number of servers whose paired target servers have been launched. Minimum: 0 Maximum: 1000
initialize	Integer	The number of servers that are in an initializing migration status. Minimum: 0 Maximum: 1000
error	Integer	Error. Minimum: 0 Maximum: 1000
cloning	Integer	The number of servers whose paired target servers are being cloned. Minimum: 0 Maximum: 1000
unconfigured	Integer	The number of servers that do not have target server configurations. Minimum: 0 Maximum: 1000

Status code: 403

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum: 0 Maximum: 255
error_msg	String	The error message. Minimum: 0 Maximum: 255
encoded_authorization_message	String	The encrypted authorization information. Minimum: 0 Maximum: 65535
error_param	Array of strings	Error parameters. Minimum: 0 Maximum: 65535 Array Length: 1 - 20
details	Array of details objects	The error details. Array Length: 1 - 20

**Table 4** details
Parameter	Type	Description
error_code	String	The SMS error code. Minimum: 0 Maximum: 65535
error_msg	String	The SMS error message. Minimum: 0 Maximum: 65535

Example Requests

This example obtains an overview of source servers.

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

Example Responses

Status code: 200

An overview 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."
  } ]
}