主机迁移服务 SMS主机迁移服务 SMS

更新时间:2021/09/14 GMT+08:00
分享

查询模板列表

功能介绍

查询弹性云服务器模板列表,迁移时选择“新建服务器”时可使用该模板创建弹性云服务器。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/vm/templates

表1 Query参数

参数

是否必选

参数类型

描述

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

X-Auth-Token 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:16384

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

count

Integer

模板个数

最小值:0

最大值:65535

templates

Array of TemplateResponse objects

模板信息

表4 TemplateResponse

参数

参数类型

描述

template

TemplateResponseBody object

模板信息

表5 TemplateResponseBody

参数

参数类型

描述

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:高I/O
  • SSD:超高I/O
  • SATA:普通I/O

flavor

String

虚拟机规格

最小长度:0

最大长度:255

vpc

VpcObject object

vpc对象

nics

Array of Nics objects

网卡信息,支持多个网卡,如果是自动创建,只填一个,id使用“autoCreate”

security_groups

Array of SgObject objects

安全组,支持多个安全组,如果是自动创建,只填一个,id使用“autoCreate”

publicip

PublicIp object

公网ip

disk

Array of TemplateDisk objects

磁盘信息

data_volume_type

String

数据盘磁盘类型

枚举值:

  • SAS:高I/O
  • SSD:超高I/O
  • SATA:普通I/O

target_password

String

目的端密码

最小长度:0

最大长度:1024

表6 VpcObject

参数

参数类型

描述

id

String

虚拟私有云ID,如果是自动创建,填“autoCreate”

最小长度:1

最大长度:255

name

String

虚拟私有云名称

最小长度:1

最大长度:255

cidr

String

VPC的网段,默认192.168.0.0/16

最小长度:1

最大长度:255

表7 Nics

参数

参数类型

描述

id

String

子网ID,如果是自动创建,使用"autoCreate"

最小长度:0

最大长度:255

name

String

子网名称

最小长度:0

最大长度:255

cidr

String

子网网关/掩码

最小长度:0

最大长度:255

ip

String

虚拟机IP地址,如果没有这个字段,自动分配IP

最小长度:0

最大长度:255

表8 SgObject

参数

参数类型

描述

id

String

安全组ID

最小长度:0

最大长度:255

name

String

安全组名称

最小长度:0

最大长度:255

表9 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

表10 TemplateDisk

参数

参数类型

描述

index

Integer

磁盘序号,从0开始

最小值:0

最大值:2147483647

name

String

磁盘名称

最小长度:0

最大长度:255

disktype

String

磁盘类型,同volumetype字段

最小长度:0

最大长度:255

size

Long

磁盘大小,单位:GB

最小值:0

最大值:9223372036854775807

请求示例

查询模板列表

GET https://{endpoint}/v3/vm/templates

响应示例

状态码: 200

OK

