Updated on 2025-11-11 GMT+08:00

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.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    sms:server:update

    Write

    server *

    -

    • sms:server:migrationServer

    -

    -

    g:EnterpriseProjectId

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.

Request

Table 2 Request header parameters

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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

The new name of the source server.

migprojectid

No

String

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

disks

No

Array of PutDisk objects

The disk information.

volume_groups

No

Array of PutVolumeGroups objects

The volume group information.

Table 4 PutDisk field description

Parameter

Mandatory

Type

Description

need_migration

No

Boolean

The disk name.

Default Value

true

id

Yes

String

The disk ID.

adjust_size

Yes

Long

The new size.

Range

0 to 9223372036854775807

Default Value

0

physical_volumes

No

Array of PutVolume objects

The modified volume information.

Table 5 PutVolume field description

Parameter

Mandatory

Type

Description

id

No

String

The database record ID.

need_migration

No

Boolean

Indicates whether the volume needs to be migrated.

Default Value

true

adjust_size

No

Long

The new size.

Range

0 to 9223372036854775807

Default Value

0

Table 6 PutVolumeGroups

Parameter

Mandatory

Type

Description

logical_volumes

No

Array of PutLogicalVolume objects

The logical volume information.

id

Yes

String

The volume group ID.

need_migration

No

Boolean

Indicates whether the volume needs to be migrated.

Default Value

true

adjust_size

No

Long

The new size.

Range

0 to 9223372036854775807

Default Value

0

Table 7 PutLogicalVolume field description

Parameter

Mandatory

Type

Description

id

Yes

String

The logical volume ID.

need_migration

No

Boolean

Indicates whether the volume needs to be migrated.

Default Value

true

adjust_size

No

Long

The new size.

Range

0 to 9223372036854775807

Default Value

0

Response

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.

error_msg

String

The error message.

encoded_authorization_message

String

The encrypted authorization information.

error_param

Array of strings

Invalid parameters.

details

Array of details objects

The error details.

Table 10 details field description

Parameter

Type

Description

error_code

String

The SMS error code.

error_msg

String

The SMS error message.

Example Request

This example changes the name of the source server with ID dcdbe339-b02d-4578-95a1-9c9c547dxxxx to abcd.

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

{
  "name" : "abcd"
}

Example Response

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

SDK Sample Code

The sample code is as follows.

This example changes the name of the source server with ID 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
49
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();
        request.withSourceId("{source_id}");
        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 with ID 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
# 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.source_id = "{source_id}"
        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 with ID 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
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{}
	request.SourceId = "{source_id}"
	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 SDK code examples in more programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.

Status Codes

Status Code

Description

200

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

403

Authentication failed.

Error Codes

For details, see Error Codes.