​

ves-io-schema-virtual_network-CustomDataAPI-SIDCounters

Published April 5, 2023 | Last modified March 20, 2025

Examples of performing virtual_network CustomDataAPI SIDCounters

Usecase:

Get SID Counters

Request:

Request using vesctl:

vesctl request rpc virtual_network.CustomDataAPI.SIDCounters -i request.yaml --uri /public/namespaces/system/virtual_network/sid_counters --http-method POST

where file request.yaml has following contents:

endTime: "1593622800"
fieldSelector:
- SID_COUNTER_IN_PACKETS
- SID_COUNTER_OUT_PACKETS
filter: '{SITE="site-1"}'
groupBy:
- VIRTUAL_NETWORK
- SID_PREFIX
namespace: system
startTime: "1593619200"
Copied!

vesctl yaml response:

data:
- data:
  - key:
      SID_PREFIX: 2001:f00f:18a:6001:b::/128
      VIRTUAL_NETWORK: virtual-network-1
    value:
    - timestamp: 1593622800
      value: "1024"
  - key:
      SID_PREFIX: 2004:f00f:18a:3001:e::/80
      VIRTUAL_NETWORK: virtual-network-2
    value:
    - timestamp: 1593622800
      value: "1024"
  type: SID_COUNTER_IN_PACKETS
- data:
  - key:
      SID_PREFIX: 2001:f00f:18a:6001:b::/128
      VIRTUAL_NETWORK: virtual-network-1
    value:
    - timestamp: 1593622800
      value: "10"
  - key:
      SID_PREFIX: 2004:f00f:18a:3001:e::/80
      VIRTUAL_NETWORK: virtual-network-2
    value:
    - timestamp: 1593622800
      value: "100"
  type: SID_COUNTER_OUT_PACKETS
Copied!

Request using curl:

curl -X 'POST' -d '{"namespace":"system","filter":"{SITE=\"site-1\"}","group_by":["VIRTUAL_NETWORK","SID_PREFIX"],"field_selector":["SID_COUNTER_IN_PACKETS","SID_COUNTER_OUT_PACKETS"],"start_time":"1593619200","end_time":"1593622800"}' -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/virtual_network/sid_counters'
Copied!

curl response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 11 Mar 2025 00:57:53 GMT
Vary: Accept-Encoding

{
  "data": [
    {
      "type": "SID_COUNTER_IN_PACKETS",
      "data": [
        {
          "key": {
            "SID_PREFIX": "2001:f00f:18a:6001:b::/128",
            "VIRTUAL_NETWORK": "virtual-network-1"
          },
          "value": [
            {
              "timestamp": 1593622800,
              "value": "1024",
              "trend_value": null
            }
          ]
        },
        {
          "key": {
            "SID_PREFIX": "2004:f00f:18a:3001:e::/80",
            "VIRTUAL_NETWORK": "virtual-network-2"
          },
          "value": [
            {
              "timestamp": 1593622800,
              "value": "1024",
              "trend_value": null
            }
          ]
        }
      ],
      "unit": "UNIT_MILLISECONDS"
    },
    {
      "type": "SID_COUNTER_OUT_PACKETS",
      "data": [
        {
          "key": {
            "SID_PREFIX": "2001:f00f:18a:6001:b::/128",
            "VIRTUAL_NETWORK": "virtual-network-1"
          },
          "value": [
            {
              "timestamp": 1593622800,
              "value": "10",
              "trend_value": null
            }
          ]
        },
        {
          "key": {
            "SID_PREFIX": "2004:f00f:18a:3001:e::/80",
            "VIRTUAL_NETWORK": "virtual-network-2"
          },
          "value": [
            {
              "timestamp": 1593622800,
              "value": "100",
              "trend_value": null
            }
          ]
        }
      ],
      "unit": "UNIT_MILLISECONDS"
    }
  ],
  "step": ""
}
Copied!
On this page: