Query the reserved network segment list
Updated at:2025-10-16
Description
Retrieve the list of reserved network segments.
Request structure
Plain Text
1GET /v{version}/subnet/ipreserve?subnetId={subnetId}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | For API version No., the current value is 1 |
| subnetId | String | No | Query | Subnet ID to which the reserved network segment belongs |
| marker | String | No | Query | The starting position of the batch list query is a system-generated string |
| maxKeys | Integer | No | Query | Maximum number of items included per page, maximum: 1,000, default: 1,000 |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| ipReserves | List<[IpReserve](VPC/API Reference/Appendix.md#IpReserve)> | List of reserved network segments |
| 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 | Integer | Maximum number of items included per page |
Request example
Plain Text
1GET /v1/subnet/ipreserve?subnetId=sbn-a4cikyt7756r&maxKeys=1 HTTP/1.1
2Host: bcc.bj.baidubce.com
3Content-Type: application/json;charset=UTF-8
4Authorization: bce-auth-v1/d5ee69bbe4ad11edbcaad95ed83571d3/2023-04-27T04:33:39Z/3600/host;x-bce-accesskey;x-bce-account;x-bce-client-ip;x-bce-date;x-bce-gateway-count;x-bce-request-id;x-bce-user-agent/35b8f22a90d56f2e69597139ae410687049a0f5f9b5914d6766413fab72187de
Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: a1dffaa1-ff55-4d12-baee-d4423f676d8a
3Date: Thu, 27 Apr 2023 04:33:39 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6{
7 "marker": "",
8 "nextMarker": "ipr-7xp6wvzqpmhd",
9 "maxKeys": 1,
10 "isTruncated": true,
11 "ipReserves":[
12 {
13 "ipReserveId":"ipr-tqsbpf5hcvbp",
14 "subnetId":"sbn-a4cikyt7756r",
15 "ipCidr":"192.168.0.200/30",
16 "ipVersion":"4",
17 "description":"test",
18 "createdTime":"2023-04-27T03:44:38Z",
19 "updatedTime":"2023-04-27T03:45:38Z"
20 }
21 ]
22}
