CreateSubnet

CreateSubnet

1. API Description

This API is used to create a subnet.

Prerequisites

Before creating a subnet, you can call DescribeSubnetAvailableResources to check the available zones.

Note

  • Subnet quota is limited. If you need more, please contact Zenlayer Support.

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

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter NameRequiredTypeDescription

cidrBlock

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 subsets.

The subnet IP ranges cannot be overlapped.

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.

zoneId

Yes

String

Zone ID of subnet.

subnetDescription

No

String

Subnet description.

3. Output Parameters

Parameter NameTypeDescription

requestId

String

The unique request ID, which is returned for each request. RequestId is required for locating a problem.

subnetId

String

Subnet ID.

4. Code Example

Create a subnet in zone FRA-A.

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

Request:
{
  "zoneId": "FRA-A",
  "cidrBlock": "10.0.0.0/20",
  "subnetName": "subnetXXX",
  "subnetDescription": "subnetXXX Description"
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "subnetId": "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 CodeError CodeDescription

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.

Last updated