查询模板列表
功能介绍
查询弹性云服务器模板列表,迁移时选择“新建服务器”时可使用该模板创建弹性云服务器。
调用方法
请参见如何调用API。
URI
GET /v3/vm/templates
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
模板名称 最小长度:0 最大长度:255 |
availability_zone |
否 |
String |
可用区 最小长度:0 最大长度:255 |
region |
否 |
String |
Region ID 最小长度:0 最大长度:255 |
limit |
否 |
Integer |
分页大小,不传值默认为50 最小值:0 最大值:100 缺省值:50 |
offset |
否 |
Integer |
偏移量,不传值默认为0 最小值:0 最大值:65535 缺省值:0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
X-Auth-Token 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:16384 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
模板个数 最小值:0 最大值:65535 |
templates |
Array of TemplateResponseBody objects |
模板信息 数组长度:0 - 65535 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
模板ID 最小长度:0 最大长度:255 |
name |
String |
模板名称 最小长度:0 最大长度:255 |
is_template |
String |
是否是通用模板,如果模板关联一个任务,则不算通用模板 最小长度:0 最大长度:255 |
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 最大长度:255 |
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 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
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 |
请求示例
查询模板列表
GET https://{endpoint}/v3/vm/templates
响应示例
状态码:200
查询模板列表成功
{ "count" : 9, "templates" : [ { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "test", "region" : "region", "availability_zone" : "availability_zone", "projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001", "flavor" : "s2.large.2", "volumetype" : "", "image_id" : "", "vpc" : { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "vpc-dfdb" }, "nics" : [ { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "subnet-dfdb(192.168.1.0/24)", "cidr" : "192.168.1.0/24", "ip" : "" } ], "security_groups" : [ { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "default(Inbound:tcp/8900,8899,3389,22; Outbound:--)" } ] }, { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "test1", "region" : "region", "availability_zone" : "availability_zone", "projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001", "flavor" : "s6.large.2", "volumetype" : "", "image_id" : "", "vpc" : { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "vpc-13d6" }, "nics" : [ { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "subnet-13d6(192.168.1.0/24)", "cidr" : "192.168.1.0/24", "ip" : "" } ], "security_groups" : [ { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "sms-1568190885(Inbound:tcp/8900,8899,3389; Outbound:--)" } ] }, { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "test2", "region" : "region", "availability_zone" : "availability_zone", "projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001", "flavor" : "s2.large.2", "volumetype" : "", "image_id" : "", "vpc" : { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "vpc-testcloud(192.168.0.0/16)" }, "nics" : [ { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "subnet-testcloud(192.168.0.0/24)", "cidr" : "192.168.0.0/24", "ip" : "" } ], "security_groups" : [ ] }, { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "fdff", "region" : "region", "availability_zone" : "availability_zone", "projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001", "flavor" : "s2.large.2", "volumetype" : "", "image_id" : "", "vpc" : { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "vpc-migration(192.168.0.0/16)" }, "nics" : [ { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "subnet-cf42(192.168.5.0/24)", "cidr" : "192.168.5.0/24", "ip" : "" } ], "security_groups" : [ { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "sg-smt-test(Inbound:tcp/3389,8899,22,8900; Outbound:--)" } ] }, { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "test3", "region" : "region", "availability_zone" : "availability_zone", "projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001", "flavor" : "s2.medium.2", "volumetype" : "", "image_id" : "", "vpc" : { }, "nics" : [ ], "security_groups" : [ ] }, { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "test_linux_childproj", "region" : "region", "availability_zone" : "availability_zone", "projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001", "flavor" : "s2.small.1", "volumetype" : "SATA", "image_id" : "", "vpc" : { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "sms-1567992634(192.168.0.0/16)" }, "nics" : [ { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "sms-1567992646(192.168.0.0/16)", "cidr" : "192.168.0.0/16", "ip" : "" } ], "security_groups" : [ { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "sg-7e50(Inbound:tcp/8900,8899,3389,22; Outbound:--)" } ] }, { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "12212", "region" : "region", "availability_zone" : "availability_zone", "projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001", "flavor" : "s2.large.2", "volumetype" : "", "image_id" : "", "vpc" : { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "vpc-migration(192.168.0.0/16)" }, "nics" : [ { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "subnet-migration(192.168.1.0/24)", "cidr" : "192.168.1.0/24", "ip" : "" } ], "security_groups" : [ { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "SMT-Windows(Inbound:tcp/8443,8899,8900,22,3389;icmp; Outbound:--)" } ] }, { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "test4", "region" : "region", "availability_zone" : "availability_zone", "projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001", "flavor" : "s2.medium.2", "volumetype" : "SATA", "image_id" : "", "vpc" : { }, "nics" : [ ], "security_groups" : [ ] }, { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "dddd", "region" : "region", "availability_zone" : "availability_zone", "projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001", "flavor" : "s2.large.2", "volumetype" : "", "image_id" : "", "vpc" : { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "sms-1566979232(192.168.0.0/16)" }, "nics" : [ { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "sms-1566979244(192.168.0.0/16)", "cidr" : "192.168.0.0/16", "ip" : "" } ], "security_groups" : [ ] } ] }
状态码: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 |
鉴权失败 |
错误码
请参见错误码。