ModifyCloudBandwidth

1. API Description

This API is used to modify the Cloud Connect access bandwidth.

Note

• Call DescribeCloudAvailableBandwidthTiers to query available cloud connect access bandwidth specifications.

• This operation is not supported for Amazon Web Services and Oracle Cloud. Specification upgrade is supported only for Microsoft Azure.

• For the Cloud Connect in a Layer 2 Private Connect, you can call DescribePrivateConnects to retrieve endpointId, which is the Cloud Connect ID.

• For the Cloud Connect in a Layer 3 Cloud Router, you can call DescribeCloudRouters to retrieve portId, which is the Cloud Connect ID.

• 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 or the Cloud Router 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 has been modified successfully.

  • You can call DescribeCloudRouters to query the state of the Cloud Router. If the state changes from UPDATING to RUNNING, it means that the bandwidth has been modified successfully.

• Any operations on the Private Connect or the Cloud Router are not allowed while modifying.

• Please note that after modifying the Cloud Connect access bandwidth through this API, any subsequent bandwidth changes made via ModifyPrivateConnectBandwidth or ModifyCloudRouterEdgePointBandwidth will only adjust the backbone bandwidth. The Cloud Connect access bandwidth will no longer be updated automatically.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
cloudPortId	Yes	String	Cloud Connect ID to be modified.
bandwidthMbps	Yes	Integer	The access bandwidth to be modified. It must match one of the available bandwidth specifications. You can call the DescribeCloudAvailableBandwidthTiers API to query the supported bandwidth specifications.

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 Cloud Connect access bandwidth to 100 Mbps.

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

Request：
{
  "cloudPortId": "your-cloud-port-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
404	INVALID_CLOUD_PORT_NOT_FOUND	Cloud Connect does not exist.
400	INVALID_PORT_STATUS	The current status does not support this operation.
403	INVALID_CLOUD_BANDWIDTH	Invalid bandwidth value. The bandwidth must match one of the available bandwidth specifications.