Query EIP list in bucket trash
Updated at:2025-10-16
Query EIP list in bucket trash
Description
- Retrieve details about EIP within the bucket trash of the user account.
- Allow queries by EIP address or name, supporting fuzzy search for both methods.
- If no specific criteria are specified, all EIPs will be listed by default.
- The results returned reflect the intersection of multiple conditions, meaning EIPs meeting all provided criteria are shown.
- 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}/eip/recycle?eip={eip}&name={name}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: eip.bj.baidubce.com
3Authorization: authorization string
Request headers
No special headers beyond common headers.
Request parameters
| Parameter name | Type | Is it required | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | The current API version number is 1. |
| eip | String | No | Query | Specify the EIP for the query, including both IPv4 and IPv6 EIPs. |
| name | String | No | Query | Specify the name of the EIP to be queried. |
| marker | String | No | Query | The starting position for the batch list query, which is a system-generated string. |
| maxKeys | int | No | Query | Maximum number of entries per page: 1,000 by default and 1,000 as the upper limit. |
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 |
|---|---|---|
| eipList | List<[RecycleEipModel](EIP/API Reference/Appendix 1.md#RecycleEipModel)> | A list containing the query results. |
| marker | String | Marker indicating the starting point of the query; this field is absent if the result list is empty. |
| isTruncated | boolean | "True" means there is more data available, and "False" means this is the last page. |
| nextMarker | String | Retrieve the marker value needed for accessing the next page; this field will not appear if isTruncated is false. |
| maxKeys | int | The maximum number of items per page. |
Request example
Plain Text
1GET /v1/eip/recycle?marker=ip-3nQTzFYC&maxKeys=2 HTTP/1.1
2Host: eip.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2022-02-14T02:14:00Z/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, 14 Feb 2022 02:14:03 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6{
7 "marker": "ip-3nQTzFYC",
8 "isTruncated": false,
9 "maxKeys": 2,
10 "eipList": [
11 {
12 "name": "test",
13 "eip": "106.13.81.186",
14 "eipId": "ip-3nQTzFYC",
15 "status": "paused",
16 "routeType": "BGP",
17 "bandwidthInMbps": 1,
18 "paymentTiming": "Postpaid",
19 "billingMethod": "ByBandwidth",
20 "recycleTime": "2024-04-10T11:52:28Z",
21 "scheduledDeleteTime": "2024-04-17T11:52:28Z"
22 },
23 {
24 "name": "eip_v6_test",
25 "eip": "240c:4082:ffff:ff01:0:4:0:39e",
26 "eipId": "eipv6-3QHfCO7t",
27 "status": "paused",
28 "routeType": "BGP",
29 "bandwidthInMbps": 100,
30 "paymentTiming": "Postpaid",
31 "billingMethod": "ByBandwidth",
32 "recycleTime": "2024-04-10T11:51:55Z",
33 "scheduledDeleteTime": "2024-04-17T11:51:55Z"
34 }
35 ]
36}
