This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Security Groups
You can get a list of security groups that will be associated with the Amazon archiver appliance.
Request
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. |
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
In the response body, the server returns a resource representation of the /EC2Resources/VirtualPrivateCloud/{id}/SecurityGroup resource. The response body contains the following properties:
Property | Type | Description |
|---|---|---|
id | string | Specifies a security group ID. |
name | string | Specifies a security group name. |
Example
The example returns a resource representation of security groups within Amazon Virtual Private Cloud with the ID vpc-831c72ea.
Request: GET https://abc.tech.local:4443/v6/EC2Resources/VirtualPrivateCloud/vpc-831c72ea/SecurityGroup?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7®ionId=us-east-2
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: [ { "id": "sg-00318eaed6d2d5b6d", "name": "SecurityGroup1" }, { "id": "sg-012d0e7ee729436e3", "name": "SecurityGroup2" }, { "id": "sg-0140a977cf5209469", "name": "SecurityGroup3" }, { "id": "sg-0174356495010f899", "name": "SecurityGroup4" }, { "id": "sg-01a0a71c60129ba25", "name": "SecurityGroup5" }, { "id": "sg-01fa0cec3d3bdf1dc", "name": "SecurityGroup6" }, { "id": "sg-037e3bbe421e0d8b2", "name": "SecurityGroup7" }, ... ] |
