Help Center/ Server Migration Service/ API Reference (Kuala Lumpur Region)/ APIs V3.0/ Source Server Management/ Modifying the Name of a Source Server with a Specified ID
Updated on 2022-08-02 GMT+08:00

Modifying the Name of a Source Server with a Specified ID

Function

This API is used to modify the name of a source server displayed on the SMS console to facilitate source server management.

URI

PUT /v3/sources/{source_id}

Table 1 Path parameter

Parameter

Mandatory

Type

Description

source_id

Yes

String

Specifies the ID of the source server displayed on the SMS console.

Minimum length: 0 characters

Maximum length: 255 characters

Request

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies 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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Specifies the new name of the source server.

Minimum length: 0 characters

Maximum length: 255 characters

migprojectid

No

String

Specifies the ID of the migration project to which the source server belongs after the modification.

Minimum length: 0 characters

Maximum length: 255 characters

disks

No

Array of PutDisk objects

Specifies the disks on the source server.

volume_groups

No

Array of PutVolumeGroups objects

Specifies the volume groups on the source server

Table 4 PutDisk field description

Parameter

Mandatory

Type

Description

need_migration

No

Boolean

Specifies the disk name.

Default value: true

id

Yes

String

Specifies the disk ID.

Minimum length: 0 characters

Maximum length: 255 characters

adjust_size

Yes

Long

Specifies the new volume size.

Minimum value: 0

Maximum value: 9223372036854775807

Default value: 0

physical_volumes

No

Array of PutVolume objects

Specifies the information about the volume to be modified.

Table 5 PutVolume field description

Parameter

Mandatory

Type

Description

id

No

String

Specifies the database ID.

Minimum length: 0 characters

Maximum length: 255 characters

need_migration

No

Boolean

Specifies whether the volume needs to be migrated.

Default value: true

adjust_size

No

Long

Specifies the new volume size.

Minimum value: 0

Maximum value: 9223372036854775807

Default value: 0

Table 6 PutVolumeGroups field description

Parameter

Mandatory

Type

Description

logical_volumes

No

Array of PutLogicalVolume objects

Specifies the logical volume information.

id

Yes

String

Specifies the volume group ID.

Minimum length: 0 characters

Maximum length: 255 characters

need_migration

No

Boolean

Specifies whether the volume needs to be migrated.

Default value: true

adjust_size

No

Long

Specifies the new volume size.

Minimum value: 0

Maximum value: 9223372036854775807

Default value: 0

Table 7 PutLogicalVolume field description

Parameter

Mandatory

Type

Description

id

Yes

String

Specifies the logical volume ID.

Minimum length: 0 characters

Maximum length: 255 characters

need_migration

No

Boolean

Specifies whether the volume needs to be migrated.

Default value: true

adjust_size

No

Long

Specifies the new volume size.

Minimum value: 0

Maximum value: 9223372036854775807

Default value: 0

Response

None

Example Request

Change the name of the source server from dcdbe339-b02d-4578-95a1-9c9c547dxxxx to abcd.

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

{
  "name" : "abcd"
}

Example Response

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.