ves-io-schema-site-API-Get

Examples of getting site

Usecase:

Get site-1

Request using vesctl:

vesctl configuration get site site-1 --namespace system

vesctl yaml response:

metadata:
  annotations: {}
  labels: {}
  name: site-1
  namespace: system
referringObjects: []
resourceVersion: "854"
spec:
  connectedRe: []
  connectedReForConfig: []
  siteType: REGIONAL_EDGE
  vipParamsPerAz: []
status: []
systemMetadata:
  creationTimestamp: "2021-08-25T09:04:01.742847771Z"
  creatorClass: examplesvc
  creatorId: examplesvc
  finalizers: []
  tenant: acmecorp
  uid: afe4937b-255b-4a16-80b8-6d21a236e6b2

Request using curl:

curl -X 'GET' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build970361017_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/sites/site-1?response_format=0'

curl response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Wed, 25 Aug 2021 09:04:01 GMT
Vary: Accept-Encoding

{
  "object": null,
  "replace_form": null,
  "resource_version": "854",
  "metadata": {
    "name": "site-1",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "afe4937b-255b-4a16-80b8-6d21a236e6b2",
    "creation_timestamp": "2021-08-25T09:04:01.742847771Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null
  },
  "spec": {
    "site_type": "REGIONAL_EDGE",
    "address": "",
    "coordinates": null,
    "volterra_software_version": "",
    "site_subtype": "NO_SUBTYPE",
    "connected_re": [
    ],
    "connected_re_for_config": [
    ],
    "inside_vip": "",
    "outside_vip": "",
    "vip_params_per_az": [
    ],
    "vip_vrrp_mode": "VIP_VRRP_INVALID",
    "site_to_site_network_type": "VIRTUAL_NETWORK_SITE_LOCAL",
    "site_to_site_tunnel_ip": "",
    "volterra_software_overide": "SITE_SOFTWARE_OVERRIDE_SITE",
    "bgp_router_id": "",
    "bgp_peer_address": "",
    "inside_nameserver": "",
    "outside_nameserver": "",
    "desired_pool_count": 0,
    "tunnel_type": "SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL",
    "operating_system_version": "",
    "site_state": "ONLINE",
    "tunnel_dead_timeout": 0,
    "region": "",
    "ce_site_mode": "CE_SITE_MODE_INGRESS_EGRESS_GW",
    "local_k8s_access_enabled": false,
    "default_underlay_network": null,
    "local_access_k8s_enabled": false,
    "global_access_k8s_enabled": false
  },
  "status": [
  ],
  "referring_objects": [
  ]
}