本文导读

功能介绍
调用方法
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 主机迁移服务 SMS/ API参考（吉隆坡区域）/ API v3/ 模板管理/ 修改模板信息

修改模板信息

更新时间：2025-02-13 GMT+08:00

在线调试

CLI示例

查看PDF

功能介绍

修改源端模板信息。

调用方法

请参见如何调用API。

URI

PUT /v3/vm/templates/{id}

表1 路径参数
参数	是否必选	参数类型	描述
id	是	String	需要修改信息的模板的ID 最小长度：0 最大长度：255

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	X-Auth-Token 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。最小长度：1 最大长度：16384

表3 请求Body参数
参数	是否必选	参数类型	描述
template	否	TemplateRequest object	模板信息

表4 TemplateRequest
参数	是否必选	参数类型	描述
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:串口硬盘枚举值： SAS 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:串口硬盘枚举值： SAS SSD SATA
target_password	否	String	目的端密码最小长度：0 最大长度：1024
image_id	否	String	新建目的虚拟机用户选择的镜像版本Id值最小长度：0 最大长度：255

表5 VpcObject
参数	是否必选	参数类型	描述
id	是	String	虚拟私有云ID，如果是自动创建，填“autoCreate” 最小长度：1 最大长度：255
name	是	String	虚拟私有云名称最小长度：1 最大长度：255
cidr	否	String	VPC的网段，默认192.168.0.0/16 最小长度：1 最大长度：255

表6 Nics
参数	是否必选	参数类型	描述
id	是	String	子网ID，如果是自动创建，使用"autoCreate" 最小长度：0 最大长度：255
name	是	String	子网名称最小长度：0 最大长度：255
cidr	是	String	子网网关/掩码最小长度：0 最大长度：255
ip	否	String	虚拟机IP地址，如果没有这个字段，自动分配IP 最小长度：0 最大长度：255

表7 SgObject
参数	是否必选	参数类型	描述
id	是	String	安全组ID 最小长度：0 最大长度：255
name	是	String	安全组名称最小长度：0 最大长度：255

表8 PublicIp
参数	是否必选	参数类型	描述
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

表9 TemplateDisk
参数	是否必选	参数类型	描述
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

响应参数

状态码：200

**表10** 响应Body参数
参数	参数类型	描述
-	String	修改模板信息

状态码：403

**表11** 响应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

**表12** details
参数	参数类型	描述
error_code	String	SMS错误代码最小长度：0 最大长度：65535
error_msg	String	SMS错误信息最小长度：0 最大长度：65535

请求示例

修改源端模板信息，修改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
    } ]
  }
}

响应示例

状态码：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."
  } ]
}

状态码

状态码	描述
200	修改模板信息
403	鉴权失败

错误码

请参见错误码。

父主题： 模板管理

上一篇：查询指定ID模板信息

下一篇：迁移项目管理

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消