Доступ к API Continent: различия между версиями
Entcor (обсуждение | вклад) Нет описания правки |
Entcor (обсуждение | вклад) Нет описания правки |
||
| (не показаны 3 промежуточные версии этого же участника) | |||
| Строка 32: | Строка 32: | ||
=== Раздел api-v1-objects === | === Раздел api-v1-objects === | ||
[[:Файл:C4 swagger api-v1-objects.json.txt|Swagger continent api-v1-objects]] | [[:Файл:C4 swagger api-v1-objects.json.txt|Swagger continent api-v1-objects]] | ||
Для выполнения запросов из данной группы сначала необходимо получить идентификатор необходимой конфигурации (активной) запросом: <syntaxhighlight lang="bash"> | Для выполнения запросов из данной группы сначала необходимо получить идентификатор необходимой конфигурации (активной) запросом: <syntaxhighlight lang="bash"> | ||
curl -u admin:Ng3-dcc20 http://192.168.23.9:4431/api-v1-objects/config | curl -u admin:Ng3-dcc20 http://192.168.23.9:4431/api-v1-objects/config | ||
| Строка 40: | Строка 41: | ||
=== Раздел api-v1-server === | === Раздел api-v1-server === | ||
[[:Файл:C4 swagger api-v1- | [[:Файл:C4 swagger api-v1-server.json.base64.txt|Swagger continent api-v1-server]] | ||
''Файл закодирован в base64, потому что wiki октазывалась его сохранять, счетая небезопасным. Для декодировки выполнить:''<syntaxhighlight lang="text"> | |||
cat c4_swagger_api-v1-server.json.base64.txt | base64 -d > c4_swagger_api-v1-server.json | |||
</syntaxhighlight> | |||
Префикс всех запросов '''/api-v1-server/'''<syntaxhighlight lang="text"> | Префикс всех запросов '''/api-v1-server/'''<syntaxhighlight lang="text"> | ||
curl -u admin:Ng3-dcc20 http://192.168.23.9:4431/api-v1-server/get-time | curl -u admin:Ng3-dcc20 http://192.168.23.9:4431/api-v1-server/get-time | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Текущая версия от 04:01, 2 августа 2024
Общее
[править | править код]Описание доступа к API Continent
Мониторинг
[править | править код]Интерфейс подсистемы мониторинга доступен по прямой ссылке на ЦУС https://192.168.23.9 (логин: admin, пароль: Ng3-dcc20). Возможно потребуется прописать маршрут в сеть 192.168.23.0/24 через 192.168.2.150.
Для передачи данных используется websocket соединение wss://192.168.23.9/websockets. В его сообщениях можно найти примеры запросов данных. Например:
{"admin_uuid":"cc578ec9-f733-4475-9a04-d8f6649af990","cmd":"node_info","ids":[1000,1001,1002]}
Для тестирования можно создать websocket соединение через Postman. Аутентификация не требуется.
API конфигурирования
[править | править код]Обеспечение доступа
[править | править код]Для обеспечения доступа к API необходимо изменить настройки nginx на ЦУС: /var/cont/nginx.conf. В файле настроке надо сделать копию секции "server { listen 444 default_server ssl;". При этом надо изменить верхнюю строчку на "listen 4431 default_server;" . Так же надо найти секцию:
server {
listen 4431 default_server ssl;
listen 192.168.23.2:4431 ssl;
listen 192.168.23.25:4431 ssl;
listen 192.168.23.9:4431 ssl;
и заменить все 4431 на, к примеру, 4432. Или вообще удалить эту секцию.
Затем необходимо загрузить обновленные настройки командой nginx -s reload.
Проверить доступ к API можно командой
curl -u admin:Ng3-dcc20 http://192.168.23.9:4431/api-v1-objects/config
Раздел api-v1-objects
[править | править код]Swagger continent api-v1-objects
Для выполнения запросов из данной группы сначала необходимо получить идентификатор необходимой конфигурации (активной) запросом:
curl -u admin:Ng3-dcc20 http://192.168.23.9:4431/api-v1-objects/config
Затем полученный идентификатор можно использовать в URL остальных запросов. К примеру, если идентификатор конфигурации 1:
curl -u admin:Ng3-dcc20 http://192.168.23.9:4431/api-v1-objects/config/1/interfaceetherПрефикс всех запросов /api-v1-objects/
Раздел api-v1-server
[править | править код]Swagger continent api-v1-server
Файл закодирован в base64, потому что wiki октазывалась его сохранять, счетая небезопасным. Для декодировки выполнить:
cat c4_swagger_api-v1-server.json.base64.txt | base64 -d > c4_swagger_api-v1-server.json
Префикс всех запросов /api-v1-server/
curl -u admin:Ng3-dcc20 http://192.168.23.9:4431/api-v1-server/get-time