DescribeSecurityGroups

GET /?Action=DescribeSecurityGroups
Description

Describes one or more security groups.
You can specify either the name of the security groups or their IDs.
You can use the Filter.N parameter to filter the security groups on the following properties:

  • description: The description of the security group.

  • group-id: The ID of the security group.

  • group-name: The name of the security group.

  • ip-permission.cidr: A CIDR range that has been granted permission.

  • ip-permission.from-port: The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id: The ID of a security group that has been granted permission.

  • ip-permission.group-name: The name of a security group that has been granted permission.

  • ip-permission.protocol: The IP protocol for the permission (tcp | udp | icmp, or a protocol number, or -1 for all protocols).

  • ip-permission.to-port: The end of the port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id: The account ID of a user that has been granted permission.

  • owner-id: The account ID of the owner of the security group.

  • tag-key: The key of a tag associated with the resource.

  • tag-value: The value of a tag associated with the resource.

  • tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.

  • vpc-id: The ID of the VPC specified when the security group was created.

Note

If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.
Body parameter

Required: false
Name: DescribeSecurityGroupsRequest

Name Description Required Schema Default Example

Filter.N

One or more filters. Example:
osc-cli fcu DescribeSecurityGroups \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"

false

Filter

GroupId.N

The ID of one or more security groups.

false

string

GroupName.N

The name of one or more security groups. This parameter only matches security groups in the public Cloud. To match security groups in a VPC, use the group-name filter instead.

false

string
Responses
HTTP Code 200
HTTP Code Description Schema

200

DescribeSecurityGroupsResult

Response 200

Response 200

Name Description Required Schema Default Example

requestId

The ID of the request.

false

string

securityGroupInfo.N

Information about one or more security groups.

false

SecurityGroup