# Get Bandwidth Package Information - DescribeBandwidthPackage

## Overview

Obtain bandwidth package information for a specific region






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeBandwidthPackage`.                      | **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 |
|:---|:---|:---|:---|
| **Region** | string | Region. See [List of Regions and Availability Zones](api/summary/regionlist) |**Yes**|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the [GetProjectList interface](api/summary/get_project_list). |No|
| **Limit** | int | Return data pagination value, the integer value range is between [0,10000000], default is 20 |No|
| **Offset** | int | Return data offset, default is 0 |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|
| **TotalCount** | int | Total number of bandwidth packages that meet the conditions |No|
| **DataSets** | array[[*UnetBandwidthPackageSet*](#unetbandwidthpackageset)] | Details of Bandwidth Package, see UnetBandwidthPackageSet |No|

#### Data Model


#### UnetBandwidthPackageSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **BandwidthPackageId** | string | Resource ID of the bandwidth package |No|
| **EnableTime** | int | Effective time, in Unix Timestamp format |No|
| **DisableTime** | int | Expiration Time, in Unix Timestamp format |No|
| **CreateTime** | int | Creation time, in Unix Timestamp format |No|
| **Bandwidth** | int | Temporary bandwidth value of the bandwidth package, unit Mbps |No|
| **EIPId** | string | The resource ID of the Elastic IP bound to the bandwidth package |No|
| **EIPAddr** | array[[*EIPAddrSet*](#eipaddrset)] | Details of the Elastic IP bound to the bandwidth package. Only when the EIPId corresponds to a dual-line IP, the length of EIPAddr is 2. In other cases, the length of EIPAddr is always 1. See EIPAddrSet for reference. |No|

#### EIPAddrSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **OperatorName** | string | Operator Information, enumeration values are: BGP: BGP; International: International. |No|
| **IP** | string | Elastic IP Address |No|

## Example

### Request Example
    
```
https://api.dezai.com/?Action=DescribeBandwidthPackage
&Region=cn-bj2
```

### Response Example
    
```json
{
  "Action": "DescribeBandwidthPackageResponse",
  "DataSets": [
    {
      "Bandwidth": 200,
      "BandwidthPackageID": "bwpack-XXXXXX",
      "CreateTime": 1430990525,
      "DisableTime": 1430997725,
      "EIPAddr": [
        {
          "IP": "123.59.XX.XX",
          "OperatorName": "BGP"
        }
      ],
      "EIPId": "eip-XXXXX",
      "EnableTime": 1430990525
    }
  ],
  "RetCode": 0,
  "TotalCount": 1
}
```