# 获取简洁版带宽包列表 - ListSimpleBwPackage

## 简介

获取当前项目下的带宽包列表





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `ListSimpleBwPackage`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.netlake.cn/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **ProjectId** | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](/docs/api/summary/get_project_list) |**Yes**|
| **Offset** | int | 偏移量，默认0 |No|
| **Limit** | int | 分页大小，默认20 |No|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|
| **TotalCount** | int | 带宽包数量 |**Yes**|
| **Offset** | int | 偏移量 |**Yes**|
| **Limit** | int | 分页大小 |**Yes**|
| **BwPackages** | array[[*SimpleBwPackage*](#SimpleBwPackage)] | 带宽包列表 |**Yes**|

#### 数据模型


#### SimpleBwPackage

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **PackageID** | string | 带宽包 ID |**Yes**|
| **UGNID** | string | UGN ID |**Yes**|
| **PayMode** | string | 计费模式 FixedBw:固定带宽｜Peak95:经典95｜Max5:第五峰值｜Traffic:流量计费 |**Yes**|
| **RegionA** | string | 地域A名称 |**Yes**|
| **RegionB** | string | 地域B名称 |**Yes**|
| **BandWidth** | float | 带宽值 |**Yes**|
| **Qos** | string | 服务质量<br />Diamond:钻石｜Platinum:铂金｜Gold:黄金 |**Yes**|
| **Path** | string | 智能路径<br />Delay:最低时延｜IGP:普通线路｜TCO:最低成本 |**Yes**|
| **CreateTime** | int | 创建时间 |**Yes**|
| **Name** | string | 带宽包名称 |No|
| **Remark** | string | 备注 |No|
| **ExpireTime** | int | 过期时间 |No|
| **ChangeStatus** | int | 带宽包切换状态 |No|
| **ChangeTime** | int | 带宽包切换时间 |No|
| **ChangePayMode** | string | 带宽包切换计费类型 |No|

## 示例

### 请求示例
    
```
https://api.netlake.cn/?Action=ListSimpleBwPackage
&ProjectId=ypltSuDF
&Offset=7
&Limit=1
```

### 响应示例
    
```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
}
```