Creating a Template

Function

This API is used to create a template.

URI

POST /v3/vm/templates

Request

**Table 1** 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

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
template	Yes	TemplateRequest object	Specifies the template information.

**Table 3** **TemplateRequest** field description
Parameter	Mandatory	Type	Description
name	Yes	String	Specifies the template name. Minimum length: 0 characters Maximum length: 255 characters
is_template	Yes	Boolean	Specifies whether the template is general. If the template is associated with a task, the template is not a general template.
region	Yes	String	Specifies the region where the target server will reside. Minimum length: 0 characters Maximum length: 255 characters
projectid	Yes	String	Specifies the project ID. Minimum length: 0 characters Maximum length: 255 characters
target_server_name	No	String	Specifies the name of the target server. Minimum length: 0 characters Maximum length: 255 characters
availability_zone	No	String	Specifies the AZ of the target server. Minimum length: 0 characters Maximum length: 255 characters
volumetype	No	String	Specifies the disk type. The value can be: SAS SSD SATA
flavor	No	String	Specifies the flavor of the target server. Minimum length: 0 characters Maximum length: 65,535 characters
vpc	No	VpcObject object	Specifies the VPC information.
nics	No	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	No	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	No	PublicIp object	Specifies the information about the public IP address that will be used for migration.
disk	No	Array of TemplateDisk objects	Specifies the disk information.
data_volume_type	No	String	Specifies the data disk type. The value can be: SAS SSD SATA
target_password	No	String	Specifies the password for logging in to the target server. Minimum length: 0 characters Maximum length: 1,024 characters

**Table 4** **VpcObject** field description
Parameter	Mandatory	Type	Description
id	Yes	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	Yes	String	Specifies the VPC name. Minimum length: 1 character Maximum length: 255 characters
cidr	No	String	Specifies the VPC CIDR block. The default value is 192.168.0.0/16. Minimum length: 1 character Maximum length: 255 characters

**Table 5** **Nics** field description
Parameter	Mandatory	Type	Description
id	Yes	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	Yes	String	Specifies the subnet name. Minimum length: 0 characters Maximum length: 255 characters
cidr	Yes	String	Specifies the subnet gateway/mask. Minimum length: 0 characters Maximum length: 255 characters
ip	No	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 6** **SgObject** field description
Parameter	Mandatory	Type	Description
id	Yes	String	Specifies the security group ID. Minimum length: 0 characters Maximum length: 255 characters
name	Yes	String	Specifies the security group name. Minimum length: 0 characters Maximum length: 255 characters

**Table 7** **PublicIp** field description
Parameter	Mandatory	Type	Description
type	Yes	String	Specifies the EIP type. The default value is 5_bgp. Minimum length: 0 characters Maximum length: 255 characters
bandwidth_size	Yes	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 8** **TemplateDisk** field description
Parameter	Mandatory	Type	Description
index	Yes	Integer	Specifies the disk serial number, starting from 0. Minimum value: 0 Maximum value: 2147483647
name	Yes	String	Specifies the disk name. Minimum length: 0 characters Maximum length: 255 characters
disktype	Yes	String	Specifies the disk type. The value is the same as that of volumetype. Minimum length: 0 characters Maximum length: 255 characters
size	Yes	Long	Specifies the disk size in GB. Minimum value: 0 Maximum value: 9223372036854775807

Response

Status code: 200

**Table 9** Response body parameters
Parameter	Type	Description
id	String	Specifies the ID of the newly created template returned by SMS. Minimum length: 0 characters Maximum length: 255 characters

Example Request

Create a template during the creation of a migration task.

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

{
  "template" : {
    "name" : "",
    "is_template" : false,
    "region" : "region",
    "target_server_name" : "abcd",
    "availability_zone" : "availability_zone",
    "volumetype" : "",
    "vpc" : {
      "id" : "00cda768-ef7b-40ac-a555-84b0c2b85d89",
      "name" : "sms-1566979232(192.168.0.0/16)"
    },
    "security_groups" : [ {
      "id" : "00d57b53-c00b-4d0a-975b-0f3c4fcf93c8",
"name": "kubernetes.io-default-sg (Inbound: udp/1-65535;tcp/22,1-65535,3389; Outbound: --) "
    } ],
    "nics" : [ {
      "id" : "b5891372-f48c-4b3c-9f7a-ab58da5baa93",
      "name" : "sms-1566979244(192.168.0.0/16)",
      "cidr" : "192.168.0.0/16",
      "ip" : ""
    } ],
    "flavor" : "s2.medium.2",
    "publicip" : {
      "type" : "5_bgp",
      "bandwidth_size" : 5,
      "bandwidth_share_type" : "PER"
    },
    "disks" : [ {
      "index" : 0,
      "name" : "system",
      "disktype" : "",
      "size" : 40,
      "$$hashKey" : "object:3065"
    } ]
  }
}

Create a template directly.

POST https://{endpoint}/v3/vm-templates

{
  "template" : {
    "name" : "xxxx",
    "is_template" : true,
    "region" : "region",
    "target_server_name" : "ggg-win16-t",
    "availability_zone" : "availability_zone",
    "target_password" : "********",
    "flavor" : "c3.medium.2",
    "vpc" : {
      "id" : "e7069fc1-e09e-4ded-8570-6b3bb2a5893b",
      "name" : "Migrate-SSd-1",
      "cidr" : "192.168.0.0/16"
    },
    "nics" : [ {
      "id" : "c5c7d1a2-a204-4cee-8f11-26ac97a50d13",
      "name" : "Migrate-SSd-35",
      "cidr" : "192.168.0.0/16",
      "ip" : ""
    } ],
    "security_groups" : [ {
      "id" : "003ae8fc-066a-45cd-8a9c-995b1def8c26",
      "name" : "Migrate-dddd"
    } ],
    "disk" : [ {
      "id" : "0",
      "index" : 0,
      "name" : "Disk 0",
      "diskType" : "SATA",
      "size" : 40,
      "device_use" : "BOOT"
    } ],
    "volumetype" : "SATA",
    "publicip" : {
      "type" : "5_g-vm",
      "bandwidth_size" : 10,
      "bandwidth_share_type" : "PER"
    }
  }
}

Example Response

Status code: 200

{
  "id" : "2bf4344f-8f1f-414e-bb1b-8c2f59ada67f"
}

Status Codes

Status Code	Description
200	OK

Error Codes

See Error Codes.

Parent topic: Template Management

Previous topic: Template Management

Next topic: Listing Templates

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.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot