AddCloudRouterEdgePoints

1. API Description

This API is used to add one or more new access point to a Layer 3 cloud router.

Prerequisites

• Query available VPCs You can call DescribeCloudRouterAvailableVpcs to query VPCs that can be added in to the Layer 3 cloud router.

• Query available border gateways You can call DescribeBorderGateways to query border gateways that can be added in to the Layer 3 cloud router.

• Query available ports You can call DescribeCloudRouterAvailablePorts to query ports that can be added in to the Layer 3 cloud router.

• Query available locations for public clouds

  • You can call DescribeGoogleRegions to query locations supporting for Google Cloud access point.

  • You can call DescribeAWSRegions to query locations supporting for AWS access point.

  • You can call DescribeTencentRegions to query locations supporting for Tencent Cloud access point.

• Query available date centers for virtual edges

  • You can call DescribeVirtualEdgeDatacenters to query date centers supporting virtual edges.

Note

• Only operations on ports in state of ACTIVE are supported.

• This API is an async API. A request ID is returned after the request is sent. However, it does not mean the operation has been completed. The status of the cloud router will be UPDATING during the operation. If the cloud router state changes from UPDATING to RUNNING, it means that the access point has been added.

• Any operations on the cloud routers are not allowed while adding access points.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
cloudRouterId	Yes	String	Cloud router ID.
edgePoints	Yes	Array of CreateCloudRouterEdgePoint	Information on access points.

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.
edgePointIds	Array of String	Access point ID. Consistent with the adding order.

4. Code Example

Example

Add a VPC access point to a Layer 3 cloud router with access bandwidth of 1 Mbps.

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

Request：
{
    "cloudRouterId": "your-cloud-router-id",
    "edgePoints": [
        {
            "vpcId":"your vpc id",
            "bandwidthMbps":1
        }
    ]
}

Response：
{   
  "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E",
  "response": {
     "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E"，
     "edgePointIds": ["edge point 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
404	INVALID_CLOUD_ROUTER_NOT_FOUND	Cloud router doesn't exist.