Query shared traffic package list

Updated at：2025-10-16

Description

Fetch all shared traffic package details under the user's account.
Support queries using TBSP ID, status, and deduct policy.
The response contains results that match all specified query conditions.
Results support marker-based pagination, with a default page size of 1,000, adjustable via the maxKeys parameter.

Request structure

Plain Text

1GET /v{version}/eiptp?marker={marker}&maxKeys={maxKeys}&id={id}&status={status}&deductPolicy={deductPolicy} HTTP/1.1
2Host: eip.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number, current value is 1.
marker	String	No	Query	The starting position of the batch list query is a system-generated string
maxKeys	int	No	Query	Maximum number of items included per page, maximum: 1,000, default: 1,000
id	String	No	Query	The ID of the shared traffic package to be queried
status	String	No	Query	Status of the shared traffic package to be queried, including "RUNNING" (in use), "EXPIRED" (expired), and "USED_UP" (used up)
deductPolicy	String	No	Query	Shared traffic package billing policies to be queried: "FullTimeDurationPackage" (full-time) or "TimeDurationPackage" (off-peak)

Response Status Code

Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](EIP/API Reference/Error code.md).

Response headers

No special headers beyond common headers.

Response parameters

Parameter name	Type	Description
packageList	List <Package>	List containing query results
marker	String	Marker indicating the starting position of the query. If the result list is empty, this field does not exist.
isTruncated	boolean	true indicates there is more data later, false indicates it is the last page
nextMarker	String	Obtain the marker value required for retrieving the next page; this field will not appear when isTruncated is false
maxKeys	int	Maximum number of items included per page

Request example

Plain Text

1GET /v1/eiptp?marker=tp-87V5cnkwqO&maxKeys=2 HTTP/1.1
2Host: eip.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2021-08-17T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

Response example

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Tue, 17 Aug 2021 08:26:53 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6{
7    "nextMarker": "tp-Qn65tYXAx3",
8    "marker": "tp-87V5cnkwqO",
9    "maxKeys": 2,
10    "isTruncated": true,
11    "packageList": [
12        {
13          "id":"tp-87V5cnkwqO",
14          "deductPolicy":"TimeDurationPackage",
15          "packageType":"WebOutBytes",
16          "status":"RUNNING",
17          "capacity": 10737418240,
18          "usedCapacity": 0,
19          "createTime":"2021-08-10T11:40:57Z",
20          "activeTime": "2021-08-10T11:41:16Z",
21		  "expireTime:" "2021-09-10T11:41:16Z"
22        },
23        {
24          "id":"tp-nzGGLBBYjD",
25          "deductPolicy":"FullTimeDurationPackage",
26          "packageType":"WebOutBytes",
27          "status":"EXPIRED",
28          "capacity": 10737418240,
29          "usedCapacity": 10737418240,
30          "createTime":"2021-08-10T11:40:57Z",
31          "activeTime": "2021-08-10T11:41:16Z",
32		  "expireTime:" "2021-09-10T11:41:16Z"
33        }
34    ]
35}

Package

Parameter name	Type	Description
id	String	ID of the shared traffic package
deductPolicy	String	Shared traffic package billing policies: "FullTimeDurationPackage" (full-time) or "TimeDurationPackage" (off-peak)
packageType	String	Shared traffic package Internet connection type, currently supporting "WebOutBytes" (dynamic)
status	String	Status of the shared traffic package, including "RUNNING" (in use), "EXPIRED" (expired), and "USED_UP" (used up)
capacity	String	Total shared traffic package capacity, in Bytes
usedCapacity	String	Used capacity of shared traffic package, in Bytes
createTime	String	Shared traffic package creation time
activeTime	String	Shared traffic package activation time
expireTime	String	Shared traffic package expiration time

Query shared traffic package details

TBSP Related Interfaces