ModifyCloudRouterEdgePoint

1. API Description

This API is used to modify configurations of access points in a cloud router, including BGP and static routing configurations.

Note

• Only operations on cloud routers in state of RUNNING 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. You can use DescribeCloudRouters to query the status of the cloud router. If cloudRouterStatus changes from UPDATING to RUNNING, it means that the cloud router has been modified successfully.

• Any operations on the cloud routers are not allowed while modifying.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
edgePointId	Yes	String	Access point ID.
cloudRouterId	Yes	String	Cloud router ID.
bgpConnection	No	BGPConnection	BGP routing. One of BGP and Static routing must be specified.
staticRoutes	No	Array of IpRoute	Static routing. One of BGP and Static routing must be specified.
bandwidthMbps	No	Integer	Access bandwidth of the access point, ranging from 1 to 500. Unit: Mbps.
ipAddress	No	String	IP address.

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.

4. Code Example

Example

Modify access bandwidth of access points to 100 Mbps and modify BGP routing.

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

Request：
{
    "cloudRouterId": "your-cloud-router-id",
    "edgePointId": "one-of-egdgePoint-id",
    "bandwidthMbps": 100,
    "bpgConnection": {
        "peerIpAddress":"10.10.0.1/16",
        "peerAsn":1000,
        "password":"md5"
      }    
    }
}

Response：
{   
  "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E",
  "response": {
     "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E"，
  }
}

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
400	INVALID_BANDWIDTH_EXCEED_LIMIT	Access bandwidth exceeds the limit.
409	INVALID_CLOUD_ROUTER_STATUS	Only operations on cloud routers in state of RUNNING are supported.