# 修改指定ID的源端服务器信息 - UpdateServerName #### 功能介绍 该功能用来修改SMS服务端的源端信息，方便用户对源端进行管理。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-sms/sms_api_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-sms/sms_api_8001.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | sms:server:update | Write | server \* | - | sms:server:migrationServer | - | | sms:server:update | Write | - | g:EnterpriseProjectId | sms:server:migrationServer | - | #### URI PUT /v3/sources/{source_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | source_id | 是 | String | 源端服务器在主机迁移服务中的ID 最小长度：**1** 最大长度：**36** | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度：**1** 最大长度：**16384** | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | 源端服务器修改后的名字 最小长度：**0** 最大长度：**255** | | migprojectid | 否 | String | 源端服务器修改后所属的迁移项目ID 最小长度：**0** 最大长度：**255** | | disks | 否 | Array of [PutDisk] objects | 磁盘，仅在"待配置目的端"状态下，此修改才生效 数组长度：**0 - 65535** | | volume_groups | 否 | Array of [PutVolumeGroups] objects | 卷组，仅在"待配置目的端"状态下，此修改才生效 数组长度：**0 - 65535** | 表4PutDisk | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | need_migration | 否 | Boolean | 磁盘名称 缺省值：**true** | | id | 否 | String | 磁盘ID 最小长度：**0** 最大长度：**255** | | adjust_size | 否 | Long | 调整大小 最小值：**0** 最大值：**9223372036854775807** 缺省值：**0** | | physical_volumes | 否 | Array of [PutVolume] objects | 修改的卷信息 数组长度：**0 - 65535** | 表5PutVolume | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | 数据库ID 最小长度：**0** 最大长度：**255** | | need_migration | 否 | Boolean | 是否迁移 缺省值：**true** | | adjust_size | 否 | Long | 调整大小 最小值：**0** 最大值：**9223372036854775807** 缺省值：**0** | 表6PutVolumeGroups | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | logical_volumes | 否 | Array of [PutLogicalVolume] objects | lv信息 数组长度：**0 - 65535** | | id | 否 | String | 卷组ID 最小长度：**0** 最大长度：**255** | | need_migration | 否 | Boolean | 是否迁移 缺省值：**true** | | adjust_size | 否 | Long | 调整大小 最小值：**0** 最大值：**9223372036854775807** 缺省值：**0** | 表7PutLogicalVolume | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | 逻辑卷ID 最小长度：**0** 最大长度：**255** | | need_migration | 否 | Boolean | 是否迁移 缺省值：**true** | | adjust_size | 否 | Long | 调整大小 最小值：**0** 最大值：**9223372036854775807** 缺省值：**0** | #### 响应参数 **状态码：200** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 修改指定ID的源端服务器信息成功 | **状态码：403** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误代码 最小长度：**0** 最大长度：**255** | | error_msg | String | 错误信息 最小长度：**0** 最大长度：**255** | | encoded_authorization_message | String | 加密授权信息 最小长度：**0** 最大长度：**65535** | | error_param | Array of strings | 错误参数 最小长度：**0** 最大长度：**65535** 数组长度：**1 - 20** | | details | Array of [details] objects | 详细错误信息 数组长度：**1 - 20** | 表10details | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | SMS错误代码 最小长度：**0** 最大长度：**65535** | | error_msg | String | SMS错误信息 最小长度：**0** 最大长度：**65535** | #### 请求示例 修改ID为dcdbe339-b02d-4578-95a1-9c9c547dxxxx的源端服务器的名称为abcd ``` PUT https://{endpoint}/v3/sources/dcdbe339-b02d-4578-95a1-9c9c547dxxxx { "name" : "abcd" } ``` #### 响应示例 **状态码：200** 修改指定ID的源端服务器信息成功 ``` { } ``` **状态码：403** 鉴权失败 ``` { "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代码示例 SDK代码示例如下。 - [Java] 修改ID为dcdbe339-b02d-4578-95a1-9c9c547dxxxx的源端服务器的名称为abcd ``` 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("")) .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()); } } } ``` - [Python] 修改ID为dcdbe339-b02d-4578-95a1-9c9c547dxxxx的源端服务器的名称为abcd ``` # 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("")) \ .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) ``` - [Go] 修改ID为dcdbe339-b02d-4578-95a1-9c9c547dxxxx的源端服务器的名称为abcd ``` 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, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := sms.SmsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := sms.NewSmsClient(hcClient) 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) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SMS/sdk?api=UpdateServerName)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 修改指定ID的源端服务器信息成功 | | 403 | 鉴权失败 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-sms/ErrorCode.html)。