Help Center/ Server Migration Service/ API Reference/ API/ Template Management/ Querying Details About a Template
Updated on 2025-11-27 GMT+08:00
View PDF

Querying Details About a Template

Function

This API is used to query information about an ECS template with a specified ID.

Calling Method

For details, see Calling APIs.

URI

GET /v3/vm/templates/{id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

id

Yes

String

The ID of the template to be queried.

Minimum length: 1 character

Maximum length: 36

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

X-Auth-Token

The user token.

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Minimum length: 1 character

Maximum length: 16,384 characters

Response

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

template

TemplateResponseBody object

The template information.
Table 4 TemplateResponseBody field description

Parameter

Type

Description

id

String

The template ID.

Minimum length: 0 characters

Maximum length: 255 characters

name

String

The template name.

Minimum length: 0 characters

Maximum length: 255 characters

is_template

String

Specifies whether the template is general. If the template is associated with a task, the template is not a general template.

Minimum length: 0 characters

Maximum length: 255 characters

region

String

The region.

Minimum length: 0 characters

Maximum length: 255 characters

projectid

String

The project ID.

Minimum length: 0 characters

Maximum length: 255 characters

target_server_name

String

The server name.

Minimum length: 0 characters

Maximum length: 255 characters

availability_zone

String

The AZ.

Minimum length: 0 characters

Maximum length: 255 characters

volumetype

String

The data disk type.

SAS: serial attached SCSI

SSD: solid-state drive

SATA: serial advanced technology attachment

The value can be:

  • SAS

  • SSD

  • SATA

flavor

String

The server flavor.

Minimum length: 0 characters

Maximum length: 255 characters

vpc

VpcObject object

The VPC information.

nics

Array of Nics objects

The NIC information. Multiple NICs are supported. To let the system automatically add a NIC, configure only one NIC entry and set the ID to autoCreate.

Array length: 0 to 65,535

security_groups

Array of SgObject objects

The security group information. Multiple security groups are supported. To let the system automatically create a security group, configure only one security group record and set the ID to autoCreate.

Array length: 0 to 65,535

publicip

PublicIp object

The public IP address information.

disk

Array of TemplateDisk objects

The disk information.

Array length: 0 to 65,535

data_volume_type

String

The data disk type.

SAS: serial attached SCSI

SSD: solid-state drive

SATA: serial advanced technology attachment

The value can be:

  • SAS

  • SSD

  • SATA

target_password

String

The server login password.

Minimum length: 0 characters

Maximum length: 1,024 characters

image_id

String

The ID of the selected image.

Minimum length: 0 characters

Maximum length: 255 characters
Table 5 VpcObject

Parameter

Type

Description

id

String

The VPC ID. To let the system automatically create a VPC, set this parameter to autoCreate.

Minimum length: 1 character

Maximum length: 255 characters

name

String

The VPC name.

Minimum length: 1 character

Maximum length: 255 characters

cidr

String

The VPC CIDR block. The default value is 192.168.0.0/16.

Minimum length: 1 character

Maximum length: 255 characters
Table 6 Nics

Parameter

Type

Description

id

String

The subnet ID. To let the system automatically create a subnet, set this parameter to autoCreate.

Minimum length: 0 characters

Maximum length: 255 characters

name

String

The subnet name.

Minimum length: 0 characters

Maximum length: 255 characters

cidr

String

The subnet gateway/mask.

Minimum length: 0 characters

Maximum length: 255 characters

ip

String

The server IP address. If this parameter is not specified, the system will automatically assign an IP address.

Minimum length: 0 characters

Maximum length: 255 characters
Table 7 SgObject

Parameter

Type

Description

id

String

The security group ID.

Minimum length: 0 characters

Maximum length: 255 characters

name

String

The security group name.

Minimum length: 0 characters

Maximum length: 255 characters
Table 8 PublicIp

Parameter

Type

Description

type

String

The EIP type. The default value is 5_bgp.

For details about the types, see the description of the type field in the response parameters in the "Querying EIP Details" section in the EIP API document.

Minimum length: 0 characters

Maximum length: 255 characters

bandwidth_size

Integer

The bandwidth size in Mbit/s.

The minimum increment for bandwidth adjustment varies depending on the bandwidth range.

The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 to 300 Mbit/s. The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1,000 Mbit/s. The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1,000 Mbit/s.

Minimum value: 1

Maximum value: 2000

bandwidth_share_type

String

Bandwidth sharing type (long text information, non-enumerated data, from the EIP service)

For details about the types, see the description of the bandwidth_share_type field in the response parameters in the "Querying EIP Details" section in the EIP API document.

Minimum length: 0 characters

Maximum length: 255 characters
Table 9 TemplateDisk

Parameter

Type

Description

id

Long

The disk ID.

Minimum value: 0

Maximum value: 9223372036854775807

index

Integer

The disk serial number, starting from 0.

Minimum value: 0

Maximum value: 2147483647

name

String

The disk name.

Minimum length: 0 characters

Maximum length: 255 characters

disktype

String

Disk type, which is the same as the volumetype field. (The value is a long text and is not enumerated. The value comes from the EVS service.)

For details about the type, see the description of the volume_type field in the response parameters in the "Querying Details About a Disk" section in the EIP API document.

Minimum length: 0 characters

Maximum length: 255 characters

size

Long

The disk size in GB.

Minimum value: 0

Maximum value: 9223372036854775807

device_use

String

The used disk space.

Minimum length: 0 characters

Maximum length: 255 characters

Status code: 403

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum length: 0 characters

Maximum length: 255 characters

error_msg

String

The error message.

Minimum length: 0 characters

Maximum length: 255 characters

encoded_authorization_message

String

The encrypted authorization information.

Minimum length: 0 characters

Maximum length: 65,535 characters

error_param

Array of strings

Invalid parameters.

Minimum length: 0 characters

Maximum length: 65,535 characters

Array length: 1 to 20

details

Array of details objects

The error details.

Array length: 1 to 20
Table 11 details

Parameter

Type

Description

error_code

String

The SMS error code.

Minimum length: 0 characters

Maximum length: 65,535 characters

error_msg

String

The SMS error message.

Minimum length: 0 characters

Maximum length: 65,535 characters

Example Request

This example queries the details about the template whose ID is 6874cb49-48bb-4875-975d-4bca464d8472.

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

Example Response

Status code: 200

Querying details about a template succeeded.

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

Status code: 403

Authentication failed.

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

Status Codes

Status Code

Description

200

Querying details about a template succeeded.

403

Authentication failed.

Error Codes

For details, see Error Codes.

Parent topic: Template Management