Page History

...

Параметры узла могут быть изменены при помощи запроса /api/node/update

API

Request

Response

Response status

WS API

Code Block

theme	RDark

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

theme	RDark

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 Object not found

500 Persist exception

REST API

Code Block

theme	RDark

POST: /api/node/update "application/json; charset=utf-8"
{
 "id":"2",
 "profiles":["1","2"]
}

Code Block

theme	RDark

{
 "status":200,
 "reason":"SUCCESS"
}

200 OK

400 Object not found

500 Persist exception

Здесь:

id – идентификатор узла
profiles – список идентификаторов профилей, определяющих метрики, собираемые с данного сервера

...

Узел может быть удален при помощи запроса /api/node/delete

API

Request

Response

Response status

WS API

Code Block

theme	RDark

SEND
destination:/app/api/node/delete
content-length:100

{
 "requestId":"a2d3fd81-4598-41cf-8840-e40770d597b4",
 "realm":"/api/node/delete",
 "payload":
 {
  "id":"2"
 }
}

Code Block

theme	RDark

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 Object not found

500 Persist exception

REST API

Code Block

theme	RDark

POST: /api/node/delete "application/json; charset=utf-8"
{
 "id":"2"
}

Code Block

theme	RDark

{
 "status":200,
 "reason":"SUCCESS"
}

200 OK

400 Object not found

500 Persist exception

Здесь:

id – идентификатор узла

...

Информацию об узле можно получить при помощи запроса /api/node/list

API

Request

Response

Response status

WS API

Code Block

theme	RDark

SEND
destination:/app/api/node/list
content-length:98

{
 "requestId":"5c809c02-1082-418e-8423-db7dbff9605c",
 "realm":"/api/node/list",
 "payload":
 {
  "id":"3"
 }
}

Code Block

theme	RDark

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 Object not found

500 Persist exception

REST API

Code Block

theme	RDark

POST: /api/node/list "application/json; charset=utf-8"
{
 "id":"3"
}

Code Block

theme	RDark

{
    "status": 200,
    "reason": "SUCCESS",
    "payload": [
        {
            "id": 3,
            "host": "192.168.1.64",
            "profiles": [
                1
            ]
        }
    ]
}

200 OK

400 Object not found

500 Persist exception

Здесь:

id – идентификатор узла
host - адрес WCS-сервера, подключенного к бэкенду
profiles - список профилей

...

Текущее состояние узла можно получить при помощи запроса /api/node_status/list

API

Request

Response

Response status

WS API

Code Block

theme	RDark

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

theme	RDark

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

theme	RDark

POST: /api/node_status/list "application/json; charset=utf-8"
{
 "id":"3"
}

Code Block

theme	RDark

{
    "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

Здесь:

id – идентификатор узла
connectTimeStamp – время установки соединения с узлом
connectCounter – количество установок соединения с узлом
connected – установлено ли соединение с узлом
rate – частота, с которой метрики присылаются WCS-сервером на бэкенд-сервер

Если указан идентификатор узла, то ответ будет содержать информацию только об этом узле. Если идентификатор не указан, ответ будет содержать текущее состояние всех узлов, наблюдаемых на бэкенде.

Если узел в данный момент не подключен к бэкенд-серверу, либо такой узел никогда ранее не подключался, запрос вернет ошибку 404 OBJECT_NOT_FOUND

Space shortcuts

Page tree

Versions Compared

Old Version 4

New Version 5

Key