Querying Security Groups

Function

This API is used to query all security groups accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query operation. If the number of records exceeds 2000, the pagination marker will be returned. For details, see section Pagination.

URI

GET /v2.0/security-groups

Example of querying security groups by page

GET https://{Endpoint}/v2.0/security-groups?limit=2&marker=0431c9c5-1660-42e0-8a00-134bec7f03e2&page_reverse=False

Table 1 describes the parameters.

**Table 1** Parameter description
Name	Mandatory	Type	Description
id	No	String	Specifies that the ID is used as the filtering condition.
name	No	String	Specifies that the name is used as the filtering condition.
description	No	String	Specifies that the description is used as the filtering condition.
tenant_id	No	String	Specifies that the project ID is used as the filtering condition.
marker	No	String	Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. This parameter can work together with the parameter limit. If parameters marker and limit are not passed, resource records on the first page will be returned. If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned. If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned. If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, resource records starting from the 11th records (including 11th) will be returned.
limit	No	Integer	Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. limit can be used together with marker. For details, see the parameter description of marker.

Request Parameters

None

Example Request

GET https://{Endpoint}/v2.0/security-groups?limit=1

Response Parameters

**Table 2** Response parameter
Parameter	Type	Description
security_groups	Array of Security Group objects	Specifies the security group list. For details, see Table 3.
security_groups_links	Array of SecurityGroupsLink objects	Shows pagination information about security groups. Only when limit is used for filtering and the number of resources exceeds the value of limit or 2000 (default value of limit), value next will be returned for rel and a link for href.

**Table 3** **Security Group** objects
Attribute	Type	Description
id	String	Specifies the security group ID. This parameter is not mandatory when you query security groups.
tenant_id	String	Specifies the project ID.
name	String	Specifies the security group name.
description	String	Provides supplementary information about the security group.
security_group_rules	Array of Security Group Rule objects	Specifies the security group rule list. For details, see Table 4.
project_id	String	Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.
created_at	String	Specifies the time (UTC) when the security group is created. Format: yyyy-MM-ddTHH:mm:ss
updated_at	String	Specifies the time (UTC) when the security group is updated. Format: yyyy-MM-ddTHH:mm:ss

**Table 4** **Security Group Rule** objects
Attribute	Type	Description
id	String	Specifies the security group rule ID. This parameter is not mandatory when you query security group rules.
description	String	Provides supplementary information about the security group rule.
security_group_id	String	Specifies the ID of the belonged security group.
remote_group_id	String	Specifies the peer ID of the belonged security group.
direction	String	Specifies the direction of the traffic for which the security group rule takes effect.
remote_ip_prefix	String	Specifies the peer IP address segment.
protocol	String	Specifies the protocol type or the IP protocol number.
port_range_max	Integer	Specifies the maximum port number. When ICMP is used, the value is the ICMP code.
port_range_min	Integer	Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. When the TCP or UDP protocol is used, both port_range_max and port_range_min must be specified, and the port_range_max value must be greater than the port_range_min value. When the ICMP protocol is used, if you specify the ICMP code (port_range_max), you must also specify the ICMP type (port_range_min).
ethertype	String	Specifies the network type. IPv4 and IPv6 are supported.
tenant_id	String	Specifies the project ID.
remote_address_group_id	String	Specifies the remote IP address group ID. The value is mutually exclusive with parameters remote_ip_prefix and remote_group_id.
project_id	String	Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.
created_at	String	Specifies the time (UTC) when the security group rule is created. Format: yyyy-MM-ddTHH:mm:ss
updated_at	String	Specifies the time (UTC) when the security group rule is updated. Format: yyyy-MM-ddTHH:mm:ss

**Table 5** **SecurityGroupsLink** objects
Parameter	Type	Description
href	String	Specifies the API link.
rel	String	Specifies the relationship between the API link and the API version.

Example Response

{
    "security_groups": [
        {
            "id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
            "name": "sg-ad3f",
            "description": "",
            "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
            "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
            "security_group_rules": [
                {
                    "id": "d90e55ba-23bd-4d97-b722-8cb6fb485d69",
                    "direction": "ingress",
                    "protocol": null,
                    "ethertype": "IPv4",
                    "description": null,
                    "remote_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
                    "remote_ip_prefix": null,
                    "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
                    "port_range_max": null,
                    "port_range_min": null,
                    "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
                    "remote_address_group_id": "0150a3a7-82ca-4569-865c-04e46e5e9249" 
                },
                {
                    "id": "aecff4d4-9ce9-489c-86a3-803aedec65f7",
                    "direction": "egress",
                    "protocol": null,
                    "ethertype": "IPv4",
                    "description": null,
                    "remote_group_id": null,
                    "remote_ip_prefix": null,
                    "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
                    "port_range_max": null,
                    "port_range_min": null,
                    "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
                    "remote_address_group_id": null
                }
            ],
            "created_at": "2018-09-12T08:24:14",
            "updated_at": "2018-09-12T08:24:14"
        }
    ],
    "security_groups_links": [
       {
            "rel": "next", 
            "href": "https://{Endpoint}/v2.0/security-groups?limit=1&marker=0431c9c5-1660-42e0-8a00-134bec7f03e2"
        }, 
       {    "rel": "previous", 
            "href": "https://{Endpoint}/v2.0/security-groups?limit=1&marker=0431c9c5-1660-42e0-8a00-134bec7f03e2&page_reverse=True"
        }
    ]
}