Getting a list of Analyzer detail view server connection settings

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-20

You can obtain a list of connection settings for the Analyzer detail view server, such as the host name and user name.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/HdcaSettings

Request body

Not applicable.

Response body

The structure of the response body and the object attributes is as follows:

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	A list of HdcaSetting objects. For details, see the table below.
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions related to this query(API).

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	Page.
pageSize	integer	Size of page.
numPages	integer	Number of pages.
totalCount	integer	Number of objects.

HdcaSetting

{
        "instanceID":"...",
        "host":"...",
        "protocol":"...",
        "port":"...",
        "userName":"...",
        "connectionResult":"...",
        "url":"...",
        "message":"...",
        "messageID":"..."
}

HdcaSetting (Type: HdcaSetting)

Attribute	Type	Description
instanceID	string	ID of the connection setting.
host	string	Host name used for connecting to the Analyzer detail view server.
protocol	string	Protocol used for connecting to the Analyzer detail view server.
port	int	Port number used for connecting to the Analyzer detail view server.
userName	string	Administration user of Analyzer detail view.
connectionResult	boolean	Whether or not connection to the Analyzer detail view server was successful.
url	string	URL of the Analyzer detail view server.
message	string	The error message when connection failed.
messageID	string	ID of the error message when connection failed.

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/HdcaSettings
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 11 Aug 2016 17:56:36 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 8113b75377dac59b7c48ee2b947b20d3bbc11f_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "data" : [ {
    "instanceID" : "997104105",
    "host" : "172.17.25.153",
    "protocol" : "https",
    "port" : 8443,
    "userName" : "admin",
    "connectionResult" : false
  } ],
  "count" : 1
}