Get Service Info

Get Service Info

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}/suite-api/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, LOCATOR, UNKNOWN,
Authentication
This operation uses the following authentication methods.
Responses
200

Service is Healthy

Returns service of type(s) application/json 
"{\n  \"name\" : \"ADMINUI\",\n  \"health\" : \"OK\"\n}"
string
name
Required

List of Services that are part of the VMware Cloud Foundation Operations stack

Possible values are : UI, ADMINUI, CASA, ANALYTICS, COLLECTOR, API, LOCATOR, UNKNOWN,
string
health
Required

Service Health types

Possible values are : UNKNOWN, INVALID, OK, WARNING, ERROR,
string
details
Optional

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

integer As int64 As int64
uptime
Optional

Uptime of the Service (Epoch time in milliseconds)

integer As int64 As int64
startedOn
Optional

When the Service was started (Epoch time in milliseconds)

string
startedBy
Optional

OS user that started the Service

array of object
links
Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.


400

Service is not valid

Operation doesn't return any data structure

503

Service is not Healthy

Returns service of type(s) application/json 
"{\n  \"name\" : \"ADMINUI\",\n  \"health\" : \"ERROR\"\n}"
string
name
Required

List of Services that are part of the VMware Cloud Foundation Operations stack

Possible values are : UI, ADMINUI, CASA, ANALYTICS, COLLECTOR, API, LOCATOR, UNKNOWN,
string
health
Required

Service Health types

Possible values are : UNKNOWN, INVALID, OK, WARNING, ERROR,
string
details
Optional

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

integer As int64 As int64
uptime
Optional

Uptime of the Service (Epoch time in milliseconds)

integer As int64 As int64
startedOn
Optional

When the Service was started (Epoch time in milliseconds)

string
startedBy
Optional

OS user that started the Service

array of object
links
Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/deployment/node/services/{name}/info
On This Page
Deployment Operations
PUT
Update Global Setting Value
PUT
Manage DT
GET
Get Node Status
GET
Get Service Info
GET
Get Services Info
GET
Get Global Settings
GET
Get Global Setting Value
GET
Get Global Setting Metadata