文档首页/ 主机迁移服务 SMS/ API参考（吉隆坡区域）/ API v3/ 模板管理/ 查询指定ID模板信息
更新时间：2022-08-02 GMT+08:00
查看PDF
分享

查询指定ID模板信息

功能介绍

查询指定ID的弹性云服务器模板信息。

URI

GET /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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

template

TemplateResponseBody object

模板信息
表4 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
  • SSD
  • SATA

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
  • SSD
  • SATA

target_password

String

目的端密码

最小长度：0

最大长度：1024
表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
表9 TemplateDisk

参数

参数类型

描述

index

Integer

磁盘序号，从0开始

最小值：0

最大值：2147483647

name

String

磁盘名称

最小长度：0

最大长度：255

disktype

String

磁盘类型，同volumetype字段

最小长度：0

最大长度：255

size

Long

磁盘大小，单位：GB

最小值：0

最大值：9223372036854775807

请求示例

查询ID为6874cb49-48bb-4875-975d-4bca464d8472的模板的详情

GET https://{endpoint}/v3/vm/templates/6874cb49-48bb-4875-975d-4bca464d8472

响应示例

状态码： 200

OK

{
  "template" : {
    "id" : "6874cb49-48bb-4875-975d-4bca464d8472",
    "name" : "test1025",
    "region" : "region",
    "target_server_name" : "",
    "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" : [ ],
    "publicip" : {
      "type" : "5_bgp",
      "bandwidth_size" : 5,
      "bandwidth_share_type" : "PER"
    },
    "disks" : [ {
      "index" : 0,
      "name" : "system",
      "disktype" : "",
      "size" : 40
    } ]
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 模板管理