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

Get Amazon Connection Subnets

You can get a list of all subnets of an amazon connection with the specified ID.

Request

To retrieve a representation of a collection of subnets of a specific amazon connection, send the HTTP GET request to the /amazonConnections/{amazonConnectionId}/cloudSubnetworks endpoint. {amazonConnectionId} is a system ID assigned to the amazon connection in the Veeam Backup for AWS REST API.

HTTP Request

GET https://<hostname>:<port>/api/v1/amazonConnections/{amazonConnectionId}/cloudSubnetworks

Query Parameters

To control the amount and order of data in the response, you can use Offset, Limit and the following query parameters:

Query Parameter

Value

Description

cloudNetworkId

string

Returns only subnet that belongs to an Amazon VPC with the specified AWS ID. For more information, see Filter Parameters.

availabilityZone

string($uuid)

Returns only subnet that placed in an availability zone with the specified ID.  For more information, see Filter Parameters.

Request Headers

The request contains the following headers.

Header

Required/Optional

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

x-api-version

Required

1.0-rev0

Specifies the current revision of the Veeam Backup for AWS REST API.

Accept

Optional

  • application/json
  • application/problem+json

Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type.

Response

The server returns the following response to the client.

Response Code

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 HTTP headers.

Header

Value

Description

Content-Length

integer

Identifies the length of the response body message, in bytes.

Content-Type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for AWS returns a list of subnets of the amazon connection with the specified ID. The CloudSubnetwork schema is used for the collection representation.

Get Amazon Connection SubnetsExample

The following request returns a full list of subnets of an amazon connection with the ID 2c7eb8fb-40e3-4495-9dc9-30f969277917.

Request:

GET https://135.169.170.192:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudSubnetworks

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

 

Response:

200

 

Response Body:

{

 "totalCount": 5,

 "results": [

   {

     "resourceId": "subnet-0b23920a483b0ce42",

     "name": "10.0.1.0/24 (eu-north-1c)",

     "cloudNetworkResourceId": "vpc-02a8df746eacfcc4b",

     "cidrBlock": "10.0.1.0/24",

     "availabilityZone": "eu-north-1c"

   },

   {

     "resourceId": "subnet-00a48d4a",

     "name": "172.31.0.0/20 (eu-north-1c)",

     "cloudNetworkResourceId": "vpc-f3e40a9a",

     "cidrBlock": "172.31.0.0/20",

     "availabilityZone": "eu-north-1c"

   },

   {

     "resourceId": "subnet-8e54b8e7",

     "name": "172.31.16.0/20 (eu-north-1a)",

     "cloudNetworkResourceId": "vpc-f3e40a9a",

     "cidrBlock": "172.31.16.0/20",

     "availabilityZone": "eu-north-1a"

   },

   {

     "resourceId": "subnet-0c43e943be69d06a4",

     "name": "172.31.255.0/28 (eu-north-1a)",

     "cloudNetworkResourceId": "vpc-f3e40a9a",

     "cidrBlock": "172.31.255.0/28",

     "availabilityZone": "eu-north-1a"

   },

   {

     "resourceId": "subnet-617e7019",

     "name": "172.31.32.0/20 (eu-north-1b)",

     "cloudNetworkResourceId": "vpc-f3e40a9a",

     "cidrBlock": "172.31.32.0/20",

     "availabilityZone": "eu-north-1b"

   }

 ],

 "_links": [

   {

     "method": "GET",

     "rel": "self",

     "href": "https://135.169.170.192:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudSubnetworks"

   }

 ]

}