Query specified IP address family
Updated at：2025-10-16
Description
Query the specified IP address family.
Request structure
Plain Text
1GET /v{version}/ipGroup/{ipGroupId} 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. |
| ipGroupId | String | Yes | URL parameter | ID of the IP address family |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| ipGroupId | String | ID of the IP address family |
| name | String | Name of the IP address group |
| description | String | Description of the IP address group |
| ipVersion | String | ipVersion, value: IPv4 or IPv6 |
| ipSetIds | List<String> | List of associated IP address group IDs |
| bindedInstances | List<[IpCollectionBindedInstance](VPC/API Reference/Appendix.md#IpCollectionBindedInstance)> | Instance bound to the IP address family |
Request example
Plain Text
1GET /v1/ipGroup/ipg-w2d4kgc3x0y1 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 "ipGroupId": "ipg-w2d4kgc3x0y1",
8 "name": "test_ipGroup",
9 "description": "",
10 "ipVersion": "IPv4",
11 "ipSetIds": ["ips-sd57mmq4irn7"],
12 "bindedInstances": [{
13 "instanceId": "esg-w2kmnu1peqxg",
14 "instanceType": "ESG"
15 },
16 {
17 "instanceId": "esg-7c9yzhkfn9c2",
18 "instanceType": "ESG"
19 }
20 ]
21}