Get Service Info Using GET

The information returned includes the Health of the Service, uptime, start time of the service and etc. Specifically the Health of the Service is 'OK', when the Service is running and responsive, otherwise it is 'Error'.

Request

URI

GET

https://{api_host}/api/deployment/node/services/{name}/info

COPY

Path Parameters

string

name

Required

The name of the Service

Possible values are : UI, ADMINUI, CASA, ANALYTICS, COLLECTOR, API, CASSANDRA, LOCATOR, UNKNOWN,

Authentication

This operation uses the following authentication methods.

vRealizeOpsToken

Responses

200

Service is Healthy

Returns service of type(s) application/json

{
    "details": "string",
    "health": "string",
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "name": "string",
    "startedBy": "string",
    "startedOn": 0,
    "uptime": 0
}

string

details

Optional

An optional message field that provides details especially in case of errors

string

health

Required

Health of the Service

Possible values are : UNKNOWN, INVALID, OK, WARNING, ERROR,

array of link

links

Optional