Menu
Amazon Lightsail
REST API Reference (API Version 2016-11-28)

GetInstanceMetricData

Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.

Request Syntax

{
   "endTime": number,
   "instanceName": "string",
   "metricName": "string",
   "period": number,
   "startTime": number,
   "statistics": [ "string" ],
   "unit": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

endTime

The end time of the time period.

Type: Timestamp

Required: Yes

instanceName

The name of the instance for which you want to get metrics data.

Type: String

Pattern: \w[\w\-]*\w

Required: Yes

metricName

The metric name to get data about.

Type: String

Valid Values: CPUUtilization | NetworkIn | NetworkOut | StatusCheckFailed | StatusCheckFailed_Instance | StatusCheckFailed_System

Required: Yes

period

The time period for which you are requesting data.

Type: Integer

Valid Range: Minimum value of 60. Maximum value of 86400.

Required: Yes

startTime

The start time of the time period.

Type: Timestamp

Required: Yes

statistics

The instance statistics.

Type: Array of strings

Valid Values: Minimum | Maximum | Sum | Average | SampleCount

Required: Yes

unit

The unit. The list of valid values is below.

Type: String

Valid Values: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None

Required: Yes

Response Syntax

{
   "metricData": [ 
      { 
         "average": number,
         "maximum": number,
         "minimum": number,
         "sampleCount": number,
         "sum": number,
         "timestamp": number,
         "unit": "string"
      }
   ],
   "metricName": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

metricData

An array of key-value pairs containing information about the results of your get instance metric data request.

Type: Array of MetricDatapoint objects

metricName

The metric name to return data for.

Type: String

Valid Values: CPUUtilization | NetworkIn | NetworkOut | StatusCheckFailed | StatusCheckFailed_Instance | StatusCheckFailed_System

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

HTTP Status Code: 400

AccountSetupInProgressException

Lightsail throws this exception when an account is still in the setup in progress state.

HTTP Status Code: 400

InvalidInputException

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Note

Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

HTTP Status Code: 400

NotFoundException

Lightsail throws this exception when it cannot find a resource.

HTTP Status Code: 400

OperationFailureException

Lightsail throws this exception when an operation fails to execute.

HTTP Status Code: 400

ServiceException

A general service exception.

HTTP Status Code: 500

UnauthenticatedException

Lightsail throws this exception when the user has not been authenticated.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: