CreateRoute

CreateRoute

1. API Description

This API is used to create a route.

Note

You can only perform this operation on instances whose status is RUNNING or STOPPED.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
vpcId	Yes	String	VPC ID.
ipVersion	Yes	String	IP stack type. The optional values are as follows: IPv4, IPv6
cidrBlock	Yes	String	CIDR block of route
priority	Yes	Integer	Priority. The optional values are integers range from 1 to 65535.
nextHotId	Yes	String	ID of next hop instance.
name	Yes	String	Route name. This parameter must start and end with a number or a letter, containing 2 to 63 characters. Only letters, numbers, - and periods (.) are supported.

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.
routeId	String	Route ID.

4. Code Example

Example

Create a route.

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

Request:
{
  "vpcId": "xxxx",
  "ipVersion": "IPv4",
  "cidrBlock": "10.0.0.0/8",
  "priority": 2,
  "nextHotId": "xxxx",
  "name": "xxxx",
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "routeId": "xxxx"
  }
}

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
404	OPERATION_FAILED_RESOURCE_NOT_FOUND	VPC does not exist.
404	INVALID_INSTANCE_NOT_FOUND	Instance does not exist.
400	OPERATION_DENIED_VPC_NOT_EXIST_INSTANCE	No instance exists in the VPC.
400	OPERATION_DENIED_SUBNET_CIDR_CONFLICT	Conflicted CIDR blocks with subnet.
500	CREATE_VPC_ROUTE_FAILED	Creating route failed.