API Introduction

Create a cloud server
based on a CSBS backup. The specification, image, data disks, system disk, and
other data of the new cloud server are the same as that of the backup.

Preparations :

Construct a request:
Before you call an API, you must learn how to construct a request. For details,
see Construct a
Request.

Authentication: OpenAPI
requests need to be encrypted. For details, see Authentication.

Billing mode: Confirm
the billing mode of the cloud server to be created. For more information, refer
to Billing Modes.

Networking: Plan the
networking of the cloud server to be created. For more information, refer to ECS-Networks.

Cautions

Cost estimation: For
more information, refer to Billing Items of
ECS.

User quota: Confirm
your quotas in different resource pools by calling the Query the User Quota
API.

Asynchronous API: This
is an asynchronous API. You will get the master order ID after payment. You can
later call the Query
a UUID based on an Order ID API to check the order info or resource ID by
master order ID.

Enterprise project:
Since resources are isolated, only resources in the same enterprise project as
the cloud server can be mounted, including virtual private clouds (VPCs),
security groups, Elastic IP addresses (EIPs), subnets, and other network
resources.

API Restrictions

1. Limitations: This
API (beta) is only available to resource pools including Lhasa 3, Shanghai 7,
Guangzhou 6, Chenzhou 2, Changsha 3, Beijing 5, Inner Mongolia 6, Nanjing 3,
Chongqing 2, Hefei 2, Chengdu 4, Jinzhong, Kunming 2, Urumchi 27, Fuzhou 25, Hengyang
3, Changsha 37, Zhangjiajie 2, North 2, Beijing 1 (Central Enterprises), East
1, Shanghai 32, Shanghai 33, and Shanghai 36.

2. At least one backup
exists.

3. The backup must be
available.

4. Prepaid accounts
cannot create pay-as-you-go cloud servers.

5. If you set the
billing mode to Subscription, you must specify the subscription cycle and
duration.

6. If you set extIP to
1 (the system assigns you an EIP), you must specify the version (ipVersion) and
bandwidth capacity (bandwidth) of the EIP. If you set extIP to 2 (use an
existing EIP), you must specify the version (ipVersion) and ID (eipID or ipv6AddressID)
of the EIP.

7. When you mount an
Elastic network interface (ENI), the subnet must be corresponding to the VPC to
ensure that the subnet is an IP block under the VPC.

URI

<span lang="EN-US">POST /v4/ecs/backup/create-instance</span>

Path Parameter

None

Query Parameter

None

Request Parameters

Request Header Parameter

None

Request Body Parameter

