Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Node parameters can be changed with /api/node/update request

APIRequestResponseResponse status
WS API
Code Block
themeRDark
SEND
destination:/app/api/node/update
content-length:121

{
 "requestId":"70ed9798-6463-4741-818f-b0b9d7299b6f",
 "realm":"/api/node/update",
 "payload":
 {
  "id":"2",
  "profiles":["1","2"]
 }
}
Code Block
themeRDark
MESSAGE
destination:/user/service
content-type:application/json;charset=UTF-8
subscription:sub-1
message-id:3-25
content-length:84

{
 "requestId":"70ed9798-6463-4741-818f-b0b9d7299b6f",
 "status":200,
 "reason":"SUCCESS"}

200 OK

400

404 Object not found

500 Persist exception

REST API
Code Block
themeRDark
POST: /api/node/update "application/json; charset=utf-8"
{
 "id":"2",
 "profiles":["1","2"]
}
Code Block
themeRDark
{
 "status":200,
 "reason":"SUCCESS"
}

200 OK

400

404 Object not found

500 Persist exception

Where

  • id – node identifier
  • profiles – list of identifiers of profiles defining which metrics are acquired from this node

...

A node can be deleted with /api/node/delete request

APIRequestResponseResponse status
WS API
Code Block
themeRDark
SEND
destination:/app/api/node/delete
content-length:100

{
 "requestId":"a2d3fd81-4598-41cf-8840-e40770d597b4",
 "realm":"/api/node/delete",
 "payload":
 {
  "id":"2"
 }
}
Code Block
themeRDark
MESSAGE
destination:/user/service
content-type:application/json;charset=UTF-8
subscription:sub-1
message-id:3-25
content-length:84

{
 "requestId":"a2d3fd81-4598-41cf-8840-e40770d597b4",
 "status":200,
 "reason":"SUCCESS"}

200 OK

400

404 Object not found

500 Persist exception

REST API
Code Block
themeRDark
POST: /api/node/delete "application/json; charset=utf-8"
{
 "id":"2"
}
Code Block
themeRDark
{
 "status":200,
 "reason":"SUCCESS"
}

200 OK

400

404 Object not found

500 Persist exception

Where

  • id – node identifier

...

A node information can be obtained with /api/node/list request

APIRequestResponseResponse status
WS API
Code Block
themeRDark
SEND
destination:/app/api/node/list
content-length:98

{
 "requestId":"5c809c02-1082-418e-8423-db7dbff9605c",
 "realm":"/api/node/list",
 "payload":
 {
  "id":"3"
 }
}
Code Block
themeRDark
MESSAGE
destination:/user/service
content-type:application/json;charset=UTF-8
subscription:sub-1
message-id:3-28
content-length:143

{
 "requestId":"5c809c02-1082-418e-8423-db7dbff9605c",
 "status":200,
 "reason":"SUCCESS",
 "payload":[
  {
   "id":3,
   "host":"192.168.1.64",
   "profiles":[1]
  }
 ]
}

200 OK

400

404 Object not found

500 Persist exception

REST API
Code Block
themeRDark
POST: /api/node/list "application/json; charset=utf-8"
{
 "id":"3"
}
Code Block
themeRDark
{
    "status": 200,
    "reason": "SUCCESS",
    "payload": [
        {
            "id": 3,
            "host": "192.168.1.64",
            "profiles": [
                1
            ]
        }
    ]
}

200 OK

400

404 Object not found

500 Persist exception

Where

  • id – node identifier
  • host - WCS server address
  • profiles - profiles list

...

A node current state can be obtained with /api/node_status/list query

APIRequestResponseResponse status
WS API
Code Block
themeRDark
SEND
destination:/app/api/node_status/list
content-length:105

{
 "requestId":"404ae542-b729-4b6e-bf28-ef85dc1f8630",
 "realm":"/api/node_status/list",
 "payload":
 {
  "id":"3"
 }
}
Code Block
themeRDark
MESSAGE
destination:/user/service
content-type:application/json;charset=UTF-8
subscription:sub-1
message-id:3-31
content-length:171

{
 "requestId":"404ae542-b729-4b6e-bf28-ef85dc1f8630",
 "status":200,
 "reason":"SUCCESS",
 "payload":[
  {
   "id":3
, "connectTimestamp":0, "connectCounter":0
,
   "
connected":true, "
rate":
0
160
  }
 ]
}

200 OK

400

404 Object not found

500 Persist exception

REST API
Code Block
themeRDark
POST: /api/node_status/list "application/json; charset=utf-8"
{
 "id":"3"
}
Code Block
themeRDark
{
    "status": 200,
    "reason": "SUCCESS",
    "payload": [
        {
            "id": 3
, "connectTimestamp": 0, "connectCounter": 0, "connected": true
,
            "rate": 160
        }
    ]
}

200 OK

400

404 Object not found

500 Persist exception

Where

  • id – node identifierconnectTimeStamp – current connection timestamp
  • connectCounter – current connection attempts count
  • connected – if the connection is established
  • rate – metrics acquisition rate

If node Id is set, the response will contain only that node state. If Id is not set, the response will contain current state of all the nodes on backend server.

If the node is not connected to backend server, or if this node never be connected, the response will be 404 OBJECT_NOT_FOUND