Listing Templates
Function
This API is used to query the list of templates used for creating target servers. You can use this template to create target servers if you choose to create a server as the target server.
Calling Method
For details, see Calling APIs.
URI
GET /v3/vm/templates
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
No |
String |
The template name. Minimum length: 0 characters Maximum length: 255 characters |
|
availability_zone |
No |
String |
The AZ. Minimum length: 0 characters Maximum length: 255 characters |
|
region |
No |
String |
Region ID Minimum length: 0 characters Maximum length: 255 characters |
|
limit |
No |
Integer |
The number of records displayed on each page. If this parameter is not transferred, the default value 50 is used. Minimum value: 0 Maximum value: 100 Default value: 50 |
|
offset |
No |
Integer |
The offset. If this parameter is not transferred, the default value 0 is used. Minimum value: 0 Maximum value: 65535 Default value: 0 |
Request
|
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
|
Parameter |
Type |
Description |
|---|---|---|
|
count |
Integer |
The number of templates. Minimum value: 0 Maximum value: 65535 |
|
templates |
Array of TemplateResponseBody objects |
The template information. Array length: 0 to 65,535 characters |
|
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: |
|
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 public IP address information. |
|
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: |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 the template list.
GET https://{endpoint}/v3/vm/templates
Example Response
Status code: 200
OK
{
"count" : 9,
"templates" : [ {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "test",
"region" : "region",
"availability_zone" : "availability_zone",
"projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001",
"flavor" : "s2.large.2",
"volumetype" : "",
"image_id" : "",
"vpc" : {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "vpc-dfdb"
},
"nics" : [ {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "subnet-dfdb(192.168.1.0/24)",
"cidr" : "192.168.1.0/24",
"ip" : ""
} ],
"security_groups" : [ {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "default(Inbound:tcp/8900,8899,3389,22; Outbound:--)"
} ]
}, {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "test1",
"region" : "region",
"availability_zone" : "availability_zone",
"projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001",
"flavor" : "s6.large.2",
"volumetype" : "",
"image_id" : "",
"vpc" : {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "vpc-13d6"
},
"nics" : [ {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "subnet-13d6(192.168.1.0/24)",
"cidr" : "192.168.1.0/24",
"ip" : ""
} ],
"security_groups" : [ {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "sms-1568190885(Inbound:tcp/8900,8899,3389; Outbound:--)"
} ]
}, {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "test2",
"region" : "region",
"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" : [ ]
}, {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "fdff",
"region" : "region",
"availability_zone" : "availability_zone",
"projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001",
"flavor" : "s2.large.2",
"volumetype" : "",
"image_id" : "",
"vpc" : {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "vpc-migration(192.168.0.0/16)"
},
"nics" : [ {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "subnet-cf42(192.168.5.0/24)",
"cidr" : "192.168.5.0/24",
"ip" : ""
} ],
"security_groups" : [ {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "sg-smt-test(Inbound:tcp/3389,8899,22,8900; Outbound:--)"
} ]
}, {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "test3",
"region" : "region",
"availability_zone" : "availability_zone",
"projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001",
"flavor" : "s2.medium.2",
"volumetype" : "",
"image_id" : "",
"vpc" : { },
"nics" : [ ],
"security_groups" : [ ]
}, {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "test_linux_childproj",
"region" : "region",
"availability_zone" : "availability_zone",
"projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001",
"flavor" : "s2.small.1",
"volumetype" : "SATA",
"image_id" : "",
"vpc" : {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "sms-1567992634(192.168.0.0/16)"
},
"nics" : [ {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "sms-1567992646(192.168.0.0/16)",
"cidr" : "192.168.0.0/16",
"ip" : ""
} ],
"security_groups" : [ {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "sg-7e50(Inbound:tcp/8900,8899,3389,22; Outbound:--)"
} ]
}, {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "12212",
"region" : "region",
"availability_zone" : "availability_zone",
"projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001",
"flavor" : "s2.large.2",
"volumetype" : "",
"image_id" : "",
"vpc" : {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "vpc-migration(192.168.0.0/16)"
},
"nics" : [ {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "subnet-migration(192.168.1.0/24)",
"cidr" : "192.168.1.0/24",
"ip" : ""
} ],
"security_groups" : [ {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "SMT-Windows(Inbound:tcp/8443,8899,8900,22,3389;icmp; Outbound:--)"
} ]
}, {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "test4",
"region" : "region",
"availability_zone" : "availability_zone",
"projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001",
"flavor" : "s2.medium.2",
"volumetype" : "SATA",
"image_id" : "",
"vpc" : { },
"nics" : [ ],
"security_groups" : [ ]
}, {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "dddd",
"region" : "region",
"availability_zone" : "availability_zone",
"projectid" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001",
"flavor" : "s2.large.2",
"volumetype" : "",
"image_id" : "",
"vpc" : {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "sms-1566979232(192.168.0.0/16)"
},
"nics" : [ {
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
"name" : "sms-1566979244(192.168.0.0/16)",
"cidr" : "192.168.0.0/16",
"ip" : ""
} ],
"security_groups" : [ ]
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Response returned. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
