CreateCloudRouter

1. API Description

This API (CreateCloudRouter) is used to create Cloud Router

Notes

• Currently only postpaid Cloud Routers can be created.

• A VPC can join only one Cloud Router.

• This is an asynchronous API. Once the create request is successfully submitted, a Cloud Router ID is returned, but the create operation is not completed immediately. During this period the instance status will be DEPLOYING. The creation result can be checked by calling the DescribeCloudRouters API -- if the status (cloudRouterStatus) changes from DEPLOYING (creating) to RUNNING (available), the creation succeeded; if no record is found, the creation failed. Do not perform any operation on the Cloud Router while it is being created.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
cloudRouterName	Yes	String	Name of the Cloud Router, up to 255 characters. Defaults to cloud-router-{timestamp} if not specified.
edgePoints	Yes	Array of CreateCloudRouterEdgePoint	Edge point information. At least 2 edge points are required. Value range: [-, 500.0]
cloudRouterDescription	No	String	Description of the Cloud Router, up to 255 characters.
resourceGroupId	No	String	Resource group ID. If not specified, the resource is placed in the default resource group.
marketingOptions	No	MarketingInfo	Marketing activity information.
tags	No	TagAssociation	Tags associated when creating the Cloud Router. Note: associated tag keys must not be duplicated.

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.
cloudRouterId	String	Cloud Router ID.

4. Code Example

Example

1. Create a Cloud Router with 2 edge points, each with a bandwidth of 1 Mbps. One edge point is a port, and the other is a VPC.

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

Request:
{
    "edgePoints":[
        {
            "ipAddress":"4.4.4.4/24",
            "vlanId": 1024,
            "portId":"your-portId",
            "bgpConnection":{
                "password":"",
                "peerIpAddress":"4.4.4.3",
                "localAsn":62610,
                "peerAsn":6543
            },
            "bandwidthMbps":1
        },
        {
            "vpcId":"your vpc id",
            "bandwidthMbps":1
        }
    ],
    "cloudRouterName":"Test",
    "cloudRouterDescription":""
}

Response:
{   
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
     "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E",
     "cloudRouterId": "cloud router id"
  }
}

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