Help Center> Server Migration Service> API Reference> APIs V3.0> Template Management> Listing Templates
Updated on 2024-03-30 GMT+08:00
View PDF

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

Table 1 Query parameters

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

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

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
Table 4 TemplateResponseBody

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 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:

  • 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 the template list.

GET https://{endpoint}/v3/vm/templates

Example Response

Status code: 200

OK

{
  "count" : 9,
  "templates" : [ {
    "id" : "3db302e8-95de-478c-a892-8a083f2d269b",
    "name" : "test",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "c6e3047501b340a4a79fb94dad453676",
    "flavor" : "s2.large.2",
    "volumetype" : "",
    "image_id" : "",
    "vpc" : {
      "id" : "4d329f4b-70ee-4996-ba9a-5b5ec63a7c2e",
      "name" : "vpc-dfdb"
    },
    "nics" : [ {
      "id" : "d807e702-a59a-480c-aa5e-23449775d107",
      "name" : "subnet-dfdb(192.168.1.0/24)",
      "cidr" : "192.168.1.0/24",
      "ip" : ""
    } ],
    "security_groups" : [ {
      "id" : "c922bce4-1892-44bc-a58e-f250a666939a",
      "name" : "default(Inbound:tcp/8900,8899,3389,22; Outbound:--)"
    } ]
  }, {
    "id" : "708847ae-f013-4b1a-8ea8-6cfa1e94237d",
    "name" : "test1",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "05a6d0f34380269c2f02c016826878ea",
    "flavor" : "s6.large.2",
    "volumetype" : "",
    "image_id" : "",
    "vpc" : {
      "id" : "ee756d79-6223-464b-a3f4-a1e048309fdb",
      "name" : "vpc-13d6"
    },
    "nics" : [ {
      "id" : "768b0328-7b01-4d34-9afc-03e88025ff05",
      "name" : "subnet-13d6(192.168.1.0/24)",
      "cidr" : "192.168.1.0/24",
      "ip" : ""
    } ],
    "security_groups" : [ {
      "id" : "bf736dd6-7e7e-42ba-a1d3-b3a9f6a5fda5",
      "name" : "sms-1568190885(Inbound:tcp/8900,8899,3389; Outbound:--)"
    } ]
  }, {
    "id" : "6874cb49-48bb-4875-975d-4bca464d8472",
    "name" : "test2",
    "region" : "region",
    "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" : [ ]
  }, {
    "id" : "76b8b2b2-b730-4000-b0a3-048f80105dd2",
    "name" : "fdff",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "00924d0ad2df4f21ac476dd9f32888f1",
    "flavor" : "s2.large.2",
    "volumetype" : "",
    "image_id" : "",
    "vpc" : {
      "id" : "d6f34811-1a4d-4686-911a-982c8e2c1f1b",
      "name" : "vpc-migration(192.168.0.0/16)"
    },
    "nics" : [ {
      "id" : "85ca07d5-7d0d-40ce-b1b2-9dd2db14f840",
      "name" : "subnet-cf42(192.168.5.0/24)",
      "cidr" : "192.168.5.0/24",
      "ip" : ""
    } ],
    "security_groups" : [ {
      "id" : "a563735f-4183-40de-854f-5ba2cb26496d",
      "name" : "sg-smt-test(Inbound:tcp/3389,8899,22,8900; Outbound:--)"
    } ]
  }, {
    "id" : "382f66f9-b948-4bee-b2a8-50b9d3461c81",
    "name" : "test3",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "00924d0ad2df4f21ac476dd9f32888f1",
    "flavor" : "s2.medium.2",
    "volumetype" : "",
    "image_id" : "",
    "vpc" : { },
    "nics" : [ ],
    "security_groups" : [ ]
  }, {
    "id" : "b3c49d20-720a-486f-9d61-b56e6b5bca39",
    "name" : "test_linux_childproj",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "062b8cb8ec8010dc2f42c0167c4631f9",
    "flavor" : "s2.small.1",
    "volumetype" : "SATA",
    "image_id" : "",
    "vpc" : {
      "id" : "b09cebfb-6887-4c58-a353-008dae644f6e",
      "name" : "sms-1567992634(192.168.0.0/16)"
    },
    "nics" : [ {
      "id" : "34688a59-2fd9-422d-a373-87460ef60014",
      "name" : "sms-1567992646(192.168.0.0/16)",
      "cidr" : "192.168.0.0/16",
      "ip" : ""
    } ],
    "security_groups" : [ {
      "id" : "079febf0-cfd2-4722-82d6-a518ea65cd67",
      "name" : "sg-7e50(Inbound:tcp/8900,8899,3389,22; Outbound:--)"
    } ]
  }, {
    "id" : "bda09f7f-3b0c-4bb5-a1ad-3a4d62024774",
    "name" : "12212",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "2c0689c860ad4728a497c91ec0844383",
    "flavor" : "s2.large.2",
    "volumetype" : "",
    "image_id" : "",
    "vpc" : {
      "id" : "4490ab3f-5f0c-42e9-97b7-8b3bc0541e70",
      "name" : "vpc-migration(192.168.0.0/16)"
    },
    "nics" : [ {
      "id" : "350a355b-53db-4e58-80fc-56841ab55021",
      "name" : "subnet-migration(192.168.1.0/24)",
      "cidr" : "192.168.1.0/24",
      "ip" : ""
    } ],
    "security_groups" : [ {
      "id" : "410f9e21-1085-41b8-b5f7-0da0089be8e3",
      "name" : "SMT-Windows(Inbound:tcp/8443,8899,8900,22,3389;icmp; Outbound:--)"
    } ]
  }, {
    "id" : "7d0b56ff-f9c7-478d-9017-120bbdf4b363",
    "name" : "test4",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "00924d0ad2df4f21ac476dd9f32888f1",
    "flavor" : "s2.medium.2",
    "volumetype" : "SATA",
    "image_id" : "",
    "vpc" : { },
    "nics" : [ ],
    "security_groups" : [ ]
  }, {
    "id" : "ec4ac7de-dba1-4602-b327-c228243651db",
    "name" : "dddd",
    "region" : "region",
    "availability_zone" : "availability_zone",
    "projectid" : "2c0689c860ad4728a497c91ec0844383",
    "flavor" : "s2.large.2",
    "volumetype" : "",
    "image_id" : "",
    "vpc" : {
      "id" : "00cda768-ef7b-40ac-a555-84b0c2b85d89",
      "name" : "sms-1566979232(192.168.0.0/16)"
    },
    "nics" : [ {
      "id" : "b5891372-f48c-4b3c-9f7a-ab58da5baa93",
      "name" : "sms-1566979244(192.168.0.0/16)",
      "cidr" : "192.168.0.0/16",
      "ip" : ""
    } ],
    "security_groups" : [ ]
  } ]
}

