# Get Simplified Bandwidth Package List - ListSimpleBwPackage

## Overview

Get the bandwidth package list under the current project






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListSimpleBwPackage`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.netlake.cn/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**|
| **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|
| **TotalCount** | int | Number of bandwidth packages |**Yes**|
| **Offset** | int | Offset |**Yes**|
| **Limit** | int | Page size |**Yes**|
| **BwPackages** | array[[*SimpleBwPackage*](#simplebwpackage)] | Bandwidth package list |**Yes**|

#### Data Model


#### SimpleBwPackage

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **PackageID** | string | Bandwidth package ID |**Yes**|
| **UGNID** | string | UGN ID |**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 | Bandwidth package Name |No|
| **Remark** | string | Remark |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.netlake.cn/?Action=ListSimpleBwPackage
&ProjectId=ypltSuDF
&Offset=7
&Limit=1
```

### Response Example
    
```json
{
  "Action": "ListSimpleBwPackageResponse",
  "BwPackages": [
    {
      "BandWidth": 5,
      "CreateTime": 1781691740,
      "ExpireTime": 1782835200,
      "Name": "test",
      "PackageID": "bw-1rr07fd1f2bl",
      "Path": "IGP",
      "PayMode": "FixedBw",
      "Qos": "Platinum",
      "RegionA": "cn-bj2",
      "RegionB": "cn-sh22",
      "UGNID": "ugn-1nnk7s9fw238"
    }
  ],
  "Limit": 20,
  "Message": "ok",
  "Offset": 0,
  "RetCode": 0,
  "TotalCount": 1
}
```