# CreateCrossRegionBandwidth

## 1. API Description

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

{% hint style="info" %} <mark style="color:blue;">**Note**</mark>

<mark style="color:blue;">Region A and Region Z must be different regions within the same global VPC.</mark>
{% endhint %}

## 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](https://docs.console.zenlayer.com/api-reference/compute/datastructure#internetchargetype) | Network billing model.                                                                                                                                                                                           |
| crossRegionBandwidthName | Yes      | String                                                                                                         | <p>The name of cross-region bandwidth.</p><p>The length is 2 to 63 characters.</p><p>Only letters, numbers, -/\_ and periods (.) are supported.</p><p>The name must start and end with a number or a letter.</p> |
| regionA                  | Yes      | String                                                                                                         | One end of the cross-region bandwidth.                                                                                                                                                                           |
| regionZ                  | Yes      | String                                                                                                         | The other end of the cross-region bandwidth.                                                                                                                                                                     |
| bandwidth                | Yes      | Integer                                                                                                        | <p>Bandwidth cap.</p><p>Value range: \[1, +)</p>                                                                                                                                                                 |
| marketingInfo            | No       | [MarketingInfo](https://docs.console.zenlayer.com/api-reference/compute/datastructure#marketinginfo)           | Information on marketing campaigns.                                                                                                                                                                              |
| bandwidthCap             | No       | Integer                                                                                                        | <p>Burst bandwidth.</p><p>Unit: Mbps.</p><p>This field is required only when internetChargeType is set to ByInstanceBandwidth95 .</p><p>Available range: \[1, +).</p><p>Value range: \[1, +)</p>                 |

## 3. Output Parameters

| Parameter Name         | Type   | Description                                                                                                           |
| ---------------------- | ------ | --------------------------------------------------------------------------------------------------------------------- |
| requestId              | String | <p>The unique request ID, which is returned for each request.</p><p>RequestId is required for locating a problem.</p> |
| orderNumber            | String | Order number.                                                                                                         |
| crossRegionBandwidthId | String | Unique ID of cross-region bandwidth.                                                                                  |

## 4. Code Example

{% tabs %}
{% tab title="Example" %}
**1. Create a cross-region bandwidth from Shanghai to Beijing, with the network billing model of Flat Rate. Burst bandwidth is 100 Mbps.**

```json
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.**

```json
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>"
  }
}
```

{% endtab %}
{% endtabs %}

## 5. Developer Resources

Zenlayer Cloud API 2.0 integrates [SDKs](https://docs.console.zenlayer.com/api-reference/api-introduction/toolkit/api-sdk)，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](https://docs.console.zenlayer.com/api-reference/api-introduction/instruction/commonerrorcode).

| HTTP Status Code | Error Code                                     | Description                                                         |
| ---------------- | ---------------------------------------------- | ------------------------------------------------------------------- |
| 404              | INVALID\_REGION\_NOT\_FOUND                    | Specified availability zone 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                       | The global VPC does not exist.                                      |