PVC Metrics.

POST

/api/data/namespaces/{namespace}/virtual_k8s/pvc/metrics

const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/example/virtual_k8s/pvc/metrics';
const options = {
  method: 'POST',
  headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'},
  body: '{"end_time":"example","field_selector":["PVC_USAGE"],"filter":"example","group_by":["NAMESPACE"],"namespace":"example","range":"example","start_time":"example","step":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

API to GET PVC capacity/usage.

Examples of this operation.

Authorizations

ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace

Request Body^required

application/json

PVC Metrics Request

Request to GET the metrics for PVC.

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 {PVC_USAGE, PVC_CAPACITY} can be specified.

Required: YES.

Array<string>

>= 1 items <= 8 items

Allowed values: PVC_USAGE PVC_CAPACITY

filter

Label Filter

Filter is used to specify the list of matchers syntax for filter := {[]} := "" := string One or more labels defined in MetricLabel {PVC, SITE} 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 {NAMESPACE, PVC, SITE}

Array<string>

Allowed values: NAMESPACE PVC SITE

namespace

Namespace

Human-readable name for the resource

string

>= 6 characters <= 1024 characters

range

Range

Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days

Note: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time

Optional: If not specified, range is set to 5m.

string

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

application/json

PVC Metrics Response

Metrics response for PVC.

object

data

Data

Data contains time-series metric data for PVC.

Array<object>

PVC Metric Data

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

object

data

Data

List of metric data.

Array<object>

PVC Metric Type Data

PVC 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 “PVCMetricLabel”

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

X-displayName: “Description” description of the method used to calculate trend.

string

>= 21 characters <= 1024 characters

previous_value

Previous Value

X-displayName: “Previous Value”

string

<= 1024 characters

sentiment

string

default: TREND_SENTIMENT_NONE

Allowed values: TREND_SENTIMENT_NONE TREND_SENTIMENT_POSITIVE TREND_SENTIMENT_NEGATIVE

value

Value

X-displayName: “Value”

string

>= 3 characters <= 1024 characters

value

Value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

type

string

default: PVC_USAGE

Allowed values: PVC_USAGE PVC_CAPACITY

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": "PVC_USAGE",
      "unit": "UNIT_MILLISECONDS"
    }
  ]
}

401

Returned when operation is not authorized.

application/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

application/json

string format: string

Example^generated

example

404

Returned when resource is not found.

application/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

application/json

string format: string

Example^generated

example

429

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

application/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

application/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

application/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

application/json

string format: string

Example^generated

example

PVC Metrics.

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

Example

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

429

Examplegenerated

500

Examplegenerated

503

Examplegenerated

504

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated