CreateBandwidthCluster

1. API Description

This API is used to create a bandwidth cluster.

Note

If you don't have bandwidth cluster permissions, please contact us to obtain access.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
areaCode	Yes	String	Location of the bandwidth cluster. To obtain code, you can call DescribeBandwidthClusterAreas, and find areaCode in the response.
commitBandwidthMbps	No	Integer	Bandwidth commitment. Unit: Mbps. Available value range: [0, 100000]. Default value: 0.
networkType	No	NetworkType	IP network type. The value is required for the bandwidth cluster by city.
internetChargeType	Yes	InternetChargeType	Network billing method. The default billing method is Monthly Burstable 95th, if you need Daily Peak billing, please contact us. Default value: MonthlyPercent95Bandwidth.
name	No	String	Bandwidth cluster name. If not specified, the default name will be based on the location name.

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.
orderNumber	String	Order number.
bandwidthClusterId	String	Bandwidth cluster ID.

4. Code Example

Example

Create a bandwidth cluster with the China Mobile network in Shanghai (SHA), whose bandwidth commitment is 1 Gbps.

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

Request:
  {
    "areaCode" : "SHA",
    "chargeType" : "POSTPAID",
    "commitBandwidthMbps" : 1000,
    "networkType" : "CMI",
    "internetChargeType" : "MonthlyPercent95Bandwidth",
    "name" : "sample"
  }

Response:
  {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "response": {
      "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
      "orderNumber": "123232",
      "bandwidthClusterId": "<system-generate-bandwidth-cluster-id>"
    }
  }

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_CITY_NOT_FOUND	The specified city is not found.