Getting Instance Type by Name
You can get information about an instance type with the specified name that the Amazon archiver appliance will use.
Request
GET https://<hostname>:4443/v6/EC2Resources/InstanceType/{instanceTypeName} |
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 |
|---|---|---|
instanceTypeName | string | Specifies the instance type. For more information on how to get this parameter, see Getting Instance Types. For more information on instance types, 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 |
|---|---|---|
type | string | Specifies the instance type. For more information on instance types, see this Amazon article. |
cores | integer | Specifies a number of processor cores. |
memory | integer | Specifies the instance memory in Bytes. |
Example
The example shows how to get information about the m6i.xlarge instance type.
Request: GET https://abc.tech.local:4443/v6/EC2Resources/InstanceType/m6i.xlarge?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7®ionId=us-east-2
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: [ { "type": "m6i.xlarge", "cores": 4, "memory": 17179869184 } ] |