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

Get EC2 Instance Types Available in AWS Region

You can get a list of types of instances available in an AWS region with the specified ID.

Request

To retrieve instance types, send the HTTP GET request to the /regions/{regionId}/instancesTypes endpoint. {regionId} is a system ID assigned to the AWS region in the Veeam Backup for AWS REST API.

HTTP Request

GET https://<hostname>:<port>/api/v1/cloudInfrastructure/regions/{regionId}/instancesTypes

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

Sort

  • nameAsc
  • nameDesc

Specifies the order of items in the response. For more information, see Sort Parameter.

isArm64

  • true
  • false

Returns only EC2 instances powered by Arm-based AWS Graviton Processor. For more information, see Filter Parameters.

virtualizationTypes

[array]

Returns only EC2 instances with the specified AMI virtualization type. 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 collection of instance types available in the specific AWS region. The AmazonInstanceType schema is used for the collection representation.

Get EC2 Instance Types Available in AWS RegionExample

The following request returns instance types of an AWS region with the ID 9795e709-ab15-4498-894d-1a2dd766b4db.

Request:

GET https://135.169.170.192:11005/api/v1/cloudInfrastructure/regions/9795e709-ab15-4498-894d-1a2dd766b4db/instancesTypes

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

 

Response:

200

 

Response Body:

{

 "totalCount": 261,

 "results": [

   {

     "name": "a1.2xlarge",

     "cpuCount": 8,

     "ram": 16384,

     "isArm64": false,

     "virtualizationType": [

       "Hvm"

     ]

   },

   {

     "name": "a1.4xlarge",

     "cpuCount": 16,

     "ram": 32768,

     "isArm64": false,

     "virtualizationType": [

       "Hvm"

     ]

   },

...

    {

     "name": "i3en.3xlarge",

     "cpuCount": 12,

     "ram": 98304,

     "isArm64": false,

     "virtualizationType": [

       "Hvm"

     ]

   },

   {

     "name": "i3en.6xlarge",

     "cpuCount": 24,

     "ram": 196608,

     "isArm64": false,

     "virtualizationType": [

       "Hvm"

     ]

   },

...

       {

     "name": "z1d.xlarge",

     "cpuCount": 4,

     "ram": 32768,

     "isArm64": false,

     "virtualizationType": [

       "Hvm"

     ]

   }

 ],

 "_links": [

   {

     "method": "GET",

     "rel": "self",

     "href": "https://135.169.170.192:11005/api/v1/cloudInfrastructure/regions/9795e709-ab15-4498-894d-1a2dd766b4db/instancesTypes"

   }

 ]

}