CreateVpc

CreateVpc

1. API Description

This API is used to create a VPC.

Note

• VPC are only allowed to be created under VPC network topology. You can use DescribeZones to query zones supporting VPC network topology.

• The quantity of VPCs you can create in one availability region is limited. If you need more, please contact Zenlayer Support.

• This API is an async API. A VPC ID list is returned after the creation request is sent. However, it does not mean the creation has been completed. The status of the VPC will be Pending during the creation. You can use DescribeVpcs to query the status of the VPC. If the status changes from Pending to Available, it means that the VPC has been created successfully; Fail means the VPC has been created failed. Any operations on the VPCs are not allowed while creating.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
zoneId	Yes	String	Zone Id.
vpcName	Yes	String	VPC name to be displayed. This parameter must start and end with a number or a letter, containing 2 to 63 characters. Only letters, numbers, - and periods (.) are supported.
vpcCidrBlock	Yes	String	CIDR block of the subnet. The optional values are as follows: 10.0.0.0/24, 172.16.0.0/24, 192.168.0.0/24 and their VPCs. The subnet IP ranges cannot be overlapped.
vpcDescription	No	String	VPC description.
subnetName	Yes	String	Subnet name to be displayed. This parameter must start and end with a number or a letter, containing 2 to 63 characters. Only letters, numbers, - and periods (.) are supported.
subnetCidrBlock	Yes	String	CIDR block of the subnet. The optional values are as follows: 10.0.0.0/24, 172.16.0.0/24, 192.168.0.0/24 and their subnetss. The subnet IP ranges cannot be overlapped.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
vpcId	String	VPC ID.

4. Code Example

Example

Create a VPC in zone FRA-A.

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: CreateVpc
<Common Request Params>

Request:
{
  "zoneId": "FRA-A",
  "vpcCidrBlock": "10.0.0.0/20",
  "vpcName": "vpcxxx",
  "vpcDescription": "vpcXxxx Description",
  "subnetName": "subnetXXX",
  "subnetCidrBlock": "10.0.0.0/20"
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "vpcId": "914862014017316658"
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.​

HTTP Status Code	Error Code	Description
500	CREATE_SUBNET_FAILED	Creating failed.
400	UNSUPPORTED_OPERATION_SUBNET_BIND_NETWORK_COUNT_LIMIT	Subnet quantity is limited.
400	UNSUPPORTED_OPERATION_CIDR_BLOCK_IS_EXIST	Overlapped IP ranges. Please check whether the same CIDR block exists.
400	INVALID_CIDR_BLOCK_FORMAT	CIDR block format error. Please note whether it is IP/netmask format.
400	INVALID_CIDR_BLOCK_NETMASK	Invalid CIDR netmask.
400	INVALID_CIDR_BLOCK_NOT_LAN_IP	CIDR block is not a private CIDR.
400	INVALID_CIDR_BLOCK_INVALID_INTERNAL_IP	Invalid private CIDR block.
400	INVALID_REGION_NOT_ON_SALE	Not for sale in the zone.