Querying Information About a Template with a Specified ID

Function

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

URI

GET /v3/vm/templates/{id}

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
id	Yes	String	Specifies the ID of the template to be queried. Minimum length: 0 characters Maximum length: 255 characters

Request

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum length: 1 character Maximum length: 16,384 characters

Response

Status code: 200

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

**Table 4** **TemplateResponseBody** field description
Parameter	Type	Description
id	String	Specifies the template ID. Minimum length: 0 characters Maximum length: 255 characters
name	String	Specifies 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	Specifies the region where the target server will reside. Minimum length: 0 characters Maximum length: 255 characters
projectid	String	Specifies the project ID. Minimum length: 0 characters Maximum length: 255 characters
target_server_name	String	Specifies the name of the target server. Minimum length: 0 characters Maximum length: 255 characters
availability_zone	String	Specifies the AZ of the target server. Minimum length: 0 characters Maximum length: 255 characters
volumetype	String	Specifies the disk type. The value can be: SAS SSD SATA
flavor	String	Specifies the flavor of the target server. Minimum length: 0 characters Maximum length: 255 characters
vpc	VpcObject object	Specifies the VPC information.
nics	Array of Nics objects	Specifies the NIC information. Multiple NICs are supported. If the target server is automatically created, enter only one NIC and set the ID to autoCreate.
security_groups	Array of SgObject objects	Specifies the security group information. Multiple security groups are supported. If the target server is automatically created, enter only one security group and set the ID to autoCreate.
publicip	PublicIp object	Specifies the information about the public IP address that will be used for migration.
disk	Array of TemplateDisk objects	Specifies the disk information.
data_volume_type	String	Specifies the data disk type. The value can be: SAS SSD SATA
target_password	String	Specifies the password for logging in to the target server. Minimum length: 0 characters Maximum length: 1,024 characters

**Table 5** **VpcObject** field description
Parameter	Type	Description
id	String	Specifies the VPC ID. If the target server is created automatically, set this parameter to autoCreate. Minimum length: 1 character Maximum length: 255 characters
name	String	Specifies the VPC name. Minimum length: 1 character Maximum length: 255 characters
cidr	String	Specifies the VPC CIDR block. The default value is 192.168.0.0/16. Minimum length: 1 character Maximum length: 255 characters

**Table 6** **Nics** field description
Parameter	Type	Description
id	String	Specifies the subnet ID. If the target server is created automatically, set this parameter to autoCreate. Minimum length: 0 characters Maximum length: 255 characters
name	String	Specifies the subnet name. Minimum length: 0 characters Maximum length: 255 characters
cidr	String	Specifies the subnet gateway/mask. Minimum length: 0 characters Maximum length: 255 characters
ip	String	Specifies the IP address of the target server. 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** field description
Parameter	Type	Description
id	String	Specifies the security group ID. Minimum length: 0 characters Maximum length: 255 characters
name	String	Specifies the security group name. Minimum length: 0 characters Maximum length: 255 characters

**Table 8** **PublicIp** field description
Parameter	Type	Description
type	String	Specifies the EIP type. The default value is 5_bgp. Minimum length: 0 characters Maximum length: 255 characters
bandwidth_size	Integer	Specifies the bandwidth size in Mbit/s. The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows: The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included). 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

**Table 9** **TemplateDisk** field description
Parameter	Type	Description
index	Integer	Specifies the disk serial number, starting from 0 Minimum value: 0 Maximum value: 2147483647
name	String	Specifies the disk name. Minimum length: 0 characters Maximum length: 255 characters
disktype	String	Specifies the disk type. The value is the same as that of volumetype. Minimum length: 0 characters Maximum length: 255 characters
size	Long	Specifies the disk size in GB. Minimum value: 0 Maximum value: 9223372036854775807

Example Request

Query 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

{
  "template" : {
    "id" : "6874cb49-48bb-4875-975d-4bca464d8472",
    "name" : "test1025",
    "region" : "region",
    "target_server_name" : "",
    "availability_zone" : "availability_zone",
    "projectid" : "353b5ccc3deb4abc8ac8291bf468f69c",
    "flavor" : "s2.large.2",
    "volumetype" : "",
    "vpc" : {
      "id" : "a1f9de64-bf00-4c4f-8c97-ebc65f9e1e2e",
      "name" : "vpc-testcloud(192.168.0.0/16)"
    },
    "nics" : [ {
      "id" : "04ba310f-34df-4df3-9385-11552aafff03",
      "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"
    },
    "disks" : [ {
      "index" : 0,
      "name" : "system",
      "disktype" : "",
      "size" : 40
    } ]
  }
}