文档首页/ 全球SIM联接 GSL/ API参考/ API列表/ 前向流量池管理/ 查询流量池成员列表
更新时间：2024-12-20 GMT+08:00
查看PDF
分享

查询流量池成员列表

功能介绍

查询流量池成员列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/sim-pools/{sim_pool_id}/members

表1 路径参数

参数

是否必选

参数类型

描述

sim_pool_id

是

Long

流量池标识

最小值：0
表2 Query参数

参数

是否必选

参数类型

描述

cid

否

String

容器ID

limit

否

Long

每页记录数

最小值：10

最大值：500

缺省值：10

offset

否

Long

页码

最小值：1

最大值：1000000

缺省值：1

billing_cycle

是

String

账期，例如：2021-04

最小长度：7

最大长度：7

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

limit

Long

每页记录数

offset

Long

页码

count

Long

当前流量池的成员总数

pool_members

Array of PoolMemVO objects

查询出来的流量池成员记录列表
表5 PoolMemVO

参数

参数类型

描述

id

Long

流量池标识

cid

String

容器ID

最大长度：64

sim_price_plan_id

Long

套餐订购实例ID

flow_used

Double

已用流量(查询账期所在月份), 单位MB

最小值：0

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最大长度：64

error_msg

String

错误描述

最大长度：512

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最大长度：64

error_msg

String

错误描述

最大长度：512

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最大长度：64

error_msg

String

错误描述

最大长度：512

请求示例

查询前向流量池成员（SIM卡）列表，每页返回10条数据，从第1页开始。

GET https://{endpoint}/v1/sim-pools/{sim_pool_id}/members?offset=1&limit=10

响应示例

状态码： 200

OK

{
  "limit" : 10,
  "offset" : 1,
  "count" : 1,
  "pool_members" : [ {
    "id" : 100000001,
    "cid" : "89860XXXXXXXXXXXXXX",
    "sim_price_plan_id" : 455000000000,
    "flow_used" : 0
  } ]
}

状态码： 400

Bad Request

{
  "error_code" : "GSL.00010004",
  "error_msg" : "参数异常"
}

状态码： 403

Forbidden

{
  "error_code" : "GSL.00011004",
  "error_msg" : "账期不合法，请检查！"
}

状态码： 500

Internal Server Error

{
  "error_code" : "GSL.00010003",
  "error_msg" : "系统繁忙，请稍后重试。"
}

状态码

状态码

描述

200

OK

400

Bad Request

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。

父主题： 前向流量池管理

相关文档