Skip to content
API Enriched

All Cloud Connect Segment Metrics.

POST
/api/data/namespaces/system/cloud_connects/segment_metrics
curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/system/cloud_connects/segment_metrics \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "end_time": "example", "field_selector": [ "METRIC_TYPE_NONE" ], "is_trend_request": true, "label_filter": [ { "label": "LABEL_NONE", "op": "EQ", "value": "example" } ], "start_time": "example", "step": "example" }'

Cloud Connect APIs are used to GET the segment data for cloud connect.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
List Segment metrics Request

Cloud_connect API is used to GET the in/out throughput for the tenant’s customer edges.

object
end_time
end_time

End time of metric collection from which data will be considered to fetch cloud connect data. 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. Field_selector is used to specify the fields to be returned in the response, thereby limiting the amount of data returned in the response.

Note: Selecting many/all fields may impact the query latency.

Optional: If not specified, only the following fields are returned in the response. METRIC_TYPE_IN_BYTES, METRIC_TYPE_OUT_BYTES.

Array<string>
Allowed values: METRIC_TYPE_NONE METRIC_TYPE_IN_BYTES METRIC_TYPE_OUT_BYTES METRIC_TYPE_TOTAL_BYTES
is_trend_request

Trend value computation requested by the user Optional: default is false.

boolean format: boolean
label_filter
label_filter

List of label filter expressions of the form “label key” QueryOp “value”. Response will only contain data that matches all the conditions specified in the label_filter.

Optional: If not specified, cloud connect data for all sites will be returned in the response.

Array<object>
<= 100 items
Label Filter

Metrics used in the cloud connect are tagged with labels listed in the enum Label. Label Filter is used to filter the timeseries that match the specified label key/value and the operator.

object
label
string
default: LABEL_NONE
Allowed values: LABEL_NONE LABEL_CUSTOMER_EDGE LABEL_CLOUD_CONNECT
op
string
default: EQ
Allowed values: EQ NEQ
value
Value

Value of the label.

string
>= 3 characters <= 1024 characters
start_time
start_time

Start time of metric collection from which data will be considered to fetch cloud connect data. 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

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
List Segment Metrics Response

Response for cloud connect API contains list of customer edges & cloud connects associated with the customer edge. Each cloud connect contains throughput data for a given cloud connect.

object
edges
Customer Edges

Cloud connect data for list of customer edges owned by a tenant.

Array<object>
Cloud Connect Edge Data

EdgeData wraps all the response data for a customer edge.

object
ce
object
name
Customer Edge

Name of the customer edge.

string
>= 6 characters <= 1024 characters
segments
Metric

Metric data for the segments.

Array<object>
Cloud Connect Segmentation Data

SegmentationData contains metric type and the corresponding value for a cloud connect.

object
data
Data

List of metric values. May contain more than one value if timeseries data is requested.

Array<object>
Metric Data

MetricData contains metric type and the corresponding value for a cloud connect.

object
type
string
default: METRIC_TYPE_NONE
Allowed values: METRIC_TYPE_NONE METRIC_TYPE_IN_BYTES METRIC_TYPE_OUT_BYTES METRIC_TYPE_TOTAL_BYTES
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
values
Value

List of metric values. May contain more than one value if timeseries data is requested.

Array<object>
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: TRAFFIC_TYPE_NONE
Allowed values: TRAFFIC_TYPE_NONE TRAFFIC_TYPE_INTER_SEGMENT TRAFFIC_TYPE_INTRA_SEGMENT TRAFFIC_TYPE_INTERNET
segment

Metric data for the given metric.

Array<object>
Cloud Connect Segmentation Data

SegmentationData contains metric type and the corresponding value for a cloud connect.

object
data
Data

List of metric values. May contain more than one value if timeseries data is requested.

Array<object>
Metric Data

MetricData contains metric type and the corresponding value for a cloud connect.

object
type
string
default: METRIC_TYPE_NONE
Allowed values: METRIC_TYPE_NONE METRIC_TYPE_IN_BYTES METRIC_TYPE_OUT_BYTES METRIC_TYPE_TOTAL_BYTES
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
values
Value

List of metric values. May contain more than one value if timeseries data is requested.

Array<object>
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: TRAFFIC_TYPE_NONE
Allowed values: TRAFFIC_TYPE_NONE TRAFFIC_TYPE_INTER_SEGMENT TRAFFIC_TYPE_INTRA_SEGMENT TRAFFIC_TYPE_INTERNET
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
{
  "edges": [
    {
      "segments": [
        {
          "data": [
            {
              "type": "METRIC_TYPE_NONE",
              "unit": "UNIT_MILLISECONDS",
              "values": [
                {
                  "trend_value": {
                    "sentiment": "TREND_SENTIMENT_NONE"
                  }
                }
              ]
            }
          ],
          "type": "TRAFFIC_TYPE_NONE"
        }
      ]
    }
  ],
  "segment": [
    {
      "data": [
        {
          "type": "METRIC_TYPE_NONE",
          "unit": "UNIT_MILLISECONDS",
          "values": [
            {
              "trend_value": {
                "sentiment": "TREND_SENTIMENT_NONE"
              }
            }
          ]
        }
      ],
      "type": "TRAFFIC_TYPE_NONE"
    }
  ]
}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

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

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example