Query IP address group list
Updated at：2025-10-16
Description
Query the list of IP address groups.
Request structure
Plain Text
1GET /v{version}/ipSet?ipVersion={ipVersion}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization stringRequest 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 | API version number, with current value being 1. |
| ipVersion | String | No | Query | ipVersion, value: IPv4 or IPv6 |
| 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 |
|---|---|---|
| ipSets | List<[IpSet](VPC/API Reference/Appendix.md#IpSet)> | IP address group list |
| 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 | Integer | Maximum number of items included per page |
Request example
Plain Text
1GET /v1/ipSet?ipVersion=IPv4&marker=ips-w2d4kgc3x0y1&maxKeys=1 HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1deResponse example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7e789a40-adac-414a-8bd4-916d6be61112
3Date: Mon, 02 Apr 2019 08:14:25 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6{
7 "ipSets": [{
8 "ipSetId": "ips-w2d4kgc3x0y1",
9 "name": "test_ipSet",
10 "description": "",
11 "ipVersion": "IPv4",
12 "ipAddressInfo": [{
13 "ipAddress": "10.101.151.17",
14 "description": "ip address description"
15 }],
16 "bindedInstanceNum": 3
17 }],
18 "marker": "ips-w2d4kgc3x0y1",
19 "isTruncated": true,
20 "nextMarker": "ips-sd57mmq4irn7",
21 "maxKeys": 1
22}