Connectivity Node Query.
const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/example/graph/connectivity/node';const options = { method: 'POST', headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'}, body: '{"end_time":"example","field_selector":{"healthscore":{"types":["HEALTHSCORE_NONE"]},"metric":{"features":["TIMESERIES_FEATURE_NONE"],"instances":["NODE_INSTANCE_METRIC_TYPE_NONE"],"interfaces":["NODE_IF_METRIC_TYPE_NONE"],"types":["NODE_METRIC_TYPE_NONE"]}},"id":{"site":"example","site_type":"INVALID"},"label_filter":[{"label":"LABEL_NONE","op":"NOP","value":"example"}],"namespace":"example","range":"example","start_time":"example","step":"example","group_by":["NONE"]}'};
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/graph/connectivity/node \ --header 'Authorization: <Authorization>' \ --header 'Content-Type: application/json' \ --data '{ "end_time": "example", "field_selector": { "healthscore": { "types": [ "HEALTHSCORE_NONE" ] }, "metric": { "features": [ "TIMESERIES_FEATURE_NONE" ], "instances": [ "NODE_INSTANCE_METRIC_TYPE_NONE" ], "interfaces": [ "NODE_IF_METRIC_TYPE_NONE" ], "types": [ "NODE_METRIC_TYPE_NONE" ] } }, "id": { "site": "example", "site_type": "INVALID" }, "label_filter": [ { "label": "LABEL_NONE", "op": "NOP", "value": "example" } ], "namespace": "example", "range": "example", "start_time": "example", "step": "example", "group_by": [ "NONE" ] }'Request to GET Connectivity data for a site. This query is used to GET time-series data for a given site.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Namespace This request is supported only in system namespace.
Request Bodyrequired
Section titled “Request Bodyrequired”Request to GET time-series data for a node in the connectivity graph. While graph/connectivity API is used to GET connectivity data for all sites, where each node and edge contains the aggregated value for each field; graph/connectivity/node API is used to GET the time-series data (drill-down of aggregated data) for each field.
object
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
object
object
Healthscore types to be returned in the response.
object
Specify list of timeseries features that should be returned for each metric type in the request.
Specify list of metrics.
Specify list of metrics that should be returned for each physical interface in a site.
Specify list of metrics that should be returned for each node in the connectivity graph.
object
Name of the site.
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, connectivity data for all sites will be returned in the response.
Metrics used in the connectivity graph 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
Value of the label.
This request is supported only in system namespace.
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.
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
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>
Aggregate data by site.
Optional: If not specified, then the data is aggregated/grouped by site.
Responses
Section titled “Responses”A successful response.
Response for graph/connectivity/node API returns the time-series data for the site specified in the request.
object
object
object
List of healthscores specified in the request.
HealthScoreTypeData contains healthscore type and the corresponding value.
object
A human readable string explaining the reason in case of bad healthscore.
Healthscore value.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
object
Name of the site.
Instance data for the node requested by the user.
NodeInstanceData is part of the connectivity graph response that contains the instance name along with the corresponding metric.
object
Instance name.
Instance Metric Data.
NodeInstanceMetricData contains the metric type and the corresponding value for a node instance.
object
object
Number of anomalies for the given time range.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
Lower Bound of the metric value.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
Upper Bound of the metric value.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
Healscore of the metric calculated based on the number of anomalies and the value of the anomalies for the time range.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
List of metric values for a given metric type.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
Indicates the metric trend.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
Interface data for the node requested by the user.
NodeInterfaceData is part of the connectivity graph response that contains the interface name along with the corresponding metric.
object
Interface name.
Interface Metric Data.
NodeInterfaceMetricData contains the metric type and the corresponding value for a node interface.
object
object
Number of anomalies for the given time range.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
Lower Bound of the metric value.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
Upper Bound of the metric value.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
Healscore of the metric calculated based on the number of anomalies and the value of the anomalies for the time range.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
List of metric values for a given metric type.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
Indicates the metric trend.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
Network Type can be “INSIDE” (LAN traffic) or “OUTSIDE” (WAN traffic)
Segment name for network_type segment should be added in response.
Node Metric data specified in the request.
NodeMetricData contains metric type and the corresponding value for a node.
object
object
Number of anomalies for the given time range.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
Lower Bound of the metric value.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
Upper Bound of the metric value.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
Healscore of the metric calculated based on the number of anomalies and the value of the anomalies for the time range.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
List of metric values for a given metric type.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
Indicates the metric trend.
Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, … Tn=tn-1+step, where tn <= end_time. Response may not contain values for all timestamps between start_time and end_time.
object
UTC timestamp in seconds.
object
Description of the method used to calculate trend.
Configuration parameter for previous value
Configuration parameter for value
Metric value.
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.
Example
{ "data": { "healthscore": { "data": [ { "type": "HEALTHSCORE_NONE", "value": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ] } ] }, "id": { "site_type": "INVALID" }, "instances": [ { "metric": [ { "type": "NODE_INSTANCE_METRIC_TYPE_NONE", "unit": "UNIT_MILLISECONDS", "value": { "anomaly": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ], "confidence_lower_bound": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ], "confidence_upper_bound": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ], "healthscore": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ], "raw": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ], "trend": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ] } } ] } ], "interfaces": [ { "metric": [ { "type": "NODE_IF_METRIC_TYPE_NONE", "unit": "UNIT_MILLISECONDS", "value": { "anomaly": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ], "confidence_lower_bound": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ], "confidence_upper_bound": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ], "healthscore": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ], "raw": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ], "trend": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ] } } ] } ], "metric": [ { "type": "NODE_METRIC_TYPE_NONE", "unit": "UNIT_MILLISECONDS", "value": { "anomaly": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ], "confidence_lower_bound": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ], "confidence_upper_bound": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ], "healthscore": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ], "raw": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ], "trend": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ] } } ] }}Returned when operation is not authorized.
Examplegenerated
exampleReturned when there is no permission to access resource.
Examplegenerated
exampleReturned when resource is not found.
Examplegenerated
exampleReturned when operation on resource is conflicting with current value.
Examplegenerated
exampleReturned when operation has been rejected as it is happening too frequently.
Examplegenerated
exampleReturned when server encountered an error in processing API.
Examplegenerated
exampleReturned when service is unavailable temporarily.
Examplegenerated
exampleReturned when server timed out processing request.
Examplegenerated
example