CreateCrossRegionBandwidth

1. API Description

This API is used to create a private cross-region bandwidth.

Note

Region A and Region Z must be different regions within the same global VPC.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
vpcId	Yes	String	Global VPC ID where the private cross-region bandwidth is located.
internetChargeType	Yes	InternetChargeType	Network billing model.
crossRegionBandwidthName	Yes	String	The name of cross-region bandwidth. The length is 2 to 63 characters. Only letters, numbers, -/_ and periods (.) are supported. The name must start and end with a number or a letter.
regionA	Yes	String	One end of the cross-region bandwidth.
regionZ	Yes	String	The other end of the cross-region bandwidth.
bandwidth	Yes	Integer	Bandwidth cap.
marketingInfo	No	MarketingInfo	Information on marketing campaigns.
bandwidthCap	No	Integer	Burst bandwidth. Unit: Mbps. This field is required only when internetChargeType is set to ByInstanceBandwidth95. Available range: [1, +).

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.
crossRegionBandwidthId	String	Unique ID of cross-region bandwidth.

4. Code Example

Example

1. Create a cross-region bandwidth from Shanghai to Beijing, with the network billing model of Flat Rate. Burst bandwidth is 100 Mbps.

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

Request：
{
  "vpcId": "<your vpc id>",
  "internetChargeType": "ByBandwidth",
  "crossRegionBandwidthName": "Test-Cross1",
  "regionA": "asia-east-1",
  "regionZ": "asia-north-1",
  "bandwidth": 100
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "crossRegionBandwidthId": "<crossId1>",
    "orderNumber": "<orderNumber>"
  }
}

2. Create a cross-region bandwidth from Beijing to Shanghai, with the network billing model of Burstable 95th. Bandwidth commitment is 100 Mbps and the burst bandwidth is 120 Mbps.

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

Request：
{
  "vpcId": "<your vpc id>",
  "internetChargeType": "ByInstanceBandwidth95",
  "crossRegionBandwidthName": "Test-Cross2",
  "regionA": "asia-north-1",
  "regionZ": "asia-east-1",
  "bandwidth": 100,
  "bandwidthCap": 120
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "crossRegionBandwidthId": "<crossId2>",
    "orderNumber": "<orderNumber>"
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 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_REGION_NOT_FOUND	Region does not exist.
400	INVALID_VPC_BANDWIDTH_REGION_AZ_IS_EXIST	Both region A and region Z of cross-region bandwidth already exist.
400	INVALID_VPC_BANDWIDTH_REGION_AZ_IS_SAME	Region A and region Z of the cross-region bandwidth are the same.
404	INVALID_VPC_NOT_FOUND	VPC does not exist.