# sim卡套餐列表查询 - ListSimPricePlans
#### 功能介绍
SIM卡套餐列表查询，实体卡只会有一个套餐，eSIM/vSIM可能会有多个套餐
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GSL/doc?api=ListSimPricePlans)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ocgsl/gsl_07_0026.html)。
#### URI
GET /v1/sim-price-plans
表1Query参数 
| 参数          | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| sim_card_id | 是    | Long    | SIM卡标识，可通过[查询SIM卡列表接口](https://support.huaweicloud.com/api-ocgsl/gsl_07_0008.html)获取 最小值：**0**                                                                                                                             |
| iccid       | 否    | String  | iccid，传入的SIM卡标识（sim_card_id）为0,则根据iccid进行处理 最小长度：**19** 最大长度：**20**                                                                             |
| real_time   | 否    | Boolean | 是否查实时流量 缺省值：**false**                                                                                                                                                                                                        |
| limit       | 否    | Long    | 分页查询时每页显示的记录数，默认值为10，取值范围为10-500的整数 最小值：**10** 最大值：**500** 缺省值：**10** |
| offset      | 否    | Long    | 分页查询时的页码数，默认值为1，取值范围为1-1000000的整数 最小值：**1** 最大值：**1000000** 缺省值：**1**  |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。通过调用IAM服务 [获取IAM用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取，接口返回的响应消息头中"X-Subject-Token"就是需要获取的用户Token。简要的获取方法样例请参见 [Token认证](https://support.huaweicloud.com/api-ocgsl/gsl_07_0004.html)。 |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数       | 参数类型                                                                                                                   | 描述 |
|:---|:---|:---|
| \[数组元素\] | Array of [SimPricePlanVO] objects | -  |
   
 表4SimPricePlanVO 
| 参数                 | 参数类型    | 描述                                                                                                                                                                                                                           |
|:---|:---|:---|
| id                 | Long    | 套餐实例id 最小值：**0**                                                                                                                                  |
| account_id         | String  | 账户id 最大长度：**128**                                                                                                                                  |
| sim_card_id        | Long    | sim卡id 最小值：**0**                                                                                                                                  |
| status             | Integer | 套餐状态:0 已删除 1 可激活 2 在用 3. 使用完 4. 可激活 5 已停用 6. 启用失败 最小值：**0** 最大值：**99** |
| price_plan_id      | String  | 套餐id 最大长度：**128**                                                                                                                                 |
| cid                | String  | 容器ID:不同类型卡含义如下 iccid(实体卡)，eid（eSIM）cid（vSIM) 最大长度：**128**                                                                                           |
| order_id           | String  | 订单id 最大长度：**128**                                                                                                                                |
| create_time        | String  | 创建时间 例如2020-08-24T07:57:56.000Z                                                                                                                                                                                              |
| active_time        | String  | 激活时间 例如2020-10-31T16:00:00.000Z                                                                                                                                                                                              |
| stop_time          | String  | 停用时间 2021-10-31T16:00:00.000Z                                                                                                                                                                                                |
| flow_total         | Double  | 总流量(MB) 最小值：**0**                                                                                                                               |
| flow_used          | Double  | 已使用流量(MB) 最小值：**0**                                                                                                                                |
| flow_left          | Double  | 剩余流量(MB)                                                                                                                                                                                                                     |
| using              | String  | 是否使用中(0：否 1：是) 最大长度：**128**                                                                                                                     |
| price_plan_name    | String  | 套餐名 最大长度：**128**                                                                                                                                    |
| description        | String  | 描述 最大长度：**128**                                                                                                                                  |
| package_type       | Integer | 套餐类型: 0.非自动续费 1.自动续费 最小值：**0** 最大值：**9**                              |
| effect_type        | Integer | 生效类型: 1.订购后激活使用时生效 2.订购即时生效 3.订购下个月开始生效 最小值：**0** 最大值：**99**          |
| silent_period_day  | Integer | 沉默期 最小值：**0** 最大值：**999**                                               |
| silent_period_unit | Integer | 沉默期单位: 1.年 2.月 3.日 最小值：**1** 最大值：**3**                                 |
| auto_renew         | Integer | 自动续订: 0.不自动续订 1.继续续订 最小值：**0** 最大值：**9**                              |
| location_desc      | String  | 位置信息:1. 中国 2. 欧洲 3. 大洋洲 4. 非洲5. 亚太 最大长度：**128**                                                                                                  |
   
**状态码：400**
表5响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
**状态码：500**
表6响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
#### 请求示例
查询SIM卡订购的所有套餐数据，每页返回10条数据，从第1页开始。
```
GET https://{endpoint}/v1/sim-price-plans?offset=1&limit=10
```
#### 响应示例
**状态码：200**
OK
```
[ {
  "id" : 100000000000,
  "account_id" : "04eexxxxxxxxxxxx",
  "sim_card_id" : 100000000000,
  "status" : 2,
  "price_plan_id" : "100001",
  "partner" : 1,
  "cid" : "8986xxxxxxxxxx",
  "partner_pid" : "10001",
  "order_id" : null,
  "create_time" : "2022-09-16T03:21:22.000+00:00",
  "active_time" : "2022-09-16T01:14:58.000+00:00",
  "stop_time" : null,
  "flow_total" : 30,
  "flow_used" : 0,
  "flow_left" : 30,
  "using" : "0",
  "price_plan_name" : "中国联通消费级每月30M联接服务（1年）",
  "description" : null,
  "package_type" : 1,
  "effect_type" : 1,
  "silent_period_day" : 6,
  "silent_period_unit" : 2,
  "auto_renew" : 0,
  "location_desc" : "中国"
} ]
```
**状态码：400**
Parameter Invalid
```
{
  "error_code" : "GSL.00010004",
  "error_msg" : "参数异常"
}
```
**状态码：500**
Internal Server Error
```
{
  "error_code" : "GSL.00010003",
  "error_msg" : "系统繁忙，请稍后重试。"
}
```
#### 状态码
| 状态码 | 描述                    |
|:---|:---|
| 200 | OK                    |
| 400 | Parameter Invalid     |
| 500 | Internal Server Error |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-ocgsl/ErrorCode.html)。