{
  "count" : 9,
  "templates" : [ {
    "id" : "3db302e8-95de-478c-a892-8a083f2d269b",
    "name" : "test",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "c6e3047501b340a4a79fb94dad453676",
    "flavor" : "s2.large.2",
    "volumetype" : "",
    "vpc" : {
      "id" : "4d329f4b-70ee-4996-ba9a-5b5ec63a7c2e",
      "name" : "vpc-dfdb"
    },
    "nics" : [ {
      "id" : "d807e702-a59a-480c-aa5e-23449775d107",
      "name" : "subnet-dfdb(192.168.1.0/24)",
      "cidr" : "192.168.1.0/24",
      "ip" : ""
    } ],
    "security_groups" : [ {
      "id" : "c922bce4-1892-44bc-a58e-f250a666939a",
      "name" : "default(Inbound:tcp/8900,8899,3389,22; Outbound:--)"
    } ]
  }, {
    "id" : "708847ae-f013-4b1a-8ea8-6cfa1e94237d",
    "name" : "test1",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "05a6d0f34380269c2f02c016826878ea",
    "flavor" : "s6.large.2",
    "volumetype" : "",
    "vpc" : {
      "id" : "ee756d79-6223-464b-a3f4-a1e048309fdb",
      "name" : "vpc-13d6"
    },
    "nics" : [ {
      "id" : "768b0328-7b01-4d34-9afc-03e88025ff05",
      "name" : "subnet-13d6(192.168.1.0/24)",
      "cidr" : "192.168.1.0/24",
      "ip" : ""
    } ],
    "security_groups" : [ {
      "id" : "bf736dd6-7e7e-42ba-a1d3-b3a9f6a5fda5",
      "name" : "sms-1568190885(Inbound:tcp/8900,8899,3389; Outbound:--)"
    } ]
  }, {
    "id" : "6874cb49-48bb-4875-975d-4bca464d8472",
    "name" : "test2",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "353b5ccc3deb4abc8ac8291bf468f69c",
    "flavor" : "s2.large.2",
    "volumetype" : "",
    "vpc" : {
      "id" : "a1f9de64-bf00-4c4f-8c97-ebc65f9e1e2e",
      "name" : "vpc-testcloud(192.168.0.0/16)"
    },
    "nics" : [ {
      "id" : "04ba310f-34df-4df3-9385-11552aafff03",
      "name" : "subnet-testcloud(192.168.0.0/24)",
      "cidr" : "192.168.0.0/24",
      "ip" : ""
    } ],
    "security_groups" : [ ]
  }, {
    "id" : "76b8b2b2-b730-4000-b0a3-048f80105dd2",
    "name" : "fdff",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "00924d0ad2df4f21ac476dd9f32888f1",
    "flavor" : "s2.large.2",
    "volumetype" : "",
    "vpc" : {
      "id" : "d6f34811-1a4d-4686-911a-982c8e2c1f1b",
      "name" : "vpc-migration(192.168.0.0/16)"
    },
    "nics" : [ {
      "id" : "85ca07d5-7d0d-40ce-b1b2-9dd2db14f840",
      "name" : "subnet-cf42(192.168.5.0/24)",
      "cidr" : "192.168.5.0/24",
      "ip" : ""
    } ],
    "security_groups" : [ {
      "id" : "a563735f-4183-40de-854f-5ba2cb26496d",
      "name" : "sg-smt-test(Inbound:tcp/3389,8899,22,8900; Outbound:--)"
    } ]
  }, {
    "id" : "382f66f9-b948-4bee-b2a8-50b9d3461c81",
    "name" : "test3",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "00924d0ad2df4f21ac476dd9f32888f1",
    "flavor" : "s2.medium.2",
    "volumetype" : "",
    "vpc" : { },
    "nics" : [ ],
    "security_groups" : [ ]
  }, {
    "id" : "b3c49d20-720a-486f-9d61-b56e6b5bca39",
    "name" : "test_linux_childproj",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "062b8cb8ec8010dc2f42c0167c4631f9",
    "flavor" : "s2.small.1",
    "volumetype" : "SATA",
    "vpc" : {
      "id" : "b09cebfb-6887-4c58-a353-008dae644f6e",
      "name" : "sms-1567992634(192.168.0.0/16)"
    },
    "nics" : [ {
      "id" : "34688a59-2fd9-422d-a373-87460ef60014",
      "name" : "sms-1567992646(192.168.0.0/16)",
      "cidr" : "192.168.0.0/16",
      "ip" : ""
    } ],
    "security_groups" : [ {
      "id" : "079febf0-cfd2-4722-82d6-a518ea65cd67",
      "name" : "sg-7e50(Inbound:tcp/8900,8899,3389,22; Outbound:--)"
    } ]
  }, {
    "id" : "bda09f7f-3b0c-4bb5-a1ad-3a4d62024774",
    "name" : "12212",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "2c0689c860ad4728a497c91ec0844383",
    "flavor" : "s2.large.2",
    "volumetype" : "",
    "vpc" : {
      "id" : "4490ab3f-5f0c-42e9-97b7-8b3bc0541e70",
      "name" : "vpc-migration(192.168.0.0/16)"
    },
    "nics" : [ {
      "id" : "350a355b-53db-4e58-80fc-56841ab55021",
      "name" : "subnet-migration(192.168.1.0/24)",
      "cidr" : "192.168.1.0/24",
      "ip" : ""
    } ],
    "security_groups" : [ {
      "id" : "410f9e21-1085-41b8-b5f7-0da0089be8e3",
      "name" : "SMT-Windows(Inbound:tcp/8443,8899,8900,22,3389;icmp; Outbound:--)"
    } ]
  }, {
    "id" : "7d0b56ff-f9c7-478d-9017-120bbdf4b363",
    "name" : "test4",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "00924d0ad2df4f21ac476dd9f32888f1",
    "flavor" : "s2.medium.2",
    "volumetype" : "SATA",
    "vpc" : { },
    "nics" : [ ],
    "security_groups" : [ ]
  }, {
    "id" : "ec4ac7de-dba1-4602-b327-c228243651db",
    "name" : "dddd",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "2c0689c860ad4728a497c91ec0844383",
    "flavor" : "s2.large.2",
    "volumetype" : "",
    "vpc" : {
      "id" : "00cda768-ef7b-40ac-a555-84b0c2b85d89",
      "name" : "sms-1566979232(192.168.0.0/16)"
    },
    "nics" : [ {
      "id" : "b5891372-f48c-4b3c-9f7a-ab58da5baa93",
      "name" : "sms-1566979244(192.168.0.0/16)",
      "cidr" : "192.168.0.0/16",
      "ip" : ""
    } ],
    "security_groups" : [ ]
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

分享:

    相关文档

    相关产品