# Cross-domain Bandwidth Query - DescribeInterRegionBandwidth

## Overview

Cross-domain Bandwidth Query






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeInterRegionBandwidth`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.dezai.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**|
| **Offset** | int | Data offset. Default is 0 |No|
| **Limit** | int | Data pagination value. Default is 20 |No|
| **InterRegionBandwidthIds.N** | string | Cross-domain Bandwidth 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|
| **InterRegionBandwidths** | array[[*InterRegionBandwidth*](#interregionbandwidth)] | Cross-domain Bandwidth Information |**Yes**|
| **TotalCount** | int | The quantity of the InterRegionBandwidths field |No|

#### Data Model


#### InterRegionBandwidth

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ExpireTime** | int | Expiration Date |**Yes**|
| **UGNId** | string | UGN Id |**Yes**|
| **InterRegionBandwidthId** | string | Cross-domain Bandwidth Id |**Yes**|
| **Bandwidth** | int | Bandwidth (Unit in Mb/s) |**Yes**|
| **ChargeType** | string | Billing Type |**Yes**|
| **Region0** | string | Cross-region Bandwidth |**Yes**|
| **Region1** | string | Cross-region Bandwidth |**Yes**|
| **PayMode** | string | Payment Type |**Yes**|
| **State** | int | Cross-domain Bandwidth Status |**Yes**|
| **CreateTime** | int | Creation Time |**Yes**|

## Example

### Request Example
    
```
https://api.dezai.com/?Action=DescribeInterRegionBandwidth
&ProjectId=ULSXwpkw
&UGNId=imdEPsSn
&InterRegionBandwidthIds.n=JhTrGXWu
&OffSet=8
&Limit=2
```

### Response Example
    
```json
{
  "Action": "DescribeInterRegionBandwidthResponse",
  "InterRegionBandwidths": [
    {
      "Bandwidth": 9,
      "ChargeType": "Year",
      "CreateTime": 5,
      "ExpireTime": 1,
      "InterRegionBandwidthId": "CAEKJswX",
      "PayMode": "Traffic",
      "Region0": "FFseRXtF",
      "Region1": "jKOISBCu",
      "State": 1,
      "UGNId": "CMMsbcOe"
    }
  ],
  "Message": "success",
  "RetCode": 0,
  "TotalCount": 5
}
```