Get Virtual Service | VMware Cloud Director OpenAPI

Get Virtual Service

Retrieves a specific Virtual Service.

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/loadBalancer/virtualServices/{virtualServiceId}

COPY

Path Parameters

string

virtualServiceId

Required

virtualServiceId

string

virtualServiceId

Required

virtualServiceId

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns EdgeLoadBalancerVirtualService of type(s) application/json;version=38.0

This response body class contains all of the following: EdgeLoadBalancerVirtualServiceCommonProperties , InlineEdgeLoadBalancerVirtualService1

{
    "id": "string",
    "name": "string",
    "description": "string",
    "enabled": false,
    "virtualIpAddress": "string",
    "ipv6VirtualIpAddress": "string",
    "loadBalancerPoolRef": {
        "name": "string",
        "id": "string"
    },
    "gatewayRef": {
        "name": "string",
        "id": "string"
    },
    "serviceEngineGroupRef": {
        "name": "string",
        "id": "string"
    },
    "certificateRef": {
        "name": "string",
        "id": "string"
    },
    "servicePorts": [
        {
            "tcpUdpProfile": {
                "name": "string",
                "type": "string",
                "systemDefined": false
            },
            "portStart": 0,
            "portEnd": 0,
            "sslEnabled": false
        }
    ],
    "healthStatus": "string",
    "healthMessage": "string",
    "detailedHealthMessage": "string",
    "transparentModeEnabled": false,
    "nonCriticalLoggingEnabled": false,
    "applicationProfile": {
        "name": "string",
        "type": "string",
        "systemDefined": false
    }
}

Availability

Added in 35.0

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Edge Gateway Load Balancer Virtual Service Operations

DELETE

Delete Virtual Service