Metrics

POST

/api/data/namespaces/{namespace}/nfv_services/metrics

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

• F5 Distributed Cloud Console

Nfv Service metrics.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Only system namespace is supported.

Request Body^required

Media typeapplication/json

Metrics Request

Request to GET the metrics for Nfv services.

object

end_time

End time

End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339

Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to

string

<= 1024 characters

field_selector

Field Selector

Select fields to be returned in the response. One or more fields in {TX_THROUGHPUT_BYTES, CONNECTION_RATE, TX_THROUGHPUT_PACKETS, RX_THROUGHPUT_BYTES, RX_THROUGHPUT_PACKETS} can be specified.

Required: YES.

Array<string>

>= 1 items <= 8 items

Allowed values: TX_THROUGHPUT_BYTES CONNECTION_RATE TX_THROUGHPUT_PACKETS RX_THROUGHPUT_BYTES RX_THROUGHPUT_PACKETS CPU_UTILIZATION DISK_READ_OPS DISK_WRITE_OPS DISK_READ_BYTES DISK_WRITE_BYTES NETWORK_IN_BYTES NETWORK_OUT_BYTES NETWORK_IN_PACKETS NETWORK_OUT_PACKETS HEALTHSCORE

filter

Label Filter

Filter is used to specify the list of matchers syntax for filter := {[]} := "" := string One or more labels defined in MetricLabel {SITE, SERVICE, SERVICE_INSTANCE} can be specified in the filter. := string := [”=”|”!=”|”=”|”!”] = : equal to != : not equal to =~ : regex match !~ : not regex match

Optional: If not specified, metric will be aggregated based on the group_by labels.

string

<= 1024 characters

group_by

Group by

Aggregate data by zero or more labels {SITE, SERVICE, SERVICE_INSTANCE}

Array<string>

Allowed values: SITE SERVICE SERVICE_INSTANCE SERVICE_INSTANCE_HOSTNAME

namespace

Namespace

Only system namespace is supported.

string

>= 6 characters <= 1024 characters

start_time

Start time

Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339

Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.

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. 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

Metrics for NFV Services.

object

data

Data

Data contains time-series metric data for Nfv services.

Array<object>

Metric Data

Metric data contains the metric type and the corresponding metric value.

object

data

Data

List of metric data.

Array<object>

Metric Type Data

Metric Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.

object

key

Key

Key contains the name/value pair. “name” is the label name defined in “MetricLabel”

object

value

Value

List of metric values.

Array<object>

>= 3 characters <= 15 characters

Metric Value

Metric data contains timestamp and the value.

object

timestamp

Timestamp

Timestamp

number format: double

trend_value

object

description

Description

Description of the method used to calculate trend.

string

>= 21 characters <= 1024 characters

previous_value

Previous Value

Configuration parameter for previous value

string

<= 1024 characters

sentiment

string

default: TREND_SENTIMENT_NONE

Allowed values: TREND_SENTIMENT_NONE TREND_SENTIMENT_POSITIVE TREND_SENTIMENT_NEGATIVE

value

Value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

value

Value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

type

string

default: TX_THROUGHPUT_BYTES

Allowed values: TX_THROUGHPUT_BYTES CONNECTION_RATE TX_THROUGHPUT_PACKETS RX_THROUGHPUT_BYTES RX_THROUGHPUT_PACKETS CPU_UTILIZATION DISK_READ_OPS DISK_WRITE_OPS DISK_READ_BYTES DISK_WRITE_BYTES NETWORK_IN_BYTES NETWORK_OUT_BYTES NETWORK_IN_PACKETS NETWORK_OUT_PACKETS HEALTHSCORE

unit

string

default: UNIT_MILLISECONDS

Allowed values: UNIT_MILLISECONDS UNIT_SECONDS UNIT_MINUTES UNIT_HOURS UNIT_DAYS UNIT_BYTES UNIT_KBYTES UNIT_MBYTES UNIT_GBYTES UNIT_TBYTES UNIT_KIBIBYTES UNIT_MIBIBYTES UNIT_GIBIBYTES UNIT_TEBIBYTES UNIT_BITS_PER_SECOND UNIT_BYTES_PER_SECOND UNIT_KBITS_PER_SECOND UNIT_KBYTES_PER_SECOND UNIT_MBITS_PER_SECOND UNIT_MBYTES_PER_SECOND UNIT_CONNECTIONS_PER_SECOND UNIT_ERRORS_PER_SECOND UNIT_PACKETS_PER_SECOND UNIT_REQUESTS_PER_SECOND UNIT_PACKETS UNIT_PERCENTAGE UNIT_COUNT

step

step

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

string

<= 1024 characters

Example

{
  "data": [
    {
      "data": [
        {
          "value": [
            {
              "trend_value": {
                "sentiment": "TREND_SENTIMENT_NONE"
              }
            }
          ]
        }
      ],
      "type": "TX_THROUGHPUT_BYTES",
      "unit": "UNIT_MILLISECONDS"
    }
  ]
}

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