Query TBSP List
Updated at:2025-10-16
Description
- Retrieve all TBSP details under the user account.
- Support search of TBSP by ID, name, or status.
- 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
Java
1GET /v{version}/tbsp?id={id}&name={name}&status={status}&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 | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number, current value is 1. |
| id | String | No | Query | Instance ID, with fuzzy search supported |
| name | String | No | Query | Instance name, with fuzzy search supported |
| status | String | No | Query | Instance status (RUNNING/STOPPED) |
| 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. |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Type | Description |
|---|---|---|
| detailList | List<[TbspModel](EIP/API Reference/Appendix 1.md#TbspModel)> | 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
Java
1GET /v1/tbsp?status=RUNNING&maxKeys=1 HTTP/1.1
2Host: eip.bj.baidubce.com
3Authorization:bce-auth-v1/a43eea003308400587496785f7f5d9ee/2021-11-06T12:28:04Z/3600/host;x-bce-date/25ec3d4baba54ad7397cb31c96cb5e364088ff79f9b853ffb8dc6c11ebcdcf16
Response example
Java
1HTTP/1.1 200 OK
2Server: nginx/1.19.0
3Date: Sat, 06 Nov 2021 12:28:05 GMT
4Content-Type: application/json; charset=UTF-8
5X-Bce-Request-Id: dfd5d01f-a869-49eb-aba5-d853a335a6d4
6{
7 "detailList": [
8 {
9 "attackingRecordList": [],
10 "attackingRecordTotalCount": 0,
11 "autoRenewSwitch": 1,
12 "createTime": "2021-11-06T10:53:11Z",
13 "defenseCountQuota": 100,
14 "defenseEnable": 0,
15 "defenseLineType": "BGP_S",
16 "expireTime": "2022-02-06T10:53:11Z",
17 "id": "ipDdos-91e3e82e",
18 "ipList": [
19 {
20 "ip": "100.88.6.253",
21 "status": "available"
22 },
23 {
24 "ip": "100.88.2.155",
25 "status": "available"
26 }
27 ],
28 "ipTotalCount": 2,
29 "name": "test",
30 "productStatus": "RUNNING"
31 }
32 ],
33 "isTruncated": true,
34 "marker": "ipDdos-91e3e82e",
35 "maxKeys": 1,
36 "nextMarker": "ipDdos-440f572b"
37}
