This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Security Group by Name

You can get information about a security group with the specified name.

Request

GET https://<hostname>:4443/v6/EC2Resources/VirtualPrivateCloud/{id}/SecurityGroup/{securityGroupName}

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameters must be specified in the URL of the request:

Parameter	Type	Description
id	string	Specifies the Amazon Virtual Private Cloud (Amazon VPC) ID. For more information on how to get this parameter, see Getting Virtual Private Cloud.
securityGroupName	string	Specifies the security group name. For more information on how to get this parameter, see Getting Security Groups. For more information on security groups for Amazon VPC, see this Amazon article.
accountId	string	Specifies the identification number of a cloud account. For more information on how to get this parameter, see Getting Accounts.
regionId	string	Specifies the region ID of Amazon S3 object storage. For more information, see this Amazon article.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

The response body contains the following properties:

Property	Type	Description
id	string	Specifies the security group ID.
name	string	Specifies the security group name.

Example

The example shows how to get information about the SecurityGroup7 security group.

Request:

GET https://abc.tech.local:4443/v6/EC2Resources/VirtualPrivateCloud/vpc-831c72ea/SecurityGroup/SecurityGroup7?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&regionId=us-east-2

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"id": "sg-037e3bbe421e0d8b2",

"name": "SecurityGroup7"

}