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
object:
  metadata:
    annotations: {}
    labels: {}
    name: productpage-endpoint
    namespace: documentation
    uid: 07e994d0-e019-4b7a-b431-9fb131b42552
  spec:
    gcSpec:
      port: 9080
      serviceInfo:
        discoveryType: K8S
        serviceName: productpage
      where:
        virtualSite:
          ref:
          - kind: virtual_site
            name: acmecorp-vsite
            namespace: documentation
            tenant: acmecorp
  systemMetadata:
    creationTimestamp: "2020-09-16T10:50:10.797906100Z"
    creatorClass: examplesvc
    creatorId: examplesvc
    finalizers: []
    namespace:
    - kind: namespace
      name: documentation
      tenant: acmecorp
    tenant: acmecorp
    traceInfo: 2d9faa11099a2340:2d9faa11099a2340:0:1
    uid: 07e994d0-e019-4b7a-b431-9fb131b42552
resourceVersion: "180"
spec:
  port: 9080
  serviceInfo:
    discoveryType: K8S
    serviceName: productpage
  where:
    virtualSite:
      ref:
      - kind: virtual_site
        name: acmecorp-vsite
        namespace: documentation
        tenant: acmecorp
status: []
systemMetadata:
  creationTimestamp: "2020-09-16T10:50:10.797906100Z"
  creatorClass: examplesvc
  creatorId: examplesvc
  finalizers: []
  tenant: acmecorp
  uid: 07e994d0-e019-4b7a-b431-9fb131b42552

Request using curl:

curl -X 'GET' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build013258245_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-Type: application/json
Date: Wed, 16 Sep 2020 10:50:10 GMT
Vary: Accept-Encoding

{
  "object": {
    "metadata": {
      "name": "productpage-endpoint",
      "namespace": "documentation",
      "uid": "07e994d0-e019-4b7a-b431-9fb131b42552",
      "labels": {
      },
      "annotations": {
      },
      "description": "",
      "disable": false
    },
    "system_metadata": {
      "uid": "07e994d0-e019-4b7a-b431-9fb131b42552",
      "creation_timestamp": "2020-09-16T10:50:10.797906100Z",
      "deletion_timestamp": null,
      "modification_timestamp": null,
      "initializers": null,
      "finalizers": [
      ],
      "tenant": "acmecorp",
      "creator_class": "examplesvc",
      "creator_id": "examplesvc",
      "creator_cookie": "",
      "trace_info": "2d9faa11099a2340:2d9faa11099a2340:0:1",
      "object_index": 0,
      "namespace": [
        {
          "kind": "namespace",
          "uid": "",
          "tenant": "acmecorp",
          "namespace": "",
          "name": "documentation"
        }
      ],
      "owner_view": null
    },
    "spec": {
      "gc_spec": {
        "where": {
          "virtual_site": {
            "ref": [
              {
                "kind": "virtual_site",
                "uid": "",
                "tenant": "acmecorp",
                "namespace": "documentation",
                "name": "acmecorp-vsite"
              }
            ],
            "network_type": "VIRTUAL_NETWORK_SITE_LOCAL"
          }
        },
        "protocol": "",
        "port": 9080,
        "service_info": {
          "discovery_type": "K8S",
          "service_name": "productpage"
        }
      }
    }
  },
  "create_form": null,
  "replace_form": null,
  "resource_version": "180",
  "metadata": {
    "name": "productpage-endpoint",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "07e994d0-e019-4b7a-b431-9fb131b42552",
    "creation_timestamp": "2020-09-16T10:50:10.797906100Z",
    "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": "",
    "port": 9080,
    "service_info": {
      "discovery_type": "K8S",
      "service_name": "productpage"
    }
  },
  "status": [
  ]
}