ves-io-schema-site-API-Get

Examples of getting site

Usecase:

Get site-1

Request using vesctl:

vesctl configuration get site site-1 --namespace documentation

vesctl yaml response:

object:
  metadata:
    annotations: {}
    labels: {}
    name: site-1
    namespace: documentation
    uid: 3b8e2850-4280-4817-ba7d-e3f74951e07c
  spec:
    gcSpec:
      aresList: []
      aresVtrpList: []
      connectedRe: []
      connectedReForConfig: []
      k8sApiServers: {}
      marsList: []
      marsVtrpList: []
      siteType: REGIONAL_EDGE
      staticRoutes: []
      templateParameters: {}
  systemMetadata:
    creationTimestamp: "2020-07-02T15:53:33.443994200Z"
    creatorClass: examplesvc.ves.io
    finalizers: []
    namespace:
    - kind: namespace
      name: documentation
      tenant: acmecorp
    tenant: acmecorp
    traceInfo: 111dddef8f70b698:111dddef8f70b698:0:1
    uid: 3b8e2850-4280-4817-ba7d-e3f74951e07c
resourceVersion: "576"
status: []

Request using curl:

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

curl response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Thu, 02 Jul 2020 15:53:33 GMT
Vary: Accept-Encoding

{
  "object": {
    "metadata": {
      "name": "site-1",
      "namespace": "documentation",
      "uid": "3b8e2850-4280-4817-ba7d-e3f74951e07c",
      "labels": {
      },
      "annotations": {
      },
      "description": "",
      "disable": false
    },
    "system_metadata": {
      "uid": "3b8e2850-4280-4817-ba7d-e3f74951e07c",
      "creation_timestamp": "2020-07-02T15:53:33.443994200Z",
      "deletion_timestamp": null,
      "modification_timestamp": null,
      "initializers": null,
      "finalizers": [
      ],
      "tenant": "acmecorp",
      "creator_class": "examplesvc.ves.io",
      "creator_id": "",
      "creator_cookie": "",
      "trace_info": "111dddef8f70b698:111dddef8f70b698:0:1",
      "object_index": 0,
      "namespace": [
        {
          "kind": "namespace",
          "uid": "",
          "tenant": "acmecorp",
          "namespace": "",
          "name": "documentation"
        }
      ],
      "owner_view": null
    },
    "spec": {
      "gc_spec": {
        "site_type": "REGIONAL_EDGE",
        "address": "",
        "coordinates": null,
        "connected_re": [
        ],
        "connected_re_for_config": [
        ],
        "vega": null,
        "ares_list": [
        ],
        "rakar": null,
        "opera": null,
        "static_routes": [
        ],
        "k8s_api_servers": {
        },
        "public_ip": "",
        "cluster_ip": "",
        "ares_vtrp_list": [
        ],
        "volterra_software_version": "",
        "inside_vip": "",
        "outside_vip": "",
        "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": "",
        "template_parameters": {
        },
        "inside_nameserver": "",
        "outside_nameserver": "",
        "desired_pool_count": 0,
        "tunnel_type": "SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL",
        "site_state": "ONLINE",
        "operating_system_version": "",
        "mars_list": [
        ],
        "mars_vtrp_list": [
        ],
        "tunnel_dead_timeout": 0,
        "region": ""
      }
    }
  },
  "create_form": null,
  "replace_form": null,
  "resource_version": "576",
  "metadata": null,
  "system_metadata": null,
  "spec": null,
  "status": [
  ]
}