UpdateBandwidthClusterCommitBandwidth

1. API Description

This API is used to modify the bandwidth commitment of the bandwidth cluster.

Note

• The changes take effect immediately.

• You can call this API to modify the commitment of a bandwidth cluster that contains resources. If the bandwidth cluster has no resources, you can delete it and create a new one.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
bandwidthClusterId	Yes	String	Bandwidth cluster ID.
commitBandwidthMbps	Yes	Integer	Bandwidth commitment. Available range: [0, 100000].

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

Change the bandwidth commitment of the bandwidth cluster to 100 Mbps.

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

Request：
{
  "bandwidthClusterId" : "<bandwidth-cluster-id>",
  "commitBandwidthMbps" : 100
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}

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_CLUSTER_NOT_FOUND	Bandwidth cluster does not exist.
400	INVALID_CLUSTER_BANDWIDTH_UNMODIFIED	Commitment does not change.
400	INVALID_CLUSTER_BANDWIDTH_UPDATE_NOT_SUPPORT	Commitment change is not supported for the current bandwidth cluster.
400	INVALID_CLUSTER_NOT_RUNNING	Operations are not supported for bandwidth clusters that contains no resources.