文档首页/ 主机迁移服务 SMS/ API参考/ API/ 模板管理/ 查询指定ID模板信息 - ShowTemplate
更新时间:2025-10-22 GMT+08:00
分享

查询指定ID模板信息 - ShowTemplate

功能介绍

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

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    sms:template:get

    Read

    template *

    -

    • sms:server:queryServer

    -

URI

GET /v3/vm/templates/{id}

表1 路径参数

参数

是否必选

参数类型

描述

id

String

需要查询的模板信息的ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

X-Auth-Token

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

template

TemplateResponseBody object

模板信息

表4 TemplateResponseBody

参数

参数类型

描述

id

String

模板ID

name

String

模板名称

is_template

String

是否是通用模板,如果模板关联一个任务,则不算通用模板

region

String

Region信息

projectid

String

项目ID

target_server_name

String

目标端服务器名称

availability_zone

String

可用区

volumetype

String

数据盘磁盘类型

SAS:串行连接SCSI

SSD:固态硬盘

SATA:串口硬盘

枚举值:

  • SAS

  • SSD

  • SATA

flavor

String

虚拟机规格

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:串行连接SCSI

SSD:固态硬盘

SATA:串口硬盘

枚举值:

  • SAS

  • SSD

  • SATA

target_password

String

目的端密码

image_id

String

用户选择镜像版本Id值

表5 VpcObject

参数

参数类型

描述

id

String

虚拟私有云ID,如果是自动创建,填“autoCreate”

name

String

虚拟私有云名称

cidr

String

VPC的网段,默认192.168.0.0/16

表6 Nics

参数

参数类型

描述

id

String

子网ID,如果是自动创建,使用"autoCreate"

name

String

子网名称

cidr

String

子网网关/掩码

ip

String

虚拟机IP地址,如果没有这个字段,自动分配IP

表7 SgObject

参数

参数类型

描述

id

String

安全组ID

name

String

安全组名称

表8 PublicIp

参数

参数类型

描述

type

String

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

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

带宽共享类型

表9 TemplateDisk

参数

参数类型

描述

id

Long

磁盘ID

取值范围:

0~9223372036854775807

index

Integer

磁盘序号,从0开始

取值范围:

0~2147483647

name

String

磁盘名称

disktype

String

磁盘类型,同volumetype字段

size

Long

磁盘大小,单位:GB

取值范围:

0~9223372036854775807

device_use

String

磁盘使用

状态码:403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误代码

error_msg

String

错误信息

encoded_authorization_message

String

加密授权信息

error_param

Array of strings

错误参数

details

Array of details objects

详细错误信息

表11 details

参数

参数类型

描述

error_code

String

SMS错误代码

error_msg

String

SMS错误信息

请求示例

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

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

响应示例

状态码:200

查询指定ID模板信息成功

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

状态码: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代码示例如下。

 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
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();
        request.withId("{id}");
        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
31
# 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()
        request.id = "{id}"
        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
36
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{}
	request.Id = "{id}"
	response, err := client.ShowTemplate(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询指定ID模板信息成功

403

鉴权失败

错误码

请参见错误码

相关文档