​
Select Service
ves-io-schema-graph-connectivity-CustomAPI-Query
Published April 5, 2023 | Last modified March 20, 2025
Examples of performing connectivity CustomAPI Query
Usecase:
Get graph connectivity data
Request:
Request using vesctl:
vesctl request rpc connectivity.CustomAPI.Query -i request.yaml --uri /public/namespaces/system/graph/connectivity --http-method POST
where file request.yaml has following contents:
endTime: "1580407200"
fieldSelector:
edge:
metric:
types:
- EDGE_DATA_PLANE_CONNECTION_STATUS
- EDGE_OUT_THROUGHPUT
node:
metric:
types:
- NODE_DATA_PLANE_CONNECTION_STATUS
- NODE_OUT_THROUGHPUT
namespace: system
startTime: "1580403600"
Copied!
vesctl yaml response:
edges:
- dstId:
site: site2
metric:
- type: EDGE_DATA_PLANE_CONNECTION_STATUS
value:
anomaly: []
confidenceLowerBound: []
confidenceUpperBound: []
healthscore: []
raw:
- timestamp: 1580407200
value: "1"
trend: []
- type: EDGE_OUT_THROUGHPUT
value:
anomaly: []
confidenceLowerBound: []
confidenceUpperBound: []
healthscore: []
raw:
- timestamp: 1580407200
value: "7.587077099800346"
trend: []
srcId:
site: site1
nodes:
- id:
site: site1
instances: []
interfaces: []
metric:
- type: NODE_DATA_PLANE_CONNECTION_STATUS
value:
anomaly: []
confidenceLowerBound: []
confidenceUpperBound: []
healthscore: []
raw:
- timestamp: 1580407200
value: "1"
trend: []
- type: NODE_OUT_THROUGHPUT
value:
anomaly: []
confidenceLowerBound: []
confidenceUpperBound: []
healthscore: []
raw:
- timestamp: 1580407200
value: "7.587077099800346"
trend: []
- id:
site: site2
instances: []
interfaces: []
metric:
- type: NODE_DATA_PLANE_CONNECTION_STATUS
value:
anomaly: []
confidenceLowerBound: []
confidenceUpperBound: []
healthscore: []
raw:
- timestamp: 1580407200
value: "1"
trend: []
- type: NODE_OUT_THROUGHPUT
value:
anomaly: []
confidenceLowerBound: []
confidenceUpperBound: []
healthscore: []
raw:
- timestamp: 1580407200
value: "7.587077099800346"
trend: []
Copied!
Request using curl:
curl -X 'POST' -d '{"namespace":"system","field_selector":{"node":{"metric":{"types":["NODE_DATA_PLANE_CONNECTION_STATUS","NODE_OUT_THROUGHPUT"]}},"edge":{"metric":{"types":["EDGE_DATA_PLANE_CONNECTION_STATUS","EDGE_OUT_THROUGHPUT"]}}},"start_time":"1580403600","end_time":"1580407200"}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build436303540_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/data/namespaces/system/graph/connectivity'
Copied!
curl response:
HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 11 Mar 2025 00:55:55 GMT
Vary: Accept-Encoding
X-Volterra-Request-Fields-Deprecated: field_selector.edge.metric.types.#:7,field_selector.edge.metric.types.#:8,field_selector.edge.metric.types.#:EDGE_ARES_CONNECTION_STATUS,field_selector.edge.metric.types.#:EDGE_CONNECTION_STATUS,field_selector.node.metric.types.#:8,field_selector.node.metric.types.#:9,field_selector.node.metric.types.#:NODE_ARES_CONNECTION_STATUS,field_selector.node.metric.types.#:NODE_CONNECTION_STATUS
X-Volterra-Response-Fields-Deprecated: edges.#.metric.#.type:7,edges.#.metric.#.type:8,edges.#.metric.#.type:EDGE_ARES_CONNECTION_STATUS,edges.#.metric.#.type:EDGE_CONNECTION_STATUS,nodes.#.metric.#.type:8,nodes.#.metric.#.type:9,nodes.#.metric.#.type:NODE_ARES_CONNECTION_STATUS,nodes.#.metric.#.type:NODE_CONNECTION_STATUS
{
"nodes": [
{
"id": {
"site": "site1",
"site_type": "INVALID"
},
"metric": [
{
"type": "NODE_DATA_PLANE_CONNECTION_STATUS",
"value": {
"raw": [
{
"timestamp": 1580407200,
"value": "1",
"trend_value": null
}
],
"confidence_upper_bound": [
],
"confidence_lower_bound": [
],
"anomaly": [
],
"trend": [
],
"healthscore": [
]
},
"unit": "UNIT_MILLISECONDS"
},
{
"type": "NODE_OUT_THROUGHPUT",
"value": {
"raw": [
{
"timestamp": 1580407200,
"value": "7.587077099800346",
"trend_value": null
}
],
"confidence_upper_bound": [
],
"confidence_lower_bound": [
],
"anomaly": [
],
"trend": [
],
"healthscore": [
]
},
"unit": "UNIT_MILLISECONDS"
}
],
"interfaces": [
],
"instances": [
],
"healthscore": null
},
{
"id": {
"site": "site2",
"site_type": "INVALID"
},
"metric": [
{
"type": "NODE_DATA_PLANE_CONNECTION_STATUS",
"value": {
"raw": [
{
"timestamp": 1580407200,
"value": "1",
"trend_value": null
}
],
"confidence_upper_bound": [
],
"confidence_lower_bound": [
],
"anomaly": [
],
"trend": [
],
"healthscore": [
]
},
"unit": "UNIT_MILLISECONDS"
},
{
"type": "NODE_OUT_THROUGHPUT",
"value": {
"raw": [
{
"timestamp": 1580407200,
"value": "7.587077099800346",
"trend_value": null
}
],
"confidence_upper_bound": [
],
"confidence_lower_bound": [
],
"anomaly": [
],
"trend": [
],
"healthscore": [
]
},
"unit": "UNIT_MILLISECONDS"
}
],
"interfaces": [
],
"instances": [
],
"healthscore": null
}
],
"edges": [
{
"src_id": {
"site": "site1",
"site_type": "INVALID"
},
"dst_id": {
"site": "site2",
"site_type": "INVALID"
},
"metric": [
{
"type": "EDGE_DATA_PLANE_CONNECTION_STATUS",
"value": {
"raw": [
{
"timestamp": 1580407200,
"value": "1",
"trend_value": null
}
],
"confidence_upper_bound": [
],
"confidence_lower_bound": [
],
"anomaly": [
],
"trend": [
],
"healthscore": [
]
},
"unit": "UNIT_MILLISECONDS"
},
{
"type": "EDGE_OUT_THROUGHPUT",
"value": {
"raw": [
{
"timestamp": 1580407200,
"value": "7.587077099800346",
"trend_value": null
}
],
"confidence_upper_bound": [
],
"confidence_lower_bound": [
],
"anomaly": [
],
"trend": [
],
"healthscore": [
]
},
"unit": "UNIT_MILLISECONDS"
}
],
"healthscore": null
}
]
}
Copied!