Modifying Source Server Information

Function

This API is used to modify the information of a source server in SMS to facilitate server management.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/sources/{source_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
source_id	Yes	String	The ID of the source server in SMS. Minimum: 1 Maximum: 36

Request Parameters

**Table 2** 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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	No	String	The new name of the source server. Minimum: 0 Maximum: 255
migprojectid	No	String	The ID of the migration project to which the source server belongs after the modification. Minimum: 0 Maximum: 255
disks	No	Array of PutDisk objects	The modification on the disk takes effect only when the target end is in the waiting state. Array Length: 0 - 65535
volume_groups	No	Array of PutVolumeGroups objects	The modification on the volume group takes effect only when the target end is in the waiting state. Array Length: 0 - 65535

**Table 4** PutDisk
Parameter	Mandatory	Type	Description
need_migration	No	Boolean	The disk name. Default: true
id	No	String	The disk ID. Minimum: 0 Maximum: 255
adjust_size	No	Long	The new size. Minimum: 0 Maximum: 9223372036854775807 Default: 0
physical_volumes	No	Array of PutVolume objects	The updated volume information. Array Length: 0 - 65535

**Table 5** PutVolume
Parameter	Mandatory	Type	Description
id	No	String	The database record ID. Minimum: 0 Maximum: 255
need_migration	No	Boolean	Indicates whether it needs to be migrated. Default: true
adjust_size	No	Long	The new size. Minimum: 0 Maximum: 9223372036854775807 Default: 0

**Table 6** PutVolumeGroups
Parameter	Mandatory	Type	Description
logical_volumes	No	Array of PutLogicalVolume objects	The logical volume information. Array Length: 0 - 65535
id	No	String	The volume group ID. Minimum: 0 Maximum: 255
need_migration	No	Boolean	Indicates whether it needs to be migrated. Default: true
adjust_size	No	Long	The new size. Minimum: 0 Maximum: 9223372036854775807 Default: 0

**Table 7** PutLogicalVolume
Parameter	Mandatory	Type	Description
id	No	String	The logical volume ID. Minimum: 0 Maximum: 255
need_migration	No	Boolean	Indicates whether it needs to be migrated. Default: true
adjust_size	No	Long	The new size. Minimum: 0 Maximum: 9223372036854775807 Default: 0

Response Parameters

Status code: 200

**Table 8** Response body parameters
Parameter	Type	Description
-	String	The information about the source server with a specified ID was modified successfully.

Status code: 403

**Table 9** 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 10** 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 changes the name of the source server whose ID is dcdbe339-b02d-4578-95a1-9c9c547dxxxx to abcd.

PUT https://{endpoint}/v3/sources/dcdbe339-b02d-4578-95a1-9c9c547dxxxx

{
  "name" : "abcd"
}

Example Responses

Status code: 200

The information about the source server with a specified ID was modified successfully.

{ }

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