ModifyCloudRouterEdgePointBandwidth

1. API Description

This API is used to modify access bandwidth of access point in a Layer 3 cloud router.

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 modifying has been completed. The status of the cloud router will be UPDATING during the modifying. You can call DescribeCloudRouters to query the state of the cloud router. If the state changes from UPDATING to RUNNING, it means that the access bandwidth has been modified successfully.

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

• If a Layer 3 Cloud Router contains a public cloud access point and the Cloud Connect access bandwidth has not been configured separately, this operation automatically adjusts it to the nearest cap higher than the new backbone bandwidth. You can configure Cloud Connect access bandwidth separately by calling the ModifyCloudBandwidth API.

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.
bandwidthMbps	Yes	Integer	Access bandwidth of the access point, ranging from 1 to 500. Unit: Mbps.

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 the access bandwidth of access points in a cloud router to 100 Mbps.

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
}

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.