Modifying the Name of a Specified Source Server
Function
This API is used to modify the name of a source server displayed on the SMS console to facilitate source server management.
Calling Method
For details, see Calling APIs.
URI
PUT /v3/sources/{source_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
source_id |
Yes |
String |
The ID of the source server in SMS. Minimum length: 0 characters Maximum length: 255 characters |
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 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
No |
String |
The new name of the source server. Minimum length: 0 characters Maximum length: 255 characters |
|
migprojectid |
No |
String |
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 |
The disk information. Array length: 0 to 65,535 |
|
volume_groups |
No |
Array of PutVolumeGroups objects |
The volume group information. Array length: 0 to 65,535 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
need_migration |
No |
Boolean |
The disk name. Default value: true |
|
id |
Yes |
String |
The disk ID. Minimum length: 0 characters Maximum length: 255 characters |
|
adjust_size |
Yes |
Long |
The new size. Minimum value: 0 Maximum value: 9223372036854775807 Default value: 0 |
|
physical_volumes |
No |
Array of PutVolume objects |
The modified volume information. Array length: 0 to 65,535 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
No |
String |
The database record ID. Minimum length: 0 characters Maximum length: 255 characters |
|
need_migration |
No |
Boolean |
Indicates whether the volume needs to be migrated. Default value: true |
|
adjust_size |
No |
Long |
The new size. Minimum value: 0 Maximum value: 9223372036854775807 Default value: 0 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
logical_volumes |
No |
Array of PutLogicalVolume objects |
The logical volume information. Array length: 0 to 65,535 |
|
id |
Yes |
String |
The volume group ID. Minimum length: 0 characters Maximum length: 255 characters |
|
need_migration |
No |
Boolean |
Indicates whether the volume needs to be migrated. Default value: true |
|
adjust_size |
No |
Long |
The new size. Minimum value: 0 Maximum value: 9223372036854775807 Default value: 0 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
Yes |
String |
The logical volume ID. Minimum length: 0 characters Maximum length: 255 characters |
|
need_migration |
No |
Boolean |
Indicates whether the volume needs to be migrated. Default value: true |
|
adjust_size |
No |
Long |
The new size. Minimum value: 0 Maximum value: 9223372036854775807 Default value: 0 |
Response
Status code: 200
OK
None
Example Request
This example changes the name of source server 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
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.
