# Retrieve the simplified bandwidth package within the UGN - GetSimpleUGNBwPackages

## Overview

Obtain the bandwidth package within the specified UGN






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `GetSimpleUGNBwPackages`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.genesissai.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 |  |**Yes**|
| **Offset** | int | Offset, default 0 |No|
| **Limit** | int | Page size, default is 20 |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|
| **BwPackages** | array[[*SimpleBwPackage*](#simplebwpackage)] |  |**Yes**|
| **TotalCount** | int |  |**Yes**|
| **Offset** | int |  |**Yes**|
| **Limit** | int |  |**Yes**|

#### Data Model


#### SimpleBwPackage

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **PackageID** | string |  |**Yes**|
| **UGNID** | string |  |**Yes**|
| **PayMode** | string | Billing Mode FixedBw: Fixed Bandwidth \| Peak95: Classic 95 \| Max5: Fifth Peak \| Traffic: Traffic Billing |**Yes**|
| **RegionA** | string | Region A Name |**Yes**|
| **RegionB** | string | Region B Name |**Yes**|
| **BandWidth** | float | Bandwidth Value |**Yes**|
| **Qos** | string | Service Quality<br />Diamond: Diamond \| Platinum: Platinum \| Gold: Gold |**Yes**|
| **Path** | string | Intelligent Path<br />Delay: Minimum Delay \| IGP: Regular Route \| TCO: Lowest Cost |**Yes**|
| **CreateTime** | int | Creation Time |**Yes**|
| **Name** | string |  |No|
| **Remark** | string |  |No|
| **ExpireTime** | int | Expiration Time |No|
| **ChangeStatus** | int | Bandwidth Package Switch Status |No|
| **ChangeTime** | int | Bandwidth Package Switching Time |No|
| **ChangePayMode** | string | Switch Billing Type for Bandwidth Package |No|

## Example

### Request Example
    
```
https://api.genesissai.com/?Action=GetSimpleUGNBwPackages
&ProjectId=WYGwTLkQ
&UGNID=KHzNansp
&Offset=1
&Limit=4
```

### Response Example
    
```json
{
  "Action": "GetSimpleUGNBwPackagesResponse",
  "BwPackages": [
    {
      "ChangePayMode": "PZOKWlLK",
      "ChangeStatus": 5,
      "ChangeTime": 1,
      "CreateTime": 6,
      "ExpireTime": 6,
      "IsCrossBorder": true,
      "Message": "zdpOXSwS",
      "Name": "KWKYParo",
      "PackageID": "sKSlVKTf",
      "Path": "TCO|IGP|Delay",
      "PayMode": "Free|SolidBw|Peak95|Max5|Traffic",
      "Qos": "金|银|铜",
      "RegionA": "CqjmDate",
      "RegionABwMax": 8,
      "RegionABwMin": 4,
      "RegionB": "yIxKgQxV",
      "RegionBBwMax": 1,
      "RegionBBwMin": 9,
      "Remark": "rpZlMjgK",
      "UGNID": "zuiYmTMN"
    }
  ],
  "Limit": 9,
  "Message": "doKXAKSR",
  "Offset": 2,
  "RetCode": 0,
  "TotalCount": 8
}
```