Parameter	Required or Not	Parameter Type	Description	Example	Lower-level Object
clientToken	Yes	String	Client stub to ensure order idempotence. This parameter value must be unique within the same account. Requests with the same ClientToken value are considered as one request. The retention period is 24 hours.	4cf2962d-e92c-4c00-9181-cfbb2218636c
regionID	Yes	String	Resource pool ID. Enter the resource pool of the backup to ensure the new cloud server is at the same resource pool as the backup.	bb9fdb42056f11eda1610242ac110002
instanceName	Yes	String	Cloud server name. The naming rule may vary with the operating system. Windows: The length must in 2 to 15 characters and can contain uppercase letters, lowercase letters, digits, and hyphens (-). The name cannot start or end with a hyphen (-), use multiple hyphens (-) in line, or contain only digits. Other operating systems: The length must be in 2 to 64 characters and can contain uppercase letters, lowercase letters, digits, and hyphens (-). You can separate the name into segments with periods (.). The name cannot start or end with a hyphen (-) or a period (.), or use multiple hyphens (-) or periods (.) in line.	ecm-3300
displayName	Yes	String	Display name of the cloud server. The name length must be in 2 to 63 characters.	ecm-3300
instanceBackupID	Yes	String	CSBS backup ID. You can refer toProduct Definition - CSBS Backupsto learn more about CSBS. More APIs:Query the CSBS Backup ListandCreate a CSBS Backup.	b6e2966d-7b1c-385e-abe4-d940caa273b7
vpcID	Yes	String	VPC ID. You can refer toProduct Definition - VPCto learn more about VPC. More APIs:Query the VPC ListandCreate a VPC.	4797e8a1-722d-4996-9362-458001813e41
onDemand	Yes	Boolean	Whether to order on demand. Value range: false (subscription) and true (pay-as-you-go). You can refer toBilling Modesto learn about cloud server billing modes. Note: If you set the parameter to false, the cycleCount and cycleType parameters must be specified.	false
secGroupList	No	Array of Strings	Security group ID list. You can refer toSecurity Group Overviewto learn more about security groups. More APIs:Query the Security Group ListandCreate a Security Group.	["sg-ulk99r4wja"]
networkCardList	Yes	Array of Objects	ENI list. You can refer toENI Overviewto learn more about ENIs.		networkCards
extIP	Yes	String	Specify whether to use the EIP. Value range: 0: do not use. 1: use the automatically assigned one. 2: use existing one.	2
ipVersion	No	String	EIP version. Value range: ipv4 and ipv6. Default value: ipv4. Note: You must check whether the resource pool supports IPv6 addresses.	ipv4
bandwidth	No	Integer	Bandwidth capacity (Mbit/s). Value range: [1, 2000].	100
ipv6AddressID	No	String	IPv6 address ID. Multi-AZ resource pools do not support IPv6 addresses.	ddabc7f0-2121-4121-bf85-ec090b3a73fc
eipID	No	String	EIP ID. You can refer to [Product Definition - ElPs] to learn more about EIPs. More APIs: Query EIP based on Region (https://www.ctyun.cn/document/10026753/10026909) andCreate an EIP.	eip-9jpeyl0frh
affinityGroupID	No	String	Cloud server group ID. More APIs:Query the Cloud Server Group List or Details,Query the Cloud Server Group List or Details (Old),Create a Cloud Server Group, and`Creating Cloud Server Group (Old)
(href="https://www.ctyun.cn/document/10026730/10039548")`.	924b95c4-68d9-3fbe-835d-fee46397feda
keyPairID	No	String	SSH key pair ID. You can refer toSSH Key Pairsto learn more. More APIs:Query One or More SSH Key Pairs,Query the One or More SSH Key Pairs (old),Create a SSH Key Pair, andCreate a SSH Key Pair (Old).	c57d0626-8a82-407b-a910-b454907778c3
userPassword	No	String	User password. The password must within 8 to 30 characters in length and must contain three of uppercase letters, lowercase letters, digits, and special characters. The password cannot start with a forward slash (/). The special characters support: ()`~!@#$%^&*_-+=｜{}[]:;'<>,.?/.	HelloCtyun.13
cycleCount	No	Integer	Subscription duration. This parameter must be used with cycleType. Note: The duration cannot exceed 60 months (5 years).	6
cycleType	No	String	Subscription duration type. Value range: MONTH and YEAR.	MONTH
autoRenewStatus	No	Integer	Specify whether to enable auto-renewal. Value range: 0: false. 1: true. Note: If you subscribe by month, the auto-renewal duration is three months. If you subscribe by year, the renewal duration is 1 year.	1
userData	No	String	Custom data. This data must be encoded in Base64. The encoded length must be within 1 to 16,384 characters. Non-multi-AZ resource pools do not support this parameter.	ZWNobyBoZWxsbyBnb3N0YWNrIQ==
projectID	No	String	Enterprise project ID. The enterprise project management feature allows you to manage resource by enterprise project and manage resources and members within each project.	0

Table networkCardList

Parameter	Required or Not	Parameter Type	Description	Example
nicName	No	String	ENI name. The name must be within 2 to 63 characters in length. Chinese characters are not supported.	nic-0701
fixedIP	No	String	Intranet IPv4 Address	192.168.0.2
isMaster	Yes	Boolean	Specify whether this is the master ENI. Value range: true and false.	true
subnetID	Yes	String	Subnet ID.	a90eebf0-d798-5017-b9f0-9468bb2301c2

Response Parameter

Parameter	Parameter Type	Description	Example	Lower-level Object
statusCode	Integer	Return status code (800 indicates success, 900 indicates failure).	800
errorCode	String	Business code, a three-segment code in the format of product.module.code. Refer toError Codesfor more details.	Openapi.PatternCheck.NotValid
message	String	Error message upon failure.	SUCCESS
description	String	Error description upon failure.	Successful
returnObj	Object	Data returned upon success. Refer to Table returnObj.		returnObj

Table returnObj

Parameter	Parameter Type	Description	Example
masterOrderID	String	Master order ID. The calling party can check status of the order and resources based on masterOrderID.	235145e4489811eda8330242ac110002
masterOrderNO	String	Order Number	20221010142913884246
masterResourceID	String	Master resource ID.	3cda4bf48cac42b8b7db3b279d2fc6fb
regionID	String	Resource Pool ID	81f7728662dd11ec810800155d307d5b

Sample Request

Request Header

None

Request Body

Example: Use the CSBS backup to create a subscription cloud server. The resource pool is AZ1 in East 1. The billing mode is subscription with a six-month duration. The auto-renewal duration is three months.

The new cloud server uses the same specifications, image, system disk, and data disk as the CSBS backup. Image: CTyunOS 2.0.1 64-bit. Specification: s7.small.1.

System disk: 40 GiB SATA disk. Data disk: 20 GiB SATA disk. Outbound bandwidth over the Internet: 10 Mbit/s. The auto assigned EIP is an IPv4 address and bound with the mater ENI. The auto assigned intranet address is also an IPv4 one.

Security group: Default-Security-Group. A hard anti-affinity cloud server group is used. Coupon: 
￥
20.55. Instance name: apiCreate-test. Log in password: HelloCtyun.13.

Quantity: 1. The instance is included in the enterprise project by default.

                  "regionID": "bb9fdb42056f11eda1610242ac110002",

                  "instanceBackupID":"ecd49382-8280-4d1a-8d87-2a4c004ee78d",

                  "instanceName": "apiCreate-test",

                  "displayName": "apiNew-06",

                  "vpcID": "vpc-ttxdh00rjf",

                  "secGroupList":["sg-ulk99r4wja"],

                  "affinityGroupID":"924b95c4-68d9-3fbe-835d-fee46397feda",

                  "networkCardList": [{

                                     "subnetID": "subnet-ty87lkna06",

                                     "isMaster": true

}],

                  "extIP": "1",

                  "bandwidth":10,

    "ipVersion":"ipv4",

                  "onDemand": false,

                  "cycleCount": 6,

                  "cycleType": "MONTH",

                  "userPassword":"HelloCtyun.13",

                  "clientToken": "createTest1301",

                  "payVoucherPrice": 20.55,

                  "autoRenewStatus":1

Response Example

                  "returnObj": {

                                     "regionID": "81f7728662dd11ec810800155d307d5b",

                                     "masterOrderID": "107e901c449611ed8b6a0242ac110002",

                                     "masterResourceID": "34c7cc05a52b48eda0a84e34a82b346b",

                                     "masterOrderNO": "20221009163836430197"

},

                  "message": "SUCCESS",

                  "description": "Successful",

                  "statusCode": 800

Status Code

Status Code	Description
200	Indicate that the request succeeded

Error Codes

errorCode	Description
Openapi.PatternCheck.NotValid	The request parameter is invalid.
EcsBackup.Parameter.InvalidError	The request parameter is invalid.
Ecs.Instance.NameNotValid	The cloud server name is invalid.
EcsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.
EcsBackup.RegionInfo.AccessFailed	Failed to query the resource pool. Please try again. If the failure keeps happening, please submit a ticket.
EcsBackup.Parameter.RegionID	The resource pool information is empty. Check whether the region ID is valid.
Openapi.CustomerAdmin.AccessFailed	Failed to query user information. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.CustomerAdmin.FormatError	The format to query user information is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.PermissionPatternCheck.NotValid	The request parameter is invalid.
Openapi.PermissionAdmin.AccessFailed	Failed to query user license. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.PermissionAdmin.FormatError	The format to query user license of the resource pool is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.PermissionCheck.UnknowError	Failed to query user license. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.ResourcesPatternCheck.NotValid	The request parameter to obtain use resources is invalid.
Openapi.ResourcesWorkorder.AccessFailed	Failed to query existing user resources. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.ResourcesAdmin.FormatError	The format to query existing user resources is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.ResourcesFormat.FormatError	The format to query existing user resources is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.ResourcesCheck.UnknowError	Failed to query existing user resources. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.QuotaCheck.UnknowError	Failed to check the quota. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.QuotaCheck.QuotaExceed	The user quota exceeds the system quota.
Openapi.FlavorAdmin.AccessFailed	Failed to query the cloud server specification. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.FlavorAdmin.FormatError	The format to query user information is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
EcsBackup.Instance.FlavorNotFound	The cloud server specification is not found. Check whether the cloud server specification is valid.
EcsBackup.Instance.FlavorSoldOut	Cloud servers of this specification are all sold out. Please submit a ticket.
EcsBackup.Instance.DiskTypeNotSupport	The data disk type is not supported.
Openapi.EbsCheck.QuotaExceed	The disk quota in a single order exceeds the system limit.
Openapi.KmsCheck.NotSupported	The disk encryption is not supported.
Openapi.EbsCheck.NotFound	The key information does not exist.
Openapi.Kmsformat.FormatError	The format to query key information is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.Kmsyacos.AccessFailed	Failed to query key information. Please try again. If the failure keeps happening, please submit a ticket.
EcsBackup.Instance.EbsSoldOut	Disks of this specification have been sold out.
Openapi.VpcWorkorder.AccessFailed	Failed to query VPC information. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.VpcFormat.FormatError	The format to query VPC information is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.VpcCheck.NotFound	The VPC is not found. Check whether the VPC is valid.
Openapi.SubnetCheck.NotFound	The subnet is not found. Check whether the subnet is valid.
Openapi.NetcardCheck.QuotaExceed	The ENI quota exceeds the system limit.
Openapi.SubnetWorkorder.AccessFailed	Failed to query the VPC IP address. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.SubnetFormat.FormatError	The format to query the VPC IP address is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
EcsBackup.FixedIP.NotValid	The Intranet IP address is used or does not belong to the selected CIDR block.
EcsBackup.Instance.PublicIpInvalid	The parameter related to the automatically assigned EIP is invalid.
EcsBackup.PublicIpWorkorder.AccessFailed	Failed to query the EIP information. Please try again. If the failure keeps happening, please submit a ticket.
EcsBackup.PublicIpFormat.FormatError	The format to query the EIP information is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
EcsBackup.PublicIpCheck.NotFound	The EIP is not found. Check whether the EIP is valid.
EcsBackup.PublicIpCheck.SoldOut	This EIP is sold out. Please submit a ticket.
Openapi.KeypairWorkorder.AccessFailed	Failed to query the key pair information. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.KeypairFormat.FormatError	The format to query the key pair is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.KeypairCheck.NotFound	The key pair is not found. Check whether the key pair is valid.
Openapi.KeypairCheck.UnknowError	Failed to check the key pair. Please try again. If the failure keeps happening, please submit a ticket.
Ecs.Instance.VmGroupNoPermission	The user is not authorized to access the enterprise project of the cloud server group. Check whether the cloud server group is valid.
Openapi.VmgroupWorkorder.AccessFailed	Failed to query the cloud server group information. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.VmgroupFormat.FormatError	The format to query the cloud server is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.VmgroupCheck.NotFound	The cloud server group is not found. Check whether the cloud server group is valid.
Openapi.VmgroupCheck.UnknowError	Failed to check the cloud server group. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.SecGroupsWorkorder.AccessFailed	Failed to query the security group information. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.SecGroupsFormat.FormatError	The format to query the security group is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
Openapi.SecGroupsCheck.NotFound	The security group is not found. Check whether the security group is valid.
Openapi.SecGroupsCheck.UnknowError	Failed to check the security group. Please try again. If the failure keeps happening, please submit a ticket.
Ecs.SecGroups.NotFound	The default security group is not found. Please specify a security group and try again.
Image.ImageWorkorder.AccessFailed	Failed to query the image. Please try again. If the failure keeps happening, please submit a ticket.
Image.ImageFormat.FormatError	The format to query the image is invalid. Please try again. If the failure keeps happening, please submit a ticket.
Image.ImageCheck.NotFound	The image does not exist or is not valid. Check whether the image information is valid.
Image.ImageCheck.UnknowError	Failed to query the image information. Please try again. If the failure keeps happening, please submit a ticket.
Ecs.SaleYacos.AccessFailed	Failed to query the sold-out information. Please try again. If the failure keeps happening, please submit a ticket.
Ecs.SaleCheck.UnknowError	Failed to query the sold-out information. Please try again. If the failure keeps happening, please submit a ticket.
Ecs.Saleformat.FormatError	The format to query sold-out information is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
EcsBackup.Order.ProcFailed	Failed to process the order.
EcsBackup.OrderCheck.UserForbiddenOnDemand	The user cannot purchase a pay-as-you-go instance.
Openapi.QuotaCheck.QuotaExceed	The user quota exceeds the system quota.
EcsBackup.Parameter.InvalidCycleCount	Invalid request parameter: [cycleCount]. Enter a valid one.
EcsBackup.Parameter.InvalidCycleType	Invalid request parameter: [cycleType]. Enter a valid one.

Cloud Server Backup Service

Create a Cloud Server based on a Backup