查询指定ID模板信息
功能介绍
查询指定ID的弹性云服务器模板信息。
调用方法
请参见如何调用API。
URI
GET /v3/vm/templates/{id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
需要查询的模板信息的ID 最小长度:0 最大长度:255 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
X-Auth-Token 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:16384 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
template |
TemplateResponseBody object |
模板信息 |
参数 |
参数类型 |
描述 |
---|---|---|
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:串口硬盘 枚举值:
|
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:串口硬盘 枚举值:
|
target_password |
String |
目的端密码 最小长度:0 最大长度:1024 |
image_id |
String |
用户选择镜像版本Id值 最小长度:0 最大长度:255 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
虚拟私有云ID,如果是自动创建,填“autoCreate” 最小长度:1 最大长度:255 |
name |
String |
虚拟私有云名称 最小长度:1 最大长度:255 |
cidr |
String |
VPC的网段,默认192.168.0.0/16 最小长度:1 最大长度:255 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
子网ID,如果是自动创建,使用"autoCreate" 最小长度:0 最大长度:255 |
name |
String |
子网名称 最小长度:0 最大长度:255 |
cidr |
String |
子网网关/掩码 最小长度:0 最大长度:255 |
ip |
String |
虚拟机IP地址,如果没有这个字段,自动分配IP 最小长度:0 最大长度:255 |
请求示例
查询ID为6874cb49-48bb-4875-975d-4bca464d8472的模板的详情
GET https://{endpoint}/v3/vm/templates/6874cb49-48bb-4875-975d-4bca464d8472
响应示例
状态码: 200
OK
{ "template" : { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001", "name" : "test1025", "region" : "region", "target_server_name" : "", "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" : [ ], "publicip" : { "type" : "5_bgp", "bandwidth_size" : 5, "bandwidth_share_type" : "PER" }, "disk" : [ { "index" : 0, "name" : "system", "disktype" : "", "size" : 40 } ] } }
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 |
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 ShowTemplateSolution { 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(); ShowTemplateRequest request = new ShowTemplateRequest(); try { ShowTemplateResponse response = client.showTemplate(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 |
# 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 = ShowTemplateRequest() response = client.show_template(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 |
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.ShowTemplateRequest{} response, err := client.ShowTemplate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。