Query the security group list - Developer Guide| Alibaba Cloud Documentation Center

Description

Query by page returns the basic information about all custom security groups. Each page contains 10 entries by default and the data is listed in descending order by security group ID.

Request Parameters

Name	Type	Required	Description
Action	String	Yes	Required parameter, with a value: DescribeSecurityGroups.
RegionId	String	Yes	The region.
VpcId	String	No	The ID of the VPC to which the security group belongs.
PageNumber	Integer	No	Current page, the start value is 1 and the default value is 1.
PageSize	Integer	No	Sets the number of lines per page for paging query. The maximum value is 50 and default value is 10.

Return Parameters

Name	Type	Description
TotalCount	Integer	The total number of security groups.
PageNumber	Integer	The current page.
PageSize	Integer	The number of lines per page.
RegionId	String	The region ID of the security group.
SecurityGroups	SecurityGroupItemType	The security group information, composed by a SecurityGroupItemType collection.

Error Code

Error Code	Description	Http status code	Meaning
MissingParameter	The input parameter RegionId that is mandatory for processing this request is not supplied.	400	The RegionId parameter is not specified
InvalidParameter	The specified parameter PageNumber is not valid.	400	The specified PageNumber parameter is invalid
InvalidParameter	The specified parameter PageSize is not valid.	400	The specified PageSize parameter is invalid

Examples

Request Example

https://ecs.aliyuncs.com/?Action=DescribeSecurityGroups
&RegionId=cn-hangzhou
&<Public Request Parameters>

Return Example

XML format

<DescribeSecurityGroupsResponse>
    <RequestId>94D38899-626D-434A-891F-7E1F77A81525</RequestId>
    <TotalCount>4</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <RegionId>cn-hangzhou</RegionId>
    <SecurityGroups>
        <SecurityGroup>
            <SecurityGroupId>sg-F876FF7BA</SecurityGroupId>
            <Description>Test</Description>
        </SecurityGroup>
        <SecurityGroup>
            <SecurityGroupId>sg-086FFC27A</SecurityGroupId>
            <Description>test00212</Description>
        </SecurityGroup>
        <SecurityGroup>
            <SecurityGroupId>sg-BA4B7975B</SecurityGroupId>
            <Description>cn-hangzhou test group</Description>
        </SecurityGroup>
        <SecurityGroup>
            <SecurityGroupId>sg-35F20777C</SecurityGroupId>
            <Description>cn-hangzhou test group</Description>
        </SecurityGroup>
    </SecurityGroups>
</DescribeSecurityGroupsResponse>

JSON format

{
    "RequestId": "94D38899-626D-434A-891F-7E1F77A81525",
    "TotalCount": 4,
    "PageSize": "10",
    "RegionId": "cn-hangzhou",
    "PageNumber": "1",
    "SecurityGroups": {
        "SecurityGroup": [{
            "SecurityGroupId": "sg-F876FF7BA",
            "Description": "TestByXcf"
        },
        {
            "SecurityGroupId": "sg-086FFC27A",
            "Description": "test00212"
        },
        {
            "SecurityGroupId": "sg-BA4B7975B",
            "Description": "cn-hangzhou test group"
        },
        {
            "SecurityGroupId": "sg-35F20777C",
            "Description": "cn-hangzhou test group"
        }]
    }
}