​

ves-io-schema-topology-CustomDataAPI-SiteMeshGroupsSummary

Published April 5, 2023 | Last modified October 28, 2026

Examples of performing topology CustomDataAPI SiteMeshGroupsSummary

Usecase:

Get site mesh groups summary

Request:

Request using vesctl:

vesctl request rpc topology.CustomDataAPI.SiteMeshGroupsSummary -i request.yaml --uri /public/namespaces/system/topology/site_mesh_groups --http-method GET

where file request.yaml has following contents:

{}

vesctl yaml response:

edges: []
nodes:
- id: smg:smg-1
  metadata:
    name: smg-1
    tags: {}
  siteMeshGroup:
    info:
      hub: []
      topologySite: []
      type: SITE_MESH_GROUP_TYPE_HUB_FULL_MESH
      virtualSite: []
    summary:
      edgeStatusSummary: []
      linkStatusSummary:
      - count: 10
        status: LINK_STATUS_UP
      otherConnectedSiteMeshGroupSites: 2
      sites: 2
- id: smg:smg-2
  metadata:
    name: smg-2
    tags: {}
  siteMeshGroup:
    info:
      hub: []
      topologySite: []
      type: SITE_MESH_GROUP_TYPE_SPOKE
      virtualSite: []
    summary:
      edgeStatusSummary: []
      linkStatusSummary:
      - count: 10
        status: LINK_STATUS_UP
      otherConnectedSiteMeshGroupSites: 2
      sites: 2

Request using curl:

curl -X 'GET' -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_groups'

curl response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 28 Sep 2026 04:30:29 GMT
Vary: Accept-Encoding


{
  "nodes": [
    {
      "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": {
          "sites": 2,
          "other_connected_site_mesh_group_sites": 2,
          "link_status_summary": [
            {
              "type": "LINK_TYPE_TUNNEL",
              "status": "LINK_STATUS_UP",
              "count": 10
            }
          ],
          "edge_status_summary": [
          ]
        }
      }
    },
    {
      "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": {
          "sites": 2,
          "other_connected_site_mesh_group_sites": 2,
          "link_status_summary": [
            {
              "type": "LINK_TYPE_TUNNEL",
              "status": "LINK_STATUS_UP",
              "count": 10
            }
          ],
          "edge_status_summary": [
          ]
        }
      }
    }
  ],
  "edges": [
  ],
  "step": ""
}
On this page: