GetLoadBalancerMetricData
Returns information about health metrics for your Lightsail load balancer.
Request Syntax
{ "endTime":
number
, "loadBalancerName": "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 period.
Type: Timestamp
Required: Yes
 loadBalancerName

The name of the load balancer.
Type: String
Pattern:
\w[\w\]*\w
Required: Yes
 metricName

The metric about which you want to return information. Valid values are listed below, along with the most useful
statistics
to include in your request.
ClientTLSNegotiationErrorCount
 The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.Statistics
: The most useful statistic isSum
. 
HealthyHostCount
 The number of target instances that are considered healthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
. 
UnhealthyHostCount
 The number of target instances that are considered unhealthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
. 
HTTPCode_LB_4XX_Count
 The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. 
HTTPCode_LB_5XX_Count
 The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. Note thatMinimum
,Maximum
, andAverage
all return1
. 
HTTPCode_Instance_2XX_Count
 The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. 
HTTPCode_Instance_3XX_Count
 The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. 
HTTPCode_Instance_4XX_Count
 The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. 
HTTPCode_Instance_5XX_Count
 The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. 
InstanceResponseTime
 The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.Statistics
: The most useful statistic isAverage
. 
RejectedConnectionCount
 The number of connections that were rejected because the load balancer had reached its maximum number of connections.Statistics
: The most useful statistic isSum
. 
RequestCount
 The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.
Type: String
Valid Values:
ClientTLSNegotiationErrorCount  HealthyHostCount  UnhealthyHostCount  HTTPCode_LB_4XX_Count  HTTPCode_LB_5XX_Count  HTTPCode_Instance_2XX_Count  HTTPCode_Instance_3XX_Count  HTTPCode_Instance_4XX_Count  HTTPCode_Instance_5XX_Count  InstanceResponseTime  RejectedConnectionCount  RequestCount
Required: Yes

 period

The granularity, in seconds, of the returned data points.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 86400.
Required: Yes
 startTime

The start time of the period.
Type: Timestamp
Required: Yes
 statistics

An array of statistics that you want to request metrics for. Valid values are listed below.

SampleCount
 The count (number) of data points used for the statistical calculation. 
Average
 The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed. 
Sum
 All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric. 
Minimum
 The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application. 
Maximum
 The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.
Type: Array of strings
Valid Values:
Minimum  Maximum  Sum  Average  SampleCount
Required: Yes

 unit

The unit for the time period request. Valid values are listed 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 metric datapoint objects.
Type: Array of MetricDatapoint objects
 metricName

The metric about which you are receiving information. Valid values are listed below, along with the most useful
statistics
to include in your request.
ClientTLSNegotiationErrorCount
 The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.Statistics
: The most useful statistic isSum
. 
HealthyHostCount
 The number of target instances that are considered healthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
. 
UnhealthyHostCount
 The number of target instances that are considered unhealthy.Statistics
: The most useful statistic areAverage
,Minimum
, andMaximum
. 
HTTPCode_LB_4XX_Count
 The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. 
HTTPCode_LB_5XX_Count
 The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. Note thatMinimum
,Maximum
, andAverage
all return1
. 
HTTPCode_Instance_2XX_Count
 The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. 
HTTPCode_Instance_3XX_Count
 The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. 
HTTPCode_Instance_4XX_Count
 The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. 
HTTPCode_Instance_5XX_Count
 The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
. 
InstanceResponseTime
 The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.Statistics
: The most useful statistic isAverage
. 
RejectedConnectionCount
 The number of connections that were rejected because the load balancer had reached its maximum number of connections.Statistics
: The most useful statistic isSum
. 
RequestCount
 The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.Statistics
: The most useful statistic isSum
. Note thatMinimum
,Maximum
, andAverage
all return1
.
Type: String
Valid Values:
ClientTLSNegotiationErrorCount  HealthyHostCount  UnhealthyHostCount  HTTPCode_LB_4XX_Count  HTTPCode_LB_5XX_Count  HTTPCode_Instance_2XX_Count  HTTPCode_Instance_3XX_Count  HTTPCode_Instance_4XX_Count  HTTPCode_Instance_5XX_Count  InstanceResponseTime  RejectedConnectionCount  RequestCount

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
Domainrelated APIs are only available in the N. Virginia (useast1) Region. Please set your AWS Region configuration to useast1 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 languagespecific AWS SDKs, see the following: