查询共享流量包列表
更新时间：2021-08-19
描述
- 查询用户账户下所有共享流量包信息。
- 支持按共享流量包的id、status、deductPolicy进行查询。
- 返回结果是多重查询条件的交集。
- 结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定。
请求结构
GET /v{version}/eiptp?marker={marker}&maxKeys={maxKeys}&id={id}&status={status}&deductPolicy={deductPolicy} HTTP/1.1
Host: eip.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1 |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量，最大数量不超过1000，缺省值为1000 |
| id | String | 否 | Query参数 | 要查询的共享流量包id |
| status | String | 否 | Query参数 | 要查询的共享流量包状态，包含 "RUNNING" 使用中；"EXPIRED" 已过期；"USED_UP" 已用完 |
| deductPolicy | String | 否 | Query参数 | 要查询的共享流量包扣费策略，包含 "FullTimeDurationPackage" 全时；"TimeDurationPackage" 闲时 |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| packageList | List <Package> | 包含查询结果的列表 |
| marker | String | 标记查询的起始位置，若结果列表为空，此项不存在 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 获取下一页所需要传递的marker值，当isTruncated为false时，该域不出现 |
| maxKeys | int | 每页包含的最大数量 |
请求示例
GET /v1/eiptp?marker=tp-87V5cnkwqO&maxKeys=2 HTTP/1.1
Host: eip.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2021-08-17T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Tue, 17 Aug 2021 08:26:53 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"nextMarker": "tp-Qn65tYXAx3",
"marker": "tp-87V5cnkwqO",
"maxKeys": 2,
"isTruncated": true,
"packageList": [
{
"id":"tp-87V5cnkwqO",
"deductPolicy":"TimeDurationPackage",
"packageType":"WebOutBytes",
"status":"RUNNING",
"capacity": 10737418240,
"usedCapacity": 0,
"createTime":"2021-08-10T11:40:57Z",
"activeTime": "2021-08-10T11:41:16Z",
"expireTime:" "2021-09-10T11:41:16Z"
},
{
"id":"tp-nzGGLBBYjD",
"deductPolicy":"FullTimeDurationPackage",
"packageType":"WebOutBytes",
"status":"EXPIRED",
"capacity": 10737418240,
"usedCapacity": 10737418240,
"createTime":"2021-08-10T11:40:57Z",
"activeTime": "2021-08-10T11:41:16Z",
"expireTime:" "2021-09-10T11:41:16Z"
}
]
}Package
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 共享流量包id |
| deductPolicy | String | 共享流量包扣费策略，包含 "FullTimeDurationPackage" 全时；"TimeDurationPackage" 闲时 |
| packageType | String | 共享流量包线路类型，当前支持 "WebOutBytes" 动态 |
| status | String | 共享流量包状态，包含 "RUNNING" 使用中；"EXPIRED" 已过期；"USED_UP" 已用完 |
| capacity | String | 共享流量包总容量，容量单位 Byte |
| usedCapacity | String | 共享流量包已使用容量，容量单位 Byte |
| createTime | String | 共享流量包创建时间 |
| activeTime | String | 共享流量包激活时间 |
| expireTime | String | 共享流量包过期时间 |