ModifyPrivateConnectBandwidth

1. API Description

This API is used to modify bandwidth cap of a Layer 2 private connect.

Note

• Only operations on private connects in state of AVAILABLE 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 private connect will be UPDATING during the modifying. You can call DescribePrivateConnects to query the state of the private connect. If the state changes from UPDATING to AVAILABLE, it means that the bandwidth cap has been modified successfully.

• Any operations on the private connects are not allowed while modifying.

• If a Layer 2 Private Connect 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
privateConnectId	Yes	String	Private connect ID.
bandwidthMbps	Yes	Integer	Bandwidth cap of the private connect, 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 bandwidth cap of a private connect to 100 Mbps.

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

Request：
{
    "privateConnectId": "your-private-connect-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 Code

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	Bandwidth cap exceeds the limit.
409	INVALID_PRIVATE_CONNECT_STATUS	Operations on private connects in state of Inactive are not supported.