GET Cluster Vips

GET Cluster Vips

Retrieve the list of virtual IP addresses. Includes the IP and FQDN for each, along with current status.

Request
URI
GET
https://{api_host}/api/v2/cluster/vips
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

The list of virtual IP addresses was retrieved successfully.

Returns cluster.vips.get.response of type(s) application/json
{
    "vips": [
        {
            "uuid": "10.11.12.13",
            "ipAddress": "10.11.12.13",
            "fqdn": "test1.example.com",
            "tags": {
                "k1": "v1",
                "k2": "v2"
            },
            "status": "AVAILABLE"
        },
        {
            "uuid": "10.11.12.14",
            "ipAddress": "10.11.12.14",
            "fqdn": "",
            "tags": {
                "k3": "v3"
            },
            "status": "UNAVAILABLE"
        },
        {
            "uuid": "10.11.12.15",
            "ipAddress": "10.11.12.15",
            "fqdn": "test3.example.com",
            "tags": {
                "k4": "v4",
                "k5": "v5"
            },
            "status": "UNKNOWN"
        }
    ]
}

401
Operation doesn't return any data structure

440
Operation doesn't return any data structure

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/v2/cluster/vips