​
Select Service
ves-io-schema-topology-CustomDataAPI-SiteMeshTopology
Published April 5, 2023 | Last modified October 28, 2026
Examples of performing topology CustomDataAPI SiteMeshTopology
Usecase:
Get site mesh topology for smg-1
Request:
Request using vesctl:
vesctl request rpc topology.CustomDataAPI.SiteMeshTopology -i request.yaml --uri /public/namespaces/system/topology/site_mesh_group/smg-1 --http-method POST
where file request.yaml has following contents:
metricSelector: edge: - METRIC_TYPE_OUT_BYTES endTime: "1580407200" node: - METRIC_TYPE_IN_BYTES startTime: "1580403600"vesctl yaml response:
edges:- links: - info: type: LINK_TYPE_SITE_MESH_GROUP metric: [] nodeId1: site:site-1 nodeId2: smg:smg-1- links: - info: type: LINK_TYPE_SITE_MESH_GROUP metric: [] nodeId1: site:site-2 nodeId2: smg:smg-1- links: - info: status: LINK_STATUS_UP metric: - data: - labels: {} values: - value: "128" type: METRIC_TYPE_OUT_BYTES unit: UNIT_BYTES nodeId1: site:site-1 nodeId2: site:site-2- links: - info: status: LINK_STATUS_UP metric: - data: - labels: {} values: - value: "128" type: METRIC_TYPE_OUT_BYTES unit: UNIT_BYTES nodeId1: site:site-2 nodeId2: site:site-1- links: - info: type: LINK_TYPE_SITE_MESH_GROUP metric: [] nodeId1: site:site-3 nodeId2: smg:smg-2- links: - info: type: LINK_TYPE_SITE_MESH_GROUP metric: [] nodeId1: site:site-4 nodeId2: smg:smg-2- links: - info: status: LINK_STATUS_UP metric: - data: - labels: {} values: - value: "128" type: METRIC_TYPE_OUT_BYTES unit: UNIT_BYTES nodeId1: site:site-3 nodeId2: site:site-1- links: - info: status: LINK_STATUS_UP metric: - data: - labels: {} values: - value: "128" type: METRIC_TYPE_OUT_BYTES unit: UNIT_BYTES nodeId1: site:site-1 nodeId2: site:site-3- links: - info: status: LINK_STATUS_UP metric: - data: - labels: {} values: - value: "128" type: METRIC_TYPE_OUT_BYTES unit: UNIT_BYTES nodeId1: site:site-3 nodeId2: site:site-2- links: - info: status: LINK_STATUS_UP metric: - data: - labels: {} values: - value: "128" type: METRIC_TYPE_OUT_BYTES unit: UNIT_BYTES nodeId1: site:site-2 nodeId2: site:site-3- links: - info: status: LINK_STATUS_UP metric: - data: - labels: {} values: - value: "128" type: METRIC_TYPE_OUT_BYTES unit: UNIT_BYTES nodeId1: site:site-4 nodeId2: site:site-1- links: - info: status: LINK_STATUS_UP metric: - data: - labels: {} values: - value: "128" type: METRIC_TYPE_OUT_BYTES unit: UNIT_BYTES nodeId1: site:site-1 nodeId2: site:site-4- links: - info: status: LINK_STATUS_UP metric: - data: - labels: {} values: - value: "128" type: METRIC_TYPE_OUT_BYTES unit: UNIT_BYTES nodeId1: site:site-4 nodeId2: site:site-2- links: - info: status: LINK_STATUS_UP metric: - data: - labels: {} values: - value: "128" type: METRIC_TYPE_OUT_BYTES unit: UNIT_BYTES nodeId1: site:site-2 nodeId2: site:site-4nodes:- id: site:site-1 metadata: name: site-1 tags: {} site: info: dcClusterGroup: [] network: [] tgw: [] metric: - data: - labels: {} values: - value: "128" unit: UNIT_BYTES- id: site:site-2 metadata: name: site-2 tags: {} site: info: dcClusterGroup: [] network: [] tgw: [] metric: - data: - labels: {} values: - value: "1024" unit: UNIT_BYTES- id: site:site-3 metadata: name: site-3 tags: {} site: info: dcClusterGroup: [] network: [] tgw: [] metric: - data: - labels: {} values: - value: "512" unit: UNIT_BYTES- id: site:site-4 metadata: name: site-4 tags: {} site: info: dcClusterGroup: [] network: [] tgw: [] metric: - data: - labels: {} values: - value: "128" unit: UNIT_BYTES- id: smg:smg-1 metadata: name: smg-1 tags: {} siteMeshGroup: info: hub: [] topologySite: [] type: SITE_MESH_GROUP_TYPE_HUB_FULL_MESH virtualSite: []- id: smg:smg-2 metadata: name: smg-2 tags: {} siteMeshGroup: info: hub: [] topologySite: [] type: SITE_MESH_GROUP_TYPE_SPOKE virtualSite: []Request using curl:
curl -X 'POST' -d '{"metric_selector":{"start_time":"1580403600","end_time":"1580407200","node":["METRIC_TYPE_IN_BYTES"],"edge":["METRIC_TYPE_OUT_BYTES"]}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build3348201650_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/data/namespaces/system/topology/site_mesh_group/smg-1'curl response:
HTTP/1.1 200 OKContent-Type: application/jsonDate: Mon, 28 Sep 2026 04:30:29 GMTVary: Accept-Encoding
{ "nodes": [ { "id": "site:site-1", "metadata": { "name": "site-1", "cloud_resource_id": "", "description": "", "level": 0, "provider_type": "PROVIDER_TYPE_UNSPECIFIED", "owner_id": "", "tags": { }, "status": "" }, "site": { "info": { "network": [ ], "tgw": [ ], "dc_cluster_group": [ ], "site_type": "INVALID", "provider_info": null, "gateway_type": "INGRESS_GATEWAY", "app_type": "SITE_APPTYPE_NONE", "orchestration_mode": "NOT_MANAGED" }, "metric": [ { "type": "METRIC_TYPE_IN_BYTES", "unit": "UNIT_BYTES", "data": [ { "labels": { }, "values": [ { "timestamp": 0, "value": "128", "trend_value": null } ] } ] } ], "summary": null } }, { "id": "site:site-2", "metadata": { "name": "site-2", "cloud_resource_id": "", "description": "", "level": 0, "provider_type": "PROVIDER_TYPE_UNSPECIFIED", "owner_id": "", "tags": { }, "status": "" }, "site": { "info": { "network": [ ], "tgw": [ ], "dc_cluster_group": [ ], "site_type": "INVALID", "provider_info": null, "gateway_type": "INGRESS_GATEWAY", "app_type": "SITE_APPTYPE_NONE", "orchestration_mode": "NOT_MANAGED" }, "metric": [ { "type": "METRIC_TYPE_IN_BYTES", "unit": "UNIT_BYTES", "data": [ { "labels": { }, "values": [ { "timestamp": 0, "value": "1024", "trend_value": null } ] } ] } ], "summary": null } }, { "id": "site:site-3", "metadata": { "name": "site-3", "cloud_resource_id": "", "description": "", "level": 0, "provider_type": "PROVIDER_TYPE_UNSPECIFIED", "owner_id": "", "tags": { }, "status": "" }, "site": { "info": { "network": [ ], "tgw": [ ], "dc_cluster_group": [ ], "site_type": "INVALID", "provider_info": null, "gateway_type": "INGRESS_GATEWAY", "app_type": "SITE_APPTYPE_NONE", "orchestration_mode": "NOT_MANAGED" }, "metric": [ { "type": "METRIC_TYPE_IN_BYTES", "unit": "UNIT_BYTES", "data": [ { "labels": { }, "values": [ { "timestamp": 0, "value": "512", "trend_value": null } ] } ] } ], "summary": null } }, { "id": "site:site-4", "metadata": { "name": "site-4", "cloud_resource_id": "", "description": "", "level": 0, "provider_type": "PROVIDER_TYPE_UNSPECIFIED", "owner_id": "", "tags": { }, "status": "" }, "site": { "info": { "network": [ ], "tgw": [ ], "dc_cluster_group": [ ], "site_type": "INVALID", "provider_info": null, "gateway_type": "INGRESS_GATEWAY", "app_type": "SITE_APPTYPE_NONE", "orchestration_mode": "NOT_MANAGED" }, "metric": [ { "type": "METRIC_TYPE_IN_BYTES", "unit": "UNIT_BYTES", "data": [ { "labels": { }, "values": [ { "timestamp": 0, "value": "128", "trend_value": null } ] } ] } ], "summary": null } }, { "id": "smg:smg-1", "metadata": { "name": "smg-1", "cloud_resource_id": "", "description": "", "level": 0, "provider_type": "PROVIDER_TYPE_UNSPECIFIED", "owner_id": "", "tags": { }, "status": "" }, "site_mesh_group": { "info": { "type": "SITE_MESH_GROUP_TYPE_HUB_FULL_MESH", "site_type": "INVALID", "virtual_site": [ ], "hub": [ ], "topology_site": [ ] }, "summary": null } }, { "id": "smg:smg-2", "metadata": { "name": "smg-2", "cloud_resource_id": "", "description": "", "level": 0, "provider_type": "PROVIDER_TYPE_UNSPECIFIED", "owner_id": "", "tags": { }, "status": "" }, "site_mesh_group": { "info": { "type": "SITE_MESH_GROUP_TYPE_SPOKE", "site_type": "INVALID", "virtual_site": [ ], "hub": [ ], "topology_site": [ ] }, "summary": null } } ], "edges": [ { "node_id1": "site:site-1", "node_id2": "smg:smg-1", "links": [ { "info": { "name": "", "type": "LINK_TYPE_SITE_MESH_GROUP", "status": "LINK_STATUS_NOT_APPLICABLE", "src_id": "", "dst_id": "" }, "metric": [ ] } ], "status": "LINK_STATUS_NOT_APPLICABLE" }, { "node_id1": "site:site-2", "node_id2": "smg:smg-1", "links": [ { "info": { "name": "", "type": "LINK_TYPE_SITE_MESH_GROUP", "status": "LINK_STATUS_NOT_APPLICABLE", "src_id": "", "dst_id": "" }, "metric": [ ] } ], "status": "LINK_STATUS_NOT_APPLICABLE" }, { "node_id1": "site:site-1", "node_id2": "site:site-2", "links": [ { "info": { "name": "", "type": "LINK_TYPE_TUNNEL", "status": "LINK_STATUS_UP", "src_id": "", "dst_id": "" }, "metric": [ { "type": "METRIC_TYPE_OUT_BYTES", "unit": "UNIT_BYTES", "data": [ { "labels": { }, "values": [ { "timestamp": 0, "value": "128", "trend_value": null } ] } ] } ] } ], "status": "LINK_STATUS_NOT_APPLICABLE" }, { "node_id1": "site:site-2", "node_id2": "site:site-1", "links": [ { "info": { "name": "", "type": "LINK_TYPE_TUNNEL", "status": "LINK_STATUS_UP", "src_id": "", "dst_id": "" }, "metric": [ { "type": "METRIC_TYPE_OUT_BYTES", "unit": "UNIT_BYTES", "data": [ { "labels": { }, "values": [ { "timestamp": 0, "value": "128", "trend_value": null } ] } ] } ] } ], "status": "LINK_STATUS_NOT_APPLICABLE" }, { "node_id1": "site:site-3", "node_id2": "smg:smg-2", "links": [ { "info": { "name": "", "type": "LINK_TYPE_SITE_MESH_GROUP", "status": "LINK_STATUS_NOT_APPLICABLE", "src_id": "", "dst_id": "" }, "metric": [ ] } ], "status": "LINK_STATUS_NOT_APPLICABLE" }, { "node_id1": "site:site-4", "node_id2": "smg:smg-2", "links": [ { "info": { "name": "", "type": "LINK_TYPE_SITE_MESH_GROUP", "status": "LINK_STATUS_NOT_APPLICABLE", "src_id": "", "dst_id": "" }, "metric": [ ] } ], "status": "LINK_STATUS_NOT_APPLICABLE" }, { "node_id1": "site:site-3", "node_id2": "site:site-1", "links": [ { "info": { "name": "", "type": "LINK_TYPE_TUNNEL", "status": "LINK_STATUS_UP", "src_id": "", "dst_id": "" }, "metric": [ { "type": "METRIC_TYPE_OUT_BYTES", "unit": "UNIT_BYTES", "data": [ { "labels": { }, "values": [ { "timestamp": 0, "value": "128", "trend_value": null } ] } ] } ] } ], "status": "LINK_STATUS_NOT_APPLICABLE" }, { "node_id1": "site:site-1", "node_id2": "site:site-3", "links": [ { "info": { "name": "", "type": "LINK_TYPE_TUNNEL", "status": "LINK_STATUS_UP", "src_id": "", "dst_id": "" }, "metric": [ { "type": "METRIC_TYPE_OUT_BYTES", "unit": "UNIT_BYTES", "data": [ { "labels": { }, "values": [ { "timestamp": 0, "value": "128", "trend_value": null } ] } ] } ] } ], "status": "LINK_STATUS_NOT_APPLICABLE" }, { "node_id1": "site:site-3", "node_id2": "site:site-2", "links": [ { "info": { "name": "", "type": "LINK_TYPE_TUNNEL", "status": "LINK_STATUS_UP", "src_id": "", "dst_id": "" }, "metric": [ { "type": "METRIC_TYPE_OUT_BYTES", "unit": "UNIT_BYTES", "data": [ { "labels": { }, "values": [ { "timestamp": 0, "value": "128", "trend_value": null } ] } ] } ] } ], "status": "LINK_STATUS_NOT_APPLICABLE" }, { "node_id1": "site:site-2", "node_id2": "site:site-3", "links": [ { "info": { "name": "", "type": "LINK_TYPE_TUNNEL", "status": "LINK_STATUS_UP", "src_id": "", "dst_id": "" }, "metric": [ { "type": "METRIC_TYPE_OUT_BYTES", "unit": "UNIT_BYTES", "data": [ { "labels": { }, "values": [ { "timestamp": 0, "value": "128", "trend_value": null } ] } ] } ] } ], "status": "LINK_STATUS_NOT_APPLICABLE" }, { "node_id1": "site:site-4", "node_id2": "site:site-1", "links": [ { "info": { "name": "", "type": "LINK_TYPE_TUNNEL", "status": "LINK_STATUS_UP", "src_id": "", "dst_id": "" }, "metric": [ { "type": "METRIC_TYPE_OUT_BYTES", "unit": "UNIT_BYTES", "data": [ { "labels": { }, "values": [ { "timestamp": 0, "value": "128", "trend_value": null } ] } ] } ] } ], "status": "LINK_STATUS_NOT_APPLICABLE" }, { "node_id1": "site:site-1", "node_id2": "site:site-4", "links": [ { "info": { "name": "", "type": "LINK_TYPE_TUNNEL", "status": "LINK_STATUS_UP", "src_id": "", "dst_id": "" }, "metric": [ { "type": "METRIC_TYPE_OUT_BYTES", "unit": "UNIT_BYTES", "data": [ { "labels": { }, "values": [ { "timestamp": 0, "value": "128", "trend_value": null } ] } ] } ] } ], "status": "LINK_STATUS_NOT_APPLICABLE" }, { "node_id1": "site:site-4", "node_id2": "site:site-2", "links": [ { "info": { "name": "", "type": "LINK_TYPE_TUNNEL", "status": "LINK_STATUS_UP", "src_id": "", "dst_id": "" }, "metric": [ { "type": "METRIC_TYPE_OUT_BYTES", "unit": "UNIT_BYTES", "data": [ { "labels": { }, "values": [ { "timestamp": 0, "value": "128", "trend_value": null } ] } ] } ] } ], "status": "LINK_STATUS_NOT_APPLICABLE" }, { "node_id1": "site:site-2", "node_id2": "site:site-4", "links": [ { "info": { "name": "", "type": "LINK_TYPE_TUNNEL", "status": "LINK_STATUS_UP", "src_id": "", "dst_id": "" }, "metric": [ { "type": "METRIC_TYPE_OUT_BYTES", "unit": "UNIT_BYTES", "data": [ { "labels": { }, "values": [ { "timestamp": 0, "value": "128", "trend_value": null } ] } ] } ] } ], "status": "LINK_STATUS_NOT_APPLICABLE" } ], "step": ""}