The following operation is the initial step to check the connection to the Analyzer detail view server.
Execution permission
Admin
Request line
GET baseURL/v1/services/HdcaSettings/actions/checkConnection
Request body
Not applicable.
Response body
The structure of the response body and the object attributes is 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":"...",
"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/services/HdcaSettings/actions/checkConnection
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json
[Response Header]
HTTP/1.1 200 OK
Date: Mon, 22 Aug 2016 05:19:50 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 891f1a62fea230bee798f496e1189ce2ead3fca_Y2UOI2pkMXQ=_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]
{
"name": "checkConnection",
"href": "http://localhost:22015/Analytics/v1/services/HdcaSettings/actions/checkConnection/invoke",
"method": "POST",
"type": "application/json",
"parameters": [
{
"instanceID": "997104105",
"host": "hdca server",
"protocol": "https",
"port": 8443,
"userName": "admin",
"connectionResult": false
}
]
}