GET Cluster Vips Uuid

GET Cluster Vips Uuid

Retrieve the details of a virtual IP address. Includes the IP and FQDN for each, along with current status.

Request
URI
GET
https://{api_host}/api/v1/cluster/vips/{uuid}
COPY
Path Parameters
string
uuid
Required

This is a unique ID for Operations for Logs virtual IP address. It can be retrieved by 'GET /cluster/vips' call.

Authentication
This operation uses the following authentication methods.
Responses
200

The virtual IP address details were retrieved successfully.

Returns cluster.vips.uuid.get.response of type(s) application/json 
{
    "uuid": "10.11.12.13",
    "ipAddress": "10.11.12.13",
    "fqdn": "test1.example.com",
    "tags": {
        "k1": "v1",
        "k2": "v2"
    },
    "status": "AVAILABLE"
}

401

The request was refused because it lacks valid authentication credentials. This can happen if the Authorization header was missing, or if it contained an invalid session ID.

Obtain a new session ID and retry the request, or make an unauthenticated request without the Authorization header.

"Invalid session ID"

404

A virtual IP address with specified UUID was not found.

Operation doesn't return any data structure

440

The request was refused because the session ID has expired. Obtain a new session ID from /api/v1/sessions.

"Login Timeout"

500

Internal error while processing the client request

Returns error of type(s) application/json 
{
    "errorMessage": "The operation failed due to an internal error."
}
string
errorMessage
Required

A message describing the error.

string
errorCode
Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,
object
errorDetails
Optional

Dynamic error details, where the field name can vary depending on the request field and error code.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/cluster/vips/{uuid}
On This Page
Cluster Operations
GET
GET Cluster Vips
POST
POST Cluster Vips
GET
GET Cluster Vips Uuid
PUT
PUT Cluster Vips Uuid
DELETE
DELETE Cluster Vips Uuid
GET
GET Cluster Vips Usage Uuid