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 parameter
Parameter	Mandatory	Type	Description
id	Yes	String	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	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	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 name of the target server. Minimum length: 0 characters Maximum length: 255 characters
availability_zone	String	The AZ. Minimum length: 0 characters Maximum length: 255 characters
volumetype	String	The disk type. The value can be: SAS SSD SATA
flavor	String	The flavor of the target server. 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. If the target server is automatically created, enter only one NIC and set the ID to autoCreate. Array length: 0 to 65,535 characters
security_groups	Array of SgObject objects	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. Array length: 0 to 65,535 characters
publicip	PublicIp object	The information about the public IP address that will be used for migration.
disk	Array of TemplateDisk objects	The disk information. Array length: 0 to 65,535 characters
data_volume_type	String	The disk type. The value can be: SAS SSD SATA
target_password	String	The password for logging in to the target server. 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 field description
Parameter	Type	Description
id	String	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	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 field description
Parameter	Type	Description
id	String	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	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 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	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 field description
Parameter	Type	Description
type	String	The EIP type. The default value is 5_bgp. 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	The bandwidth type, shared or dedicated. Minimum length: 0 characters Maximum length: 255 characters

Table 9 TemplateDisk field description
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	The disk type. The value is the same as that of volumetype. 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

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" : "",
    "image_id" : "",
    "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"
    },
    "disk" : [ {
      "index" : 0,
      "name" : "system",
      "disktype" : "",
      "size" : 40
    } ]
  }
}

Status Codes

Status Code	Description
200	Response returned.

Error Codes

For details, see Error Codes.

Parent topic: Template Management

Была ли эта статья полезна?

Поддержка Юридические документы