Get specs for an instance type.

GET

/cloud-providers/{cloudProviderId}/instance-types/{instanceTypeId}

Returns the specs for a given instance type.

Authorizations

• publicOauth2

Parameters

Path Parameters

cloudProviderId

required

The ID of the cloud provider.

string

Allowed values:

aws

azure

gcp

ID of a cloud provider.

instanceTypeId

required

string

Example:

i4i.large

ID of an instance type.

Responses

200

Instance type specs

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

object

instanceType

required

string

Example:

trn1.32xlarge

vcpus

required

integer

Example:

128

memoryGib

required

integer

Example:

512

localStorage

required

object

numberOfDisks

required

integer

Example:

4

diskSizeGib

required

integer

Example:

1900

totalSizeGib

required

integer

Example:

7600

supportedArchitectures

required

Array<string>

Allowed values:

x86_64

arm64

Example

Content type: application/json

Copied!

{ 

{

"instanceType": "trn1.32xlarge",

"vcpus": 128,

"memoryGib": 512,

"localStorage": { 

"numberOfDisks": 4,

"diskSizeGib": 1900,

"totalSizeGib": 7600

},

"supportedArchitectures": [ 

"x86_64"

]

}

401

Access token is missing or invalid

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "invalid_token",

"message": "The access token expired."

}

403

Permission denied

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

404

Resource not found

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}

500

Internal Server Error

Response Headers

X-Request-Id

string

Example:

b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object

code

Unique (system-wide) error code for an error happened

string

message

required

Developer-friendly message explaining error

string

key

additional properties

any

Example

Content type: application/json

Copied!

{ 

{

"code": "string",

"message": "string"

}