Query bandwidth package list information of users
Updated at：2025-10-16
Description
- Retrieve information about all bandwidth packages associated with the user's account.
- Support queries based on bandwidth package ID, name, and bindType.
- 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}/eipbp?marker={marker}&maxKeys={maxKeys}&id={id}&name={name}&bindType={bindType} HTTP/1.1
2Host: eip.bj.baidubce.com
3Authorization: authorization stringRequest 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 per page is 1,000, with a default value of 1000. |
| id | String | No | Query | The ID of the bandwidth package to be queried |
| name | String | No | Query | Bandwidth package name to be queried |
| bindType | String | No | Query | Type of resources bound to the bandwidth package to be queried: "eip" (elastic public EIP) or "eipgroup" (EIPGROUP) |
| type | String | No | Query | Bandwidth package type, including BandwidthPackage or AccelerationPackage (cross-border acceleration package), defaulted as all |
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 |
|---|---|---|
| bpList | List <BandwidthPackage> | 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 | The marker value needed to fetch the next page. This field is absent when isTruncated is false. |
| maxKeys | int | Maximum number of items included per page |
Request example
Plain Text
1GET /v1/eipbp?marker=bw-IyWRnII7&maxKeys=2 HTTP/1.1
2Host: eip.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Thu, 16 Mar 2017 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6{
7 "nextMarker": "bw-IyWRn123",
8 "marker": "bw-IyWRnII7",
9 "maxKeys": 2,
10 "isTruncated": true,
11 "bpList": [
12 {
13 "name":"bp_1",
14 "id":"bw-IyWRnII7",
15 "bindType":"eip",
16 "bandwidthInMbps":"15",
17 "instanceId":"ip-xefrn257",
18 "eips":[
19 "10.23.54.23"
20 ],
21 "createTime":"2019-08-03T20:38:43Z",
22 "autoReleaseTime":"2019-08-23T12:38:43Z",
23 “type”:"BandwidthPackage",
24 "region":"bj"
25 },
26 {
27 "name":"bp_2",
28 "id":"bw-IyWRnIqw",
29 "bindType":"eipgroup",
30 "bandwidthInMbps":"30",
31 "instanceId":"eg-xsdqn76f",
32 "eips":[
33 "10.23.96.96",
34 "10.23.96.97",
35 "10.23.96.98",
36 "10.23.96.99"
37 ],
38 "createTime":"2019-08-03T20:38:43Z"，
39 "autoReleaseTime":"2019-09-23T12:38:43Z",
40 “type”:"BandwidthPackage",
41 "region":"bj"
42 }
43 ]
44}BandwidthPackage
| Parameter name | Type | Description |
|---|---|---|
| name | String | Name of the bandwidth package |
| id | String | Bandwidth package ID |
| bindType | String | Type of resources bound to the bandwidth package: "eip" (elastic public EIP) or "eipgroup" (EIPGROUP) |
| bandwidthInMbps | int | Total bandwidth of bandwidth package |
| instanceId | String | ID of the resource bound to the bandwidth package |
| eips | List |
If the bindType is "eip", it includes only a single EIP address; if "eipgroup", all EIPs under EIPGROUP are included |
| createTime | String | Creation time of the bandwidth package |
| autoReleaseTime | String | Automatic release time of the bandwidth package, same as the expiration time of bound resources |
| type | String | Bandwidth package type: BandwidthPackage or AccelerationPackage (cross-border acceleration package) |
region｜String｜The region to which the bandwidth package belongs