GET CDN Metrics.

POST

/api/cdn/namespaces/{namespace}/cdn_loadbalancer/metrics

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/cdn/namespaces/example/cdn_loadbalancer/metrics \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "end_time": "example", "field_selector": [ "REQUEST_TOTAL_SUM" ], "filter": [ { "operator": "OPERATOR_TYPE_IN", "tag": "CDN_DISTRIBUTION_NAME", "values": [ "example" ] } ], "group_by": [ "CDN_DISTRIBUTION_NAME" ], "namespace": "example", "start_time": "example", "step": "example" }'

• F5 Distributed Cloud Console

Initial metrics request for CDN loadbalancers.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace x-required Namespace scope of the metric request.

Request Body^required

Media typeapplication/json

Metrics Request parameters

CDN Metrics request parameters.

object

end_time

End Time

Format: unix_timestamp|RFC 3339 Required: YES.

string

<= 1024 characters

field_selector

Field Selector

Fields (Metrics) selected to be queried.

Required: YES.

Array<string>

<= 10 items

Allowed values: REQUEST_TOTAL_SUM REQUEST_FAILED_SUM REQUEST_1XX_SUM REQUEST_2XX_SUM REQUEST_3XX_SUM REQUEST_4XX_SUM REQUEST_5XX_SUM DATA_OUT_SUM LATENCY_MEAN DATA_IN_SUM

filter

Metrics Filter options

CDN Metrics filter OPTIONS.

Array<object>

Metrics Filter options

CDN Metrics filter OPTIONS.

object

operator

string

default: OPERATOR_TYPE_IN

Allowed values: OPERATOR_TYPE_IN OPERATOR_TYPE_NOT_IN

tag

string

default: CDN_DISTRIBUTION_NAME

Allowed values: CDN_DISTRIBUTION_NAME CACHE_HIT_TYPE REQUEST_COUNTRY HTTP_VERSION TLS_VERSION POP_REGION POP

values

Filter values

Filter values Required: YES.

Array<string>

group_by

Group By

Aggregate data by zero or more tags.

Array<string>

Allowed values: CDN_DISTRIBUTION_NAME CACHE_HIT_TYPE REQUEST_COUNTRY HTTP_VERSION TLS_VERSION POP_REGION POP

namespace

Namespace

Namespace scope of the metric request Required: YES.

string

>= 6 characters <= 1024 characters

start_time

Start Time

Format: unix_timestamp|RFC 3339 Required: YES.

string

<= 1024 characters

step

Step

Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, … Tn=tn-1+step, where tn <= end_time. Depending on the time range, the step has a minimum value (due to rollups). For e.g. For ranges in last one hr, step minimum is 5m, for ranges beyond a day, its 1h etc. Step value used is the max(, ) Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days

Optional: If not specified, then step size is evaluated to <end_time - start_time>

string

<= 1024 characters

Responses

200

A successful response.

Media typeapplication/json

Metrics Response

CDN Metrics response message.

object

items

Metrics Response Data

CDN Metrics response data items. Each instance has response for a field queried.

Array<object>

Metrics Response Data

CDN Metrics response data. This is specific to a metric field.

object

series

Metrics Series

CDN Metrics response series for the field in this message.

Array<object>

Metrics Series

CDN Metrics response series. Each series instance has data for a combination of group-by tag values.

object

group_by

Metrics group by options

CDN Metrics group-by tag combination.

Array<object>

Metrics group by options

CDN Metrics group by OPTIONS.

object

name

string

default: CDN_DISTRIBUTION_NAME

Allowed values: CDN_DISTRIBUTION_NAME CACHE_HIT_TYPE REQUEST_COUNTRY HTTP_VERSION TLS_VERSION POP_REGION POP

value

Group-By tag Value

Group-By tag Value.

string

>= 3 characters <= 1024 characters

value

Metrics Response Value

CDN Metrics data for the series.

Array<object>

>= 3 characters <= 15 characters

Metrics Response Value

CDN Metrics response value.

object

timestamp

Metric Timestamp

Metric Timestamp in unix_timestamp.

string format: date-time

<= 1024 characters

value

Metric Value

Metric Value.

string

>= 3 characters <= 1024 characters

type

string

default: REQUEST_TOTAL_SUM

Allowed values: REQUEST_TOTAL_SUM REQUEST_FAILED_SUM REQUEST_1XX_SUM REQUEST_2XX_SUM REQUEST_3XX_SUM REQUEST_4XX_SUM REQUEST_5XX_SUM DATA_OUT_SUM LATENCY_MEAN DATA_IN_SUM

unit

string

default: COUNT

Allowed values: COUNT BYTES MILLISECONDS

step

Step

The effective step used in the response. It could be higher than the requested step due to rollups. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.

string

<= 1024 characters

Example

{
  "items": [
    {
      "series": [
        {
          "group_by": [
            {
              "name": "CDN_DISTRIBUTION_NAME"
            }
          ]
        }
      ],
      "type": "REQUEST_TOTAL_SUM",
      "unit": "COUNT"
    }
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example