Updating a Template
Function
This API is used to modify a template.
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:template:update
Write
template *
-
- sms:server:migrationServer
-
URI
PUT /v3/vm/templates/{id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
Yes |
String |
The ID of the template to be modified. |
Request
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
X-Auth-Token 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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
template |
No |
TemplateRequest object |
The template information. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
Yes |
String |
The template name. |
|
is_template |
Yes |
Boolean |
Specifies whether the template is general. If the template is associated with a task, the template is not a general template. |
|
region |
Yes |
String |
The region. |
|
projectid |
Yes |
String |
The project ID. |
|
target_server_name |
No |
String |
The server name. |
|
availability_zone |
No |
String |
The AZ. |
|
volumetype |
No |
String |
The disk type. SAS: serial attached SCSI SSD: solid-state drive SATA: serial advanced technology attachment The value can be: |
|
flavor |
No |
String |
The server flavor. |
|
vpc |
No |
VpcObject object |
The VPC information. |
|
nics |
No |
Array of Nics objects |
The NIC information. Multiple NICs are supported. To let the system automatically add a NIC, configure only one NIC entry and set the ID to autoCreate. |
|
security_groups |
No |
Array of SgObject objects |
The security group information. Multiple security groups are supported. To let the system automatically create a security group, configure only one security group record and set the ID to autoCreate. |
|
publicip |
No |
PublicIp object |
The public IP address information. |
|
disk |
No |
Array of TemplateDisk objects |
The disk information. |
|
data_volume_type |
No |
String |
The data disk type. SAS: serial attached SCSI SSD: solid-state drive SATA: serial advanced technology attachment The value can be: |
|
target_password |
No |
String |
The server login password. |
|
image_id |
No |
String |
The ID of the image for server creation. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
Yes |
String |
The VPC ID. To let the system automatically create a VPC, set this parameter to autoCreate. |
|
name |
Yes |
String |
The VPC name. |
|
cidr |
No |
String |
The VPC CIDR block. The default value is 192.168.0.0/16. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
Yes |
String |
The subnet ID. To let the system automatically create a subnet, set this parameter to autoCreate. |
|
name |
Yes |
String |
The subnet name. |
|
cidr |
Yes |
String |
The subnet gateway/mask. |
|
ip |
No |
String |
The server IP address. If this parameter is not specified, the system will automatically assign an IP address. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
Yes |
String |
The security group ID. |
|
name |
Yes |
String |
The security group name. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
type |
Yes |
String |
The EIP type. The default value is 5_bgp. |
|
bandwidth_size |
Yes |
Integer |
The bandwidth size in Mbit/s. The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 to 300 Mbit/s. The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1,000 Mbit/s. The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1,000 Mbit/s. Range 1 to 2000 |
|
bandwidth_share_type |
No |
String |
The bandwidth type, shared or dedicated. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
No |
Long |
The disk ID. Range 0 to 9223372036854775807 |
|
index |
Yes |
Integer |
The disk serial number, starting from 0. Range 0 to 2147483647 |
|
name |
Yes |
String |
The disk name. |
|
disktype |
Yes |
String |
The disk type. The value is the same as that of volumetype. |
|
size |
Yes |
Long |
The disk size in GB. Range 0 to 9223372036854775807 |
|
device_use |
No |
String |
The used disk space. |
Response
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
- |
String |
The template was modified. |
Status code: 403
|
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. |
Example Request
This example changes the name of the template whose ID is dfbdd142-985f-4a4f-93e1-c535b46bxxxx to test1025 and its project ID to 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
} ]
}
}
Example Response
Status code: 200
The template was modified.
{ }
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 template whose ID is dfbdd142-985f-4a4f-93e1-c535b46bxxxx to test1025 and its project ID to 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 88 |
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(); request.withId("{id}"); 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()); } } } |
This example changes the name of the template whose ID is dfbdd142-985f-4a4f-93e1-c535b46bxxxx to test1025 and its project ID to 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 |
# 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() request.id = "{id}" 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) |
This example changes the name of the template whose ID is dfbdd142-985f-4a4f-93e1-c535b46bxxxx to test1025 and its project ID to 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 |
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{} request.Id = "{id}" 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) } } |
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 template was modified. |
|
403 |
Authentication failed. |
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