更新时间:2022-08-05 GMT+08:00

查询模板列表

功能介绍

查询弹性云服务器模板列表。

URI

GET /v1/sms/vm/templates

请求消息

请求参数

请求参数如表1所示。

表1 参数说明

参数

是否必选

参数类型

描述

name

String

模板名称

availability_zone

String

可用区

region

String

Region ID

Number_per_page

Integer

分页大小,不传值默认为50

Page_num

Integer

起始页码,不传值默认为0

响应消息

响应参数

响应参数如表3所示。

表2 响应参数

参数

参数类型

描述

count

String

模板个数

templates

String

模板信息,请参见表2

表3 templates信息

参数

参数类型

描述

name

String

模板名称

id

String

模板ID

region

String

Region ID

availability_zone

String

可用区

volumetype

String

磁盘类型

vpc

Object

虚拟私有云,请参见表4

nics

Array

子网,请参见表6

security_groups

Array

安全组,请参见表5

publicip

Object

弹性公网IP,请参见表7

表4 vpc信息

参数

参数类型

描述

id

String

虚拟私有云id

name

String

虚拟私有云名称

表5 security_groups信息

参数

参数类型

描述

id

String

安全组ID

name

String

安全组名称

表6 nics信息

参数

参数类型

描述

id

String

子网ID

name

String

子网名称

cidr

String

子网网关/掩码

表7 publicip信息

参数

参数类型

描述

type

String

弹性公网IP类型,默认为5_bgp

bandwidth_size

Integer

功能说明:带宽大小

带宽(Mbit/s),取值范围为[1,2000]。

调整带宽时的最小单位会根据带宽范围不同存在差异。

小于等于300Mbit/s:默认最小单位为1Mbit/s。300Mbit/s~1000Mbit/s:默认最小单位为50Mbit/s。大于1000Mbit/s:默认最小单位为500Mbit/s。

说明:

如果share_type是PER,该参数必选项;如果share_type是WHOLE并且id有值,该参数会忽略。

示例

  • 请求示例
    GET  v1/sms/vm/templates?name=temp1
  • 响应示例
    { 
      "count":1, 
      "templates":[
        { 
          "name":"temp1",
          "id":"abcdefghijk-aa-bbb",
          
          
          
          
          
          
          "region":"ae-ad-1",
          
          "availability_zone":"AZ1",
          
          
          
          
          "volumetype":"SATA",
          "vpc":{
             "id":"0dae26c9-9a70-4392-93f3-87d53115d171",
             "name":"vpc1" 
          },
          "nics":[
            {
              "id":"157ee789-03ea-45b1-a698-76c92660dd83",
              "name": "subnet-1637",
              "cidr": "192.168.0.0/24"
            }
          ],
         "security_groups":[
            {
              "id":"507ca48f-814c-4293-8706-300564d54620", 
              "name":"default"
            }
          ], 
          "publicip":  {
               "type": "5_bgp",
               "bandwidth_size":10,
          }
        } 
      ] 
    }

状态码

状态码请参见状态码

错误码

请参见历史错误码