Перейти к содержанию

Примеры API-запросов

Получить информацию о ресурсах

В данной статье собраны примеры запросов для получения информации о доступных ресурсах следующих объектов виртуализации:

Внимание

Первый этап выполнения запросов — аутентификация и авторизация

Получить токен аутентификации и авторизации

Запрос

Чтобы получить токен аутентификации и авторизации, отправьте следующий запрос 

curl -X POST "http://<vip_ip_addr>/api/v1/auth" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"cluster\": \"<cluster_name>\", \"ns\": \"admins\", \"password\": \"<cluster_admin_passwd>\", \"username\": \"cluster_admin\"}"

Ответ

{"access_token":"<token>"}

По умолчанию токен аутентификации действителен 5 минут. В течение данного времени выполняйте необходимые запросы.
Если время действия токена вышло, необходима повторная аутентификация и авторизация.
Время действия токена может быть изменено Администратором ВЦОД.

Доступные ресурсы кластера

Запрос

Чтобы получить информацию о доступных ресурсах кластера, выполните следующий запрос

curl -X PUT "http://<vip_ip_addr>:8082/api/v1/cluster/<cluster_name>/plugins/aaa" -H "Content-Type: application/json" -H "accept: application/json" -H "Authorization: JWT <token>" -d "{\"context\":{\"op\":\"cluster_resource_show\"}}"

Ответ

"data":{"cluster":"<cluster_name>","ram_allocated":"15Gb","ram_available":"18Gb","uuids":["df6653a4-f53f-4848-ae04-8f45b4e953f1","babad968-eb8d-439e-b1a2-a0bda05b564e","b4d2051d-b86a-4cc5-8c15-f46da4906eba"],"vcpu_allocated":15,"vcpu_available":195}}

Доступные ресурсы ВЦОД. Пользователь во ВЦОД управления

Важно

Данный запрос доступен только пользователю, находящемуся во ВЦОД управления

Запрос

Чтобы получить информацию о выделенных ресурсах ВЦОД, выполните следующий запрос

curl -X PUT "http://<vip_ip_addr>:8082/api/v1/cluster/<cluster_name>/plugins/aaa" -H "Content-Type: application/json" -H "accept: application/json" -H "Authorization: JWT <token>" -d "{\"context\":{\"op\":\"namespace_show\"}, \"data\": {\"cluster\": \"<cluster_name>\", \"ns\": \"<vcod_name>\"}}"

Ответ

"data":{"cluster":"<cluster_name>","ctx_trace_token":"1f00e2b1-4c7f-6462-9811-a0bda05b564e","date_create":"2025-03-18T12:41:16.439000+00:00","date_update":"2025-03-31T12:24:24.430000+00:00","descr":null,"ns":"<vcod_name>","object_data":{"login":null,"paths":null},"paths":"{\"/\":{\"dir1\":{\"dir2\":{\"dir3\":null}}}}","q_task":{"op":"MODIFY","op_request":"{\"paths\": \"{\\\"/\\\":{\\\"dir1\\\":{\\\"dir2\\\":{\\\"dir3\\\":null}}}}\"}","run_error":null,"run_retry":0,"state":"FINISH","trace_token":"1f00e2b1-4c7f-6462-9811-a0bda05b564e"},"status":"READY","vcpu":10,"vram":"10Gb"}}

Доступные ресурсы ВЦОД. Пользователь во ВЦОД

Важно

Данный запрос доступен пользователю, находящемуся во ВЦОД

Запрос

Чтобы получить информацию о выделенных ресурсах ВЦОД, выполните следующий запрос

curl -X PUT "http://<vip_ip_addr>:8082/api/v1/cluster/<cluster_name>/plugins/scheduler" -H "Content-Type: application/json" -H "accept: application/json" -H "Authorization: JWT <token>" -d "{\"context\":{\"op\":\"vcluster_resource_show\",\"cluster\": \"<cluster_name>\", \"ns\": \"<vcod_name>\", \"path\": \"/\"}}"

Ответ

"data":{"ns":"<vcod_name>","vcpu_allocated":10,"vcpu_available":0,"vram_allocated":"10Gb","vram_available":"0Gb"}}

Доступные ресурсы виртуального кластера

Запрос

Чтобы получить информацию о доступных ресурсах виртуального кластера, выполните следующий запрос

curl -X PUT "http://<vip_ip_addr>:8082/api/v1/cluster/<cluster_name>/plugins/scheduler" -H "Content-Type: application/json" -H "accept: application/json" -H "Authorization: JWT <token>" -d "{\"context\":{\"op\":\"vcluster_show\",\"cluster\": \"<cluster_name>\", \"ns\": \"<vcod_name>\", \"path\": \"/\"}, \"data\":{\"name\":\"<vcluster_name>\"}}"

Ответ

"data":{"allocated_vcpu":1,"allocated_vram":"1Gb","ctx_trace_token":"1f003fc2-62f7-6b4f-9306-8f45b4e953f1","date_create":"2025-03-18T13:23:15.663000+00:00","date_update":null,"descr":null,"drain_strategy":"MIGRATE","isolation_strategy":"RECREATE","labels":"node=secure","name":"<vcluster_name>","object_data":{"login":"vcod_admin","paths":["/","/dir1/","/dir1/dir2/","/dir1/dir2/dir3/"]},"q_task":{"op":"ADD","op_request":null,"run_error":null,"run_retry":0,"state":"FINISH","trace_token":"1f003fc2-62f7-6b4f-9306-8f45b4e953f1"},"rf":1,"status":"READY","ulimits":"no","uuids":["df6653a4-f53f-4848-ae04-8f45b4e953f1","babad968-eb8d-439e-b1a2-a0bda05b564e","b4d2051d-b86a-4cc5-8c15-f46da4906eba"],"vcpu":2,"vram":"2Gb"}}