• Elastic Cloud Server

ecs
  1. Help Center
  2. Elastic Cloud Server
  3. API Reference
  4. OpenStack Nova APIs
  5. Security Group Management
  6. Querying Security Groups (Discarded)

Querying Security Groups (Discarded)

Function Description

This interface is used to query security groups.

Constraints

This API will be discarded.

You are advised to use the desired network interface. For details, see section "Security Group (Native OpenStack API) > Querying Security Groups" in Virtual Private Network API Reference.

URI

GET /v2/{project_id}/os-security-groups

GET /v2.1/{project_id}/os-security-groups

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

NOTE:

Pagination query is not supported.

Request

N/A

Response

Response parameters

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Type

Description

security_groups

List

Specifies security groups. For details, see Table 3.

Table 3 security_group objects

Parameter

Type

Description

description

String

Specifies information about a security group. It is a string of 0 to 255 characters.

id

String

Specifies the security group ID in UUID format.

name

String

Specifies the security group name. It is a string of 0 to 255 characters.

rules

List

Specifies security group rules. For details, see Table 4.

tenant_id

String

Specifies the tenant or project ID.

Table 4 security_group_rule objects

Parameter

Type

Description

parent_group_id

String

Specifies the associated security group ID in UUID format.

ip_protocol

String

Specifies the protocol type or the IP protocol number. The value can be icmptcpudp, or the IP protocol number.

from_port

Int

Specifies the start port number. The value ranges from 1 to 65,535 and cannot be greater than to_port.

When ip_protocol is icmp, this parameter indicates the ICMP type field with a length from 0 to 255 characters.

NOTE:

The ICMP message type is determined by the type field and code field in the packet. For details, see Appendix > ICMP-Port Range Relationship Table in the Virtual Private Cloud API Referenceport_range_min indicates the ICMP type field, and port_range_max indicates the ICMP code field.

to_port

Int

Specifies the stop port number. The value ranges from 1 to 65,535 and cannot be less than from_port.

When ip_protocol is icmp, this parameter indicates the ICMP code field with a length from 0 to 255 characters.

NOTE:

The ICMP message type is determined by the type field and code field in the packet. For details, see section Appendix > ICMP-Port Range Relationship Table in Virtual Private Cloud API Referenceport_range_min indicates the ICMP type, and port_range_max indicates the ICMP code.

ip_range

Dict

Specifies the peer IP segment in CIDR format. For details, see Table 5.

Specify either ip_range or group.

group

Dict

Specifies the name of the peer security group and the ID of the tenant in the peer security group. For details, see Table 6.

Specify either ip_range or group.

id

String

Specifies the security group rule ID in UUID format.

Table 5 ip_range objects

Parameter

Type

Description

cidr

String(255)

Specifies the peer IP segment in CIDR format.

Table 6 group objects

Parameter

Type

Description

tenant_id

String

Specifies the ID of the tenant of the peer security group.

name

String

Specifies the name of the peer security group.

Examples

  • Example request
    GET /v2/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups
    GET /v2.1/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups
  • Example response
    {
        "security_groups": [
            {
                "rules": [
                    {
                        "from_port": null,
                        "group": {
                            "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae",
                            "name": "default"
                        },
                        "ip_protocol": null,
                        "to_port": null,
                        "parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450",
                        "ip_range": {},
                        "id": "bb3cc988-e06a-49f6-b668-600e8bf193ee"
                    },
                    {
                        "from_port": null,
                        "group": {
                            "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae",
                            "name": "default"
                        },
                        "ip_protocol": null,
                        "to_port": null,
                        "parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450",
                        "ip_range": {},
                        "id": "f9371051-d7e1-4be4-8748-77b1e0913730"
                    }
                ],
                "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae",
                "description": "default",
                "id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450",
                "name": "default"
            },
            {
                "rules": [
                    {
                        "from_port": 200,
                        "group": {},
                        "ip_protocol": "tcp",
                        "to_port": 400,
                        "parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5",
                        "ip_range": {
                            "cidr": "0.0.0.0/0"
                        },
                        "id": "3330120d-bbd1-4a73-bda9-0196a84d5670"
                    },
                    {
                        "from_port": 201,
                        "group": {},
                        "ip_protocol": "tcp",
                        "to_port": 400,
                        "parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5",
                        "ip_range": {
                            "cidr": "0.0.0.0/0"
                        },
                        "id": "b550c9a6-970a-462d-984e-265e88020818"
                    }
                ],
                "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae",
                "description": "desc-sg",
                "id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5",
                "name": "test-sg"
            }
        ]
    }

Returned Values

See General Request Returned Values.