# Purchase Cross-domain Bandwidth - CreateInterRegionBandwidth

## Overview

Purchase Cross-domain Bandwidth






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `CreateInterRegionBandwidth`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.scloudsg.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list). |**Yes**|
| **UGNId** | string | UGN Id |**Yes**|
| **Bandwidth** | int | Bandwidth (Unit in Mb/s) |**Yes**|
| **ChargeType** | string | Billing Type |**Yes**|
| **Quantity** | int | Purchasing Duration |**Yes**|
| **PayMode** | string | Payment Type |**Yes**|
| **Region0** | string | Cross-domain Bandwidth Ownership Region |**Yes**|
| **Region1** | string | Cross-domain Bandwidth Ownership Region |**Yes**|
| **CouponId** | string | Coupon Id |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **InterRegionBandwidthId** | string | Cross-domain Bandwidth Id |**Yes**|




## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=CreateInterRegionBandwidth&ProjectId=LBXHvMRE
&UGNId=upTEZdod
&Bandwidth=4
&ChargeType=Year
&Quantity=5
&PayMode=Traffic
&Region0=ovEWLXTO
&Region1=EwPIhVjX
&CouponId=oElLFpMk
```

### Response Example
    
```json
{
  "Action": "CreateInterRegionBandwidthResponse",
  "InterRegionBandwidthId": "fIpsnxEC",
  "Message": "success",
  "RetCode": 0
}
```