SDK Sample Code

The sample code is as follows:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.sms.v3.region.SmsRegion;
import com.huaweicloud.sdk.sms.v3.*;
import com.huaweicloud.sdk.sms.v3.model.*;


public class ListTemplatesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        SmsClient client = SmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(SmsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListTemplatesRequest request = new ListTemplatesRequest();
        request.withName("<name>");
        request.withAvailabilityZone("<availability_zone>");
        request.withRegion("<region>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        try {
            ListTemplatesResponse response = client.listTemplates(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdksms.v3.region.sms_region import SmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksms.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

    client = SmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListTemplatesRequest()
        request.name = "<name>"
        request.availability_zone = "<availability_zone>"
        request.region = "<region>"
        request.limit = <limit>
        request.offset = <offset>
        response = client.list_templates(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    sms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := sms.NewSmsClient(
        sms.SmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListTemplatesRequest{}
	nameRequest:= "<name>"
	request.Name = &nameRequest
	availabilityZoneRequest:= "<availability_zone>"
	request.AvailabilityZone = &availabilityZoneRequest
	regionRequest:= "<region>"
	request.Region = &regionRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	response, err := client.ListTemplates(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample code of programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.

Status Codes

Status Code

Description

200

Response returned.

Error Codes

For details, see Error Codes.

Parent Topic: Template Management