修改模板信息
功能介绍
修改源端模板信息。
调用方法
请参见如何调用API。
URI
PUT /v3/vm/templates/{id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
需要修改信息的模板的ID 最小长度:0 最大长度:255 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
X-Auth-Token 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:16384 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
template |
否 |
TemplateRequest object |
模板信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
模板名称 最小长度:0 最大长度:255 |
is_template |
是 |
Boolean |
是否是通用模板,如果模板关联一个任务,则不算通用模板 |
region |
是 |
String |
Region信息 最小长度:0 最大长度:255 |
projectid |
是 |
String |
项目ID 最小长度:0 最大长度:255 |
target_server_name |
否 |
String |
目标端服务器名称 最小长度:0 最大长度:255 |
availability_zone |
否 |
String |
可用区 最小长度:0 最大长度:255 |
volumetype |
否 |
String |
磁盘类型 SAS:串行连接SCSI SSD:固态硬盘 SATA:串口硬盘 枚举值:
|
flavor |
否 |
String |
虚拟机规格 最小长度:0 最大长度:65535 |
vpc |
否 |
VpcObject object |
vpc对象 |
nics |
否 |
Array of Nics objects |
网卡信息,支持多个网卡,如果是自动创建,只填一个,ID使用“autoCreate” 数组长度:0 - 65535 |
security_groups |
否 |
Array of SgObject objects |
安全组,支持多个安全组,如果是自动创建,只填一个,ID使用“autoCreate” 数组长度:0 - 65535 |
publicip |
否 |
PublicIp object |
公网ip |
disk |
否 |
Array of TemplateDisk objects |
磁盘信息 数组长度:0 - 65535 |
data_volume_type |
否 |
String |
数据盘磁盘类型 SAS:串行连接SCSI SSD:固态硬盘 SATA:串口硬盘 枚举值:
|
target_password |
否 |
String |
目的端密码 最小长度:0 最大长度:1024 |
image_id |
否 |
String |
新建目的虚拟机用户选择的镜像版本Id值 最小长度:0 最大长度:255 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
虚拟私有云ID,如果是自动创建,填“autoCreate” 最小长度:1 最大长度:255 |
name |
是 |
String |
虚拟私有云名称 最小长度:1 最大长度:255 |
cidr |
否 |
String |
VPC的网段,默认192.168.0.0/16 最小长度:1 最大长度:255 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
子网ID,如果是自动创建,使用"autoCreate" 最小长度:0 最大长度:255 |
name |
是 |
String |
子网名称 最小长度:0 最大长度:255 |
cidr |
是 |
String |
子网网关/掩码 最小长度:0 最大长度:255 |
ip |
否 |
String |
虚拟机IP地址,如果没有这个字段,自动分配IP 最小长度:0 最大长度:255 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
是 |
String |
弹性公网IP类型,默认为5_bgp 最小长度:0 最大长度:255 |
bandwidth_size |
是 |
Integer |
带宽大小,单位:Mbit/s。 调整带宽时的最小单位会根据带宽范围不同存在差异。 小于等于300Mbit/s,默认最小单位为1Mbit/s。300Mbit/s~1000Mbit/s,默认最小单位为50Mbit/s。大于1000Mbit/s:默认最小单位为500Mbit/s。 最小值:1 最大值:2000 |
bandwidth_share_type |
否 |
String |
带宽共享类型 最小长度:0 最大长度:255 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
Long |
磁盘ID 最小值:0 最大值:9223372036854775807 |
index |
是 |
Integer |
磁盘序号,从0开始 最小值:0 最大值:2147483647 |
name |
是 |
String |
磁盘名称 最小长度:0 最大长度:255 |
disktype |
是 |
String |
磁盘类型,同volumetype字段 最小长度:0 最大长度:255 |
size |
是 |
Long |
磁盘大小,单位:GB 最小值:0 最大值:9223372036854775807 |
device_use |
否 |
String |
磁盘使用 最小长度:0 最大长度:255 |
响应参数
无
请求示例
修改源端模板信息,修改ID为dfbdd142-985f-4a4f-93e1-c535b46bxxxx的模板的模板名称为test1025,projectid为00924d0ad2df4f21ac476dd9f3288xxxx
PUT https://{endpoint}/v3/vm/templates/dfbdd142-985f-4a4f-93e1-c535b46bxxxx { "template" : { "name" : "test1025", "is_template" : false, "region" : "region", "projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001", "vpc" : { "id" : "autoCreate", "name" : "autoCreate" }, "nics" : [ { "id" : "autoCreate", "name" : "autoCreate", "cidr" : "192.168.0.0/24" } ], "security_groups" : [ { "id" : "autoCreate", "name" : "autoCreate" } ], "publicip" : { "type" : "5_bgp", "bandwidth_size" : 1 }, "disk" : [ { "index" : 0, "name" : "index1", "disktype" : "type", "size" : 111 } ] } }
响应示例
无
SDK代码示例
SDK代码示例如下。
修改源端模板信息,修改ID为dfbdd142-985f-4a4f-93e1-c535b46bxxxx的模板的模板名称为test1025,projectid为00924d0ad2df4f21ac476dd9f3288xxxx
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 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
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.*; import java.util.List; import java.util.ArrayList; public class UpdateTemplateSolution { 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(); UpdateTemplateRequest request = new UpdateTemplateRequest(); UpdateTemplateReq body = new UpdateTemplateReq(); List<TemplateDisk> listTemplateDisk = new ArrayList<>(); listTemplateDisk.add( new TemplateDisk() .withIndex(0) .withName("index1") .withDisktype("type") .withSize(111L) ); PublicIp publicipTemplate = new PublicIp(); publicipTemplate.withType("5_bgp") .withBandwidthSize(1); List<SgObject> listTemplateSecurityGroups = new ArrayList<>(); listTemplateSecurityGroups.add( new SgObject() .withId("autoCreate") .withName("autoCreate") ); List<Nics> listTemplateNics = new ArrayList<>(); listTemplateNics.add( new Nics() .withId("autoCreate") .withName("autoCreate") .withCidr("192.168.0.0/24") ); VpcObject vpcTemplate = new VpcObject(); vpcTemplate.withId("autoCreate") .withName("autoCreate"); TemplateRequest templatebody = new TemplateRequest(); templatebody.withName("test1025") .withIsTemplate(false) .withRegion("region") .withProjectid("xxxxxxxxxxxxxxxxxxxxxxxx00000001") .withVpc(vpcTemplate) .withNics(listTemplateNics) .withSecurityGroups(listTemplateSecurityGroups) .withPublicip(publicipTemplate) .withDisk(listTemplateDisk); body.withTemplate(templatebody); request.withBody(body); try { UpdateTemplateResponse response = client.updateTemplate(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()); } } } |
修改源端模板信息,修改ID为dfbdd142-985f-4a4f-93e1-c535b46bxxxx的模板的模板名称为test1025,projectid为00924d0ad2df4f21ac476dd9f3288xxxx
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 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
# 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 = UpdateTemplateRequest() listDiskTemplate = [ TemplateDisk( index=0, name="index1", disktype="type", size=111 ) ] publicipTemplate = PublicIp( type="5_bgp", bandwidth_size=1 ) listSecurityGroupsTemplate = [ SgObject( id="autoCreate", name="autoCreate" ) ] listNicsTemplate = [ Nics( id="autoCreate", name="autoCreate", cidr="192.168.0.0/24" ) ] vpcTemplate = VpcObject( id="autoCreate", name="autoCreate" ) templatebody = TemplateRequest( name="test1025", is_template=False, region="region", projectid="xxxxxxxxxxxxxxxxxxxxxxxx00000001", vpc=vpcTemplate, nics=listNicsTemplate, security_groups=listSecurityGroupsTemplate, publicip=publicipTemplate, disk=listDiskTemplate ) request.body = UpdateTemplateReq( template=templatebody ) response = client.update_template(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
修改源端模板信息,修改ID为dfbdd142-985f-4a4f-93e1-c535b46bxxxx的模板的模板名称为test1025,projectid为00924d0ad2df4f21ac476dd9f3288xxxx
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 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
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.UpdateTemplateRequest{} var listDiskTemplate = []model.TemplateDisk{ { Index: int32(0), Name: "index1", Disktype: "type", Size: int64(111), }, } publicipTemplate := &model.PublicIp{ Type: "5_bgp", BandwidthSize: int32(1), } var listSecurityGroupsTemplate = []model.SgObject{ { Id: "autoCreate", Name: "autoCreate", }, } var listNicsTemplate = []model.Nics{ { Id: "autoCreate", Name: "autoCreate", Cidr: "192.168.0.0/24", }, } vpcTemplate := &model.VpcObject{ Id: "autoCreate", Name: "autoCreate", } templatebody := &model.TemplateRequest{ Name: "test1025", IsTemplate: false, Region: "region", Projectid: "xxxxxxxxxxxxxxxxxxxxxxxx00000001", Vpc: vpcTemplate, Nics: &listNicsTemplate, SecurityGroups: &listSecurityGroupsTemplate, Publicip: publicipTemplate, Disk: &listDiskTemplate, } request.Body = &model.UpdateTemplateReq{ Template: templatebody, } response, err := client.UpdateTemplate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。