Query the security group list
Updated at：2025-10-20
- This API retrieves all security group details for the user.
Request structure
Plain Text
1GET /v{version}/securityGroup?marker={marker}&maxKeys={maxKeys}&instanceId={instanceId}&vpcId={vpcId} HTTP/1.1
2 Host: bcc.bj.baidubce.com
3 Authorization: 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 |
| marker | String | No | Query | The starting position of the batch list query is a system-generated string |
| maxKeys | int | No | Query | The maximum number of items per page is 1,000, with a default value of 1,000. |
| instanceId | String | No | Query | Instance ID, used to get the list of security groups linked to the instance. Leave this parameter empty to query all created security groups. |
| vpcId | String | No | Query | VPC instance ID, used to retrieve the list of security groups associated with the instance. |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| marker | String | Mark the starting position of the query. |
| isTruncated | boolean | "True" means there is more data available, and "False" means this is the last page. |
| nextMarker | String | The marker value needed to retrieve the next page. This field does not appear if isTruncated is false. |
| maxKeys | int | Maximum number of items included per page |
| securityGroups | List<[SecurityGroupModel](BCC/API Reference/Appendix.md#SecurityGroupModel)> | Security group information, a collection composed of SecurityGroupModel |
Request example
Plain Text
1GET /v2/securityGroup?instanceId=i-kjuinbcd HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1deResponse example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "nextMarker": "",
9 "marker": "",
10 "maxKeys": 1000,
11 "securityGroups": [
12 {
13 "desc": "",
14 "id": "g-4NxWoxeq",
15 "name": "common2",
16 "vpcId":"vpc-9xuevtmc6u",
17 "createdTime":"2019-09-24T08:25:59Z",
18 "sgVersion": 0,
19 "rules": [
20 {
21 "destGroupId": "",
22 "destIp": "all",
23 "direction": "egress",
24 "ethertype": "IPv4",
25 "portRange": "1-65535",
26 "protocol": "all",
27 "remark": "bae",
28 "securityGroupId": "g-4NxWoxeq",
29 "securityGroupRuleId": "r-gkv8yupumvx2",
30 "createdTime": "2020-07-27T13:00:52Z",
31 "updatedTime": "2020-07-27T13:00:52Z"
32 }
33 ],
34 "tags":[
35 {
36 "tagKey": tagKey,
37 "tagValue": tagValue
38 }
39 ]
40 }
41 ],
42 "isTruncated": false
43}