Modifying a Source Server Name
Function
This API is used to modify the source name of the source server on the SMS server so that users can manage the source servers through SMS.
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 displayed on the SMS console. 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 characters |
volume_groups |
No |
Array of PutVolumeGroups objects |
The volume group information. Array length: 0 to 65,535 characters |
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 information about the volume to be modified. Array length: 0 to 65,535 characters |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
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 |
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 characters |
id |
Yes |
String |
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 |
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 |
Specifies 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
None
Example Request
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 Response
None
SDK Sample Code
The sample code is as follows.
This example changes the name of the source server whose ID is dcdbe339-b02d-4578-95a1-9c9c547dxxxx to abcd.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.sms.v3.region.SmsRegion; import com.huaweicloud.sdk.sms.v3.*; import com.huaweicloud.sdk.sms.v3.model.*; public class UpdateServerNameSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); SmsClient client = SmsClient.newBuilder() .withCredential(auth) .withRegion(SmsRegion.valueOf("<YOUR REGION>")) .build(); UpdateServerNameRequest request = new UpdateServerNameRequest(); PutSourceServerBody body = new PutSourceServerBody(); body.withName("abcd"); request.withBody(body); try { UpdateServerNameResponse response = client.updateServerName(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
This example changes the name of the source server whose ID is dcdbe339-b02d-4578-95a1-9c9c547dxxxx to abcd.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdksms.v3.region.sms_region import SmsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksms.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = SmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(SmsRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateServerNameRequest() request.body = PutSourceServerBody( name="abcd" ) response = client.update_server_name(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
This example changes the name of the source server whose ID is dcdbe339-b02d-4578-95a1-9c9c547dxxxx to abcd.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" sms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := sms.NewSmsClient( sms.SmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateServerNameRequest{} namePutSourceServerBody:= "abcd" request.Body = &model.PutSourceServerBody{ Name: &namePutSourceServerBody, } response, err := client.UpdateServerName(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For more SDK sample code of programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Response returned. |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot