Query Security Group List
Last Updated:2021-12-16
This API is used to query all security group information of users.
Request Structure
GET /v{version}/securityGroup?marker={marker}&maxKeys={maxKeys}&instanceId={instanceId}&vpcId={vpcId} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
Request Header Field
No other special header fields are available except for the public header fields.
Request Parameters
Parameter Name | Type | Required? | Parameter Position | Description |
---|---|---|---|---|
version | String | Yes | URL parameter | API version number |
marker | String | No | Query parameter | The start position of getting the list in batches, which is a string generated by the system. |
maxKeys | int | No | Query parameters | Maximum number of keys contained on each page, which usually does not exceed 1,000. The default value is 1000. |
instanceId | String | No | Query parameters | Instance ID used to query the security group list associated with the instance. To query all security group information created, do not enter this parameter. |
vpcId | String | No | Query parameters | VPC instance ID used to query the security group list associated with the instance. With the instanceId entered, you must enter the vpcId. |
Return Header Field
There are no other special header fields except for the public header field.
Return Parameter
Parameter Name | Type | Description |
---|---|---|
marker | String | Marks the starting position of the query |
isTruncated | boolean | True means there is still data behind, and false means the current page is already the last page. |
nextMarker | String | Gets the “marker” value to be passed on the next page. This field does not appear when “isTruncated” is “false”. |
maxKeys | int | Maximum number of keys contained on each page. |
securityGroups | List<[SecurityGroupModel](VPC/API Reference/Appendix.md#SecurityGroupModel)> | Security group information, a set of SecurityGroupModels. |
Request Example
GET /v2/securityGroup?instanceId=i-kjuinbcd HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
Return Example
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"nextMarker": "",
"marker": "",
"maxKeys": 1000,
"securityGroups": [
{
"desc": "",
"id": "g-4NxWoxeq",
"name": "common2",
"vpcId":"vpc-9xuevtmc6u",
"createdTime":"2019-09-24T08:25:59Z",
"sgVersion": 0,
"rules": [
{
"destGroupId": "",
"destIp": "all",
"direction": "egress",
"ethertype": "IPv4",
"portRange": "1-65535",
"protocol": "all",
"remark": "bae",
"securityGroupId": "g-4NxWoxeq",
"securityGroupRuleId": "r-gkv8yupumvx2",
"createdTime": "2020-07-27T13:00:52Z",
"updatedTime": "2020-07-27T13:00:52Z"
}
],
"tags":[
{
"tagKey": tagKey,
"tagValue": tagValue
}
]
}
],
"isTruncated”: false
}