RAravion
AwsCloudWatch

Get CloudWatch metric data

Fetch CloudWatch metric data for a module instance UI metric. Resolves the AWS account from awsAccountId + region. Applies a short Redis cache (60s for ranges that end at now, 5 min for fixed ranges).

get/aws/cloudwatch/metric

Request

  • Base URL
    https://api.ravion.com
  • Auth
    HTTP bearer

Query parameters

awsAccountIdstring required

AWS account database ID used to resolve credentials.

regionstring required

AWS region the metric lives in.

metricNamespacestring required

CloudWatch namespace (e.g. AWS/ECS)

metricNamestring required

CloudWatch metric name (e.g. CPUUtilization)

statisticstring required

CloudWatch statistic to apply (Average, Sum, Maximum, ...)

periodinteger required

Aggregation period in seconds (e.g. 300). Must obey CloudWatch's per-window granularity floor (60s ≤ 15d, 300s ≤ 63d, 3600s ≤ 455d).

startTimestring required

Inclusive start of the query window (ISO 8601). Must be earlier than endTime and within CloudWatch's 455-day retention.

endTimestring required

Inclusive end of the query window (ISO 8601). Must be after startTime and not in the future.

dimensionsstring[] nullable

Repeated dimensionName=dimensionValue pairs scoping the metric. At least one is required unless groupBy is set.

groupBystring nullable

Name of one dimension to split the metric by. The answer then holds one series per value of that dimension, among the metrics named metricName in metricNamespace whose dimensions are exactly dimensions plus this one. Must not also appear in dimensions. A namespace or dimension name containing ", ', \, { or } cannot be searched and answers 400.

groupValuesstring[] nullable

Values of groupBy to answer for, in place of the 10 largest: the answer then holds a series for each of these values that has datapoints in the window, and for no other. Repeat the parameter for each value; at most 500 distinct values. Requires groupBy.

Response

The request has succeeded.

omittedSeriesinteger

Present only when the request set groupBy: how many more values of the dimension had datapoints in the window but are not in series. A CloudWatch search sees at most 500 values, so for a dimension with more than that the count falls short. Always 0 with groupValues.

unitstring required

Display unit suffix for the metric, inferred server-side from the namespace + metric name (e.g. %, ``, B). Empty when unknown.

Changes

No recorded changes to this operation across all 2 revisions of this API.