Querying 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: 1 Maximum: 36

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 1 Maximum: 16384

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
template	TemplateResponseBody object	The template information.

**Table 4** TemplateResponseBody
Parameter	Type	Description
id	String	The template ID. Minimum: 0 Maximum: 255
name	String	The template name. Minimum: 0 Maximum: 255
is_template	String	Indicates whether the template is general. If the template is associated with a task, the template is not a general template. Minimum: 0 Maximum: 255
region	String	The region. Minimum: 0 Maximum: 255
projectid	String	The project ID. Minimum: 0 Maximum: 255
target_server_name	String	The name of the target server. Minimum: 0 Maximum: 255
availability_zone	String	The availability zone. Minimum: 0 Maximum: 255
volumetype	String	The data disk type. SAS: serial attached SCSI SSD: solid-state drive SATA: serial advanced technology attachment Enumeration values: SAS SSD SATA
flavor	String	The server flavor. Minimum: 0 Maximum: 255
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 - 65535
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 - 65535
publicip	PublicIp object	The public IP address.
disk	Array of TemplateDisk objects	The disk information. Array Length: 0 - 65535
data_volume_type	String	The data disk type. SAS: serial attached SCSI SSD: solid-state drive SATA: serial advanced technology attachment Enumeration values: SAS SSD SATA
target_password	String	The target server password. Minimum: 0 Maximum: 1024
image_id	String	The ID of the selected image. Minimum: 0 Maximum: 255

**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: 1 Maximum: 255
name	String	The VPC name. Minimum: 1 Maximum: 255
cidr	String	The VPC CIDR block. The default value is 192.168.0.0/16. Minimum: 1 Maximum: 255

**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: 0 Maximum: 255
name	String	The subnet name. Minimum: 0 Maximum: 255
cidr	String	The subnet gateway/mask. Minimum: 0 Maximum: 255
ip	String	The server IP address. If this parameter is not specified, the system will automatically assign an IP address. Minimum: 0 Maximum: 255

**Table 7** SgObject
Parameter	Type	Description
id	String	Security group ID. Minimum: 0 Maximum: 255
name	String	Security group name. Minimum: 0 Maximum: 255

**Table 8** PublicIp
Parameter	Type	Description
type	String	The EIP type. The default value is 5_bgp. For details about the type, see the description of the type field in Response Message in section "Querying an EIP" of the EIP API reference. Minimum: 0 Maximum: 255
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 does not exceed 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 exceeds 1,000 Mbit/s. Minimum: 1 Maximum: 2000
bandwidth_share_type	String	Bandwidth sharing type (long text, non-enumerated data, from EIP) For details about the type, see the description of the bandwidth_share_type field in Response Message in section "Querying an EIP" of the EIP API reference. Minimum: 0 Maximum: 255

**Table 9** TemplateDisk
Parameter	Type	Description
id	Long	The disk ID. Minimum: 0 Maximum: 9223372036854775807
index	Integer	The disk serial number, starting from 0. Minimum: 0 Maximum: 2147483647
name	String	The disk name. Minimum: 0 Maximum: 255
disktype	String	Disk type, which is the same as the volumetype field. Its value comes from EVS. For details, see the description of the volume_type field in the response parameters in the section "Querying Details About a Single EVS Disk" in the EIP API document. Minimum: 0 Maximum: 255
size	Long	The disk size in GB. Minimum: 0 Maximum: 9223372036854775807
device_use	String	The disk function. Minimum: 0 Maximum: 255

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum: 0 Maximum: 255
error_msg	String	The error message. Minimum: 0 Maximum: 255
encoded_authorization_message	String	The encrypted authorization information. Minimum: 0 Maximum: 65535
error_param	Array of strings	Error parameters. Minimum: 0 Maximum: 65535 Array Length: 1 - 20
details	Array of details objects	The error details. Array Length: 1 - 20

**Table 11** details
Parameter	Type	Description
error_code	String	The SMS error code. Minimum: 0 Maximum: 65535
error_msg	String	The SMS error message. Minimum: 0 Maximum: 65535

Example Requests

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 Responses

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

See Error Codes.

Parent topic: Template Management

Previous topic: Deleting a Template

Next topic: Modifying a Template

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.