Getting the Analyzer detail view server information

Ops Center Analyzer Detail View REST API Reference Guide

Version
11.0.x
Audience
anonymous
Part Number
MK-99ANA004-10

You can obtain the following server information: server locale, time zone, database version, and so on.

Request line

GET baseURL/dbapi.do?action=getServerInfo

Request body

Not applicable.

Request parameters

Parameter Type Description
action String getServerInfo

Specify API function to be invoked .

dataset String Dataset name. From 2 to 32 alphanumeric, underscore (_), and hyphen (-) characters are allowed.
includeVersion Boolean Specify if you want to get the version details of the database and REST API or not.

True or false

Default: false

Request example

GET /dbapi.do?action=getServerInfo&dataset=defaultDs HTTP /1.1 Authorization:Basic ZnJlZDpmcmVk

Response body

{
  "uuid":"",
  "appVersion":"",
  "dbVersion":"",
  "apiVersion":{
    "dbApiVersion":"",
    "alertApiVersion":""
  },
  "locale":"",
  "timeZone":"",
  "hostName":"",
  "ipAddress":"",
  "globalDataTimeWindow":
}

Response example

{
  "uuid":"8e57094d-78fa-4a25-a839-1b5e25763971",
  "appVersion":"HDCA Server v8.0-16070112",
  "dbVersion":"2.1",
  "apiVersion":{
    "dbApiVersion":"2.0",
    "alertApiVersion":"1.2"
  },
  "locale":"en-us",
  "timeZone":"Etc/UTC",
  "hostName":"cumupunws58.corp.cumulus",
  "ipAddress":"192.168.1.117",
  "globalDataTimeWindow":null
}

Status codes

Status code

Message

Description

400 BAD REQUEST Request URL or request body validation failed. Check the response body for details.
401 UNAUTHORIZED Supplied authentication token is invalid or does not have the appropriate credentials to access the resource.
500 SERVER ERROR API operation request failed. Check the response body for details.

Response codes

The following table lists the common API response codes that might be generated through the standard API. If an error response is not listed, examine the HTTP status codes to determine the best method for addressing the issue.

Response code Message Condition
C20000E4 Mandatory parameter {dataset} not specified. Parameter dataset is not specified.
C20000E9 License is not valid. License is not uploaded, or the uploaded license is invalid or expired.
C20000E9 Authorization is required. Request is sent with an invalid authentication token.
C20600E2 Application encountered an internal error. API server encountered an unknown error.