ves-io-schema-endpoint-API-Get

Examples of getting endpoint

Usecase:

Get productpage-endpoint from current namespace

Request using vesctl:

vesctl configuration get endpoint productpage-endpoint --namespace documentation

vesctl yaml response:

metadata:
  annotations: {}
  labels: {}
  name: productpage-endpoint
  namespace: documentation
referringObjects: []
resourceVersion: "284"
spec:
  port: 9080
  protocol: TCP
  serviceInfo:
    discoveryType: K8S
    serviceName: productpage
  where:
    virtualSite:
      ref:
      - kind: virtual_site
        name: acmecorp-vsite
        namespace: documentation
        tenant: acmecorp
status: []
systemMetadata:
  creationTimestamp: "2021-08-25T09:02:59.001070189Z"
  creatorClass: examplesvc
  creatorId: examplesvc
  finalizers: []
  tenant: acmecorp
  uid: ea04e442-08dd-41a5-b510-fd8456a20c80

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/documentation/endpoints/productpage-endpoint?response_format=0'

curl response:

HTTP/1.1 200 OK
Content-Length: 1242
Content-Type: application/json
Date: Wed, 25 Aug 2021 09:02:59 GMT
Vary: Accept-Encoding

{
  "object": null,
  "create_form": null,
  "replace_form": null,
  "resource_version": "284",
  "metadata": {
    "name": "productpage-endpoint",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "ea04e442-08dd-41a5-b510-fd8456a20c80",
    "creation_timestamp": "2021-08-25T09:02:59.001070189Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null
  },
  "spec": {
    "where": {
      "virtual_site": {
        "ref": [
          {
            "kind": "virtual_site",
            "uid": "",
            "tenant": "acmecorp",
            "namespace": "documentation",
            "name": "acmecorp-vsite"
          }
        ],
        "network_type": "VIRTUAL_NETWORK_SITE_LOCAL"
      }
    },
    "protocol": "TCP",
    "port": 9080,
    "health_check_port": 0,
    "service_info": {
      "discovery_type": "K8S",
      "service_name": "productpage"
    }
  },
  "status": [
  ],
  "referring_objects": [
  ]
}