文档首页/ 主机迁移服务 SMS/ API参考/ API v3/ 模板管理/ 查询模板列表
更新时间：2024-08-16 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询模板列表

功能介绍

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

调用方法

请参见如何调用API。

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 TemplateResponseBody objects

模板信息

数组长度：0 - 65535
表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:串行连接SCSI SSD:固态硬盘 SATA:串口硬盘

枚举值：

  • SAS

  • 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:串口硬盘

枚举值：

  • 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

请求示例

查询模板列表

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

响应示例

状态码： 200

OK

{
  "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" : [ ]
  } ]
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.sms.v3.region.SmsRegion;
import com.huaweicloud.sdk.sms.v3.*;
import com.huaweicloud.sdk.sms.v3.model.*;


public class ListTemplatesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        SmsClient client = SmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(SmsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListTemplatesRequest request = new ListTemplatesRequest();
        request.withName("<name>");
        request.withAvailabilityZone("<availability_zone>");
        request.withRegion("<region>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        try {
            ListTemplatesResponse response = client.listTemplates(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdksms.v3.region.sms_region import SmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksms.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

    client = SmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListTemplatesRequest()
        request.name = "<name>"
        request.availability_zone = "<availability_zone>"
        request.region = "<region>"
        request.limit = <limit>
        request.offset = <offset>
        response = client.list_templates(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    sms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := sms.NewSmsClient(
        sms.SmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListTemplatesRequest{}
	nameRequest:= "<name>"
	request.Name = &nameRequest
	availabilityZoneRequest:= "<availability_zone>"
	request.AvailabilityZone = &availabilityZoneRequest
	regionRequest:= "<region>"
	request.Region = &regionRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	response, err := client.ListTemplates(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 模板管理