# 查询模板列表 - ListTemplates #### 功能介绍 查询弹性云服务器模板列表，迁移时选择"新建服务器"时可使用该模板创建弹性云服务器。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-sms/sms_api_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-sms/sms_api_8001.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | sms:template:list | List | template \* | - | sms:server:queryServer | - | #### URI GET /v3/vm/templates 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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** | | id | 否 | String | 模板id 最小长度：**1** 最大长度：**36** | #### 请求参数 表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** | 表4TemplateResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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** | 表5VpcObject | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 虚拟私有云ID，如果是自动创建，填"autoCreate" 最小长度：**1** 最大长度：**255** | | name | String | 虚拟私有云名称 最小长度：**1** 最大长度：**255** | | cidr | String | VPC的网段，默认192.168.0.0/16 最小长度：**1** 最大长度：**255** | 表6Nics | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 子网ID，如果是自动创建，使用"autoCreate" 最小长度：**0** 最大长度：**255** | | name | String | 子网名称 最小长度：**0** 最大长度：**255** | | cidr | String | 子网网关/掩码 最小长度：**0** 最大长度：**255** | | ip | String | 虚拟机IP地址，如果没有这个字段，自动分配IP 最小长度：**0** 最大长度：**255** | 表7SgObject | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 安全组ID 最小长度：**0** 最大长度：**255** | | name | String | 安全组名称 最小长度：**0** 最大长度：**255** | 表8PublicIp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | 弹性公网IP类型，默认为5_bgp。 详细类型请参考EIP服务API文档中"查询弹性公网IP详情"部分，查看响应参数的中type字段描述 最小长度：**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 | 带宽共享类型（长文本信息，非枚举数据，来源于EIP服务） 详细类型请参考EIP服务API文档中"查询弹性公网IP详情"部分，查看响应参数的中bandwidth_share_type字段描述 最小长度：**0** 最大长度：**255** | 表9TemplateDisk | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Long | 磁盘ID 最小值：**0** 最大值：**9223372036854775807** | | index | Integer | 磁盘序号，从0开始 最小值：**0** 最大值：**2147483647** | | name | String | 磁盘名称 最小长度：**0** 最大长度：**255** | | disktype | String | 磁盘类型，同volumetype字段（非枚举数据，来源于EVS服务） 详细类型请参考EIP服务API文档中"查询单个云硬盘详情"部分，查看响应参数的中volume_type字段描述 最小长度：**0** 最大长度：**255** | | size | Long | 磁盘大小，单位：GB 最小值：**0** 最大值：**9223372036854775807** | | device_use | String | 磁盘使用 最小长度：**0** 最大长度：**255** | **状态码：403** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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** | 表11details | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | SMS错误代码 最小长度：**0** 最大长度：**65535** | | error_msg | String | SMS错误信息 最小长度：**0** 最大长度：**65535** | #### 请求示例 查询模板列表 ``` GET https://{endpoint}/v3/vm/templates X-Auth-Token: XXXX ``` #### 响应示例 **状态码：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" : "SATA", "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" : "SATA", "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" : "SATA", "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" : "SATA", "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" : "SATA", "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" : "SATA", "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" : "SATA", "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." } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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("")) .build(); ListTemplatesRequest request = new ListTemplatesRequest(); 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()); } } } ``` - [Python] ``` # 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("")) \ .build() try: request = ListTemplatesRequest() 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) ``` - [Go] ``` 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, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := sms.SmsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := sms.NewSmsClient(hcClient) request := &model.ListTemplatesRequest{} response, err := client.ListTemplates(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SMS/sdk?api=ListTemplates)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询模板列表成功 | | 403 | 鉴权失败 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-sms/ErrorCode.html)。