Checking the connection to Analyzer detail view server

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can check the connection to the Analyzer detail view server.

Execution permission

Admin

Request line

POST baseURL/v1/services/HdcaSettings/actions/checkConnection/invoke

Request body

The structure of the request body and the object attributes are as follows:

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

Attribute	Type	Description
name	string	Name of the action.
href	string	URL for the action.
method	string	Name of the method.
type	string	Data format for the object.
parameters	anyType[]	A list of HdcaSetting objects necessary to execute an operation. For details, see the table below.

HdcaSetting

{
        "instanceID":"...",
        "host":"...",
        "protocol":"...",
        "port":"...",
        "userName":"...",
        "password":"...",
        "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.
password	string	Password used for executing the user API. Set a string encoded in Base64.
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.

Response body

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute	Type	Description
instanceID	string	ID of the Instance.
created	string	Date the object is generated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
updated	string	Time the object is updated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
completed	string	Time the processing completed in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).
state	string	One of the following values is set: "failed": The operation failed. "success": The operation completed successfully.
affectedResource	string[]	A blank space is set.
result	anyType[]	A list of HdcaSetting objects. For details, see the table below.

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.
400	Bad Request	The format of the request body is invalid.
401	Unauthorized	No login privilege.
403	Forbidden	No execute privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/HdcaSettings/actions/checkConnection/invoke
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Request Body]
{
  "name": "checkConnection",
  "href": "http://localhost:22015/Analytics/v1/services/HdcaSettings/actions/checkConnection/invoke",
  "method": "POST",
  "type": "application/json",
  "parameters":[{
    "instanceID":997104105,
    "host":"172.17.25.153",
    "protocol":"https",
    "port":"8443",
    "userName":"admin",
    "password":"aWFzMTIz"
  }]
}

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 11 Aug 2016 17:56:37 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]
{
  "instanceID" : "24aa67f4-26cb-4b89-8b22-acf9cecdc50b",
  "created" : "2016-08-12T02:56:38.372+09:00",
  "updated" : "2016-08-12T02:56:38.372+09:00",
  "completed" : "2016-08-12T02:56:38.372+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "port" : 0,
    "connectionResult" : true
  } ]
}