Baidu AI Cloud
中国站

百度智能云

Cloud Compute Service

Query the Security Group List

  • 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

There are no other special header fields except the public header field.

Request Parameters

Parameter Name Type Required? Parameter Position Description
version String Yes URL parameter API version number
marker String No Query parameters The start position of query to obtain the list by batch, which is a character string generated by the system.
maxKeys int No Query parameters Maximum number of master instances per 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 fill in this parameter.
vpcId String No Query parameters VPC instance ID used to query the security group list associated with the instance.

Return Header Field

There are no other special header fields except the common header field.

Return Parameter

Parameter Name Type Description
marker String Mark the starting position of the query
isTruncated boolean True means there is still data behind, and false means it is already the last page.
nextMarker String Get the marker value to be passed on the next page. This field does not appear when “isTruncated” is false.
maxKeys int Maximum number of master instances per page
securityGroups List<SecurityGroupModel> Security group information, a set of SecurityGroupModels.

Request Instance

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",
        "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
}
Previous
Create a Security Group
Next
Authorize the Security Group Rules