rack.php¶

В этой статье

Методы API

rack/add

rack/show

rack/update

rack/relocate

rack/remove

rack/list

rack/history

rack/update-order

Модуль управления стойками (rack): создание, удаление, перемещение между дата-центрами, обновление атрибутов и просмотр истории изменений.

Методы API¶

Метод	Действие	Описание
`add`	добавление новой стойки	Создает новую стойку в указанном дата-центре.
`history`	получение истории изменений	Возвращает историю событий для конкретной стойки или всех стоек за период.
`list`	получение списка стоек	Возвращает список доступных стоек в дата-центре.
`relocate`	перемещение стойки	Перемещает стойку в другой дата-центр.
`remove`	удаление стойки	Удаляет стойку из системы.
`show`	получение данных стойки	Возвращает детальную информацию о стойке по её ID.
`update`	обновление атрибутов стойки	Обновляет параметры существующей стойки.
`update-order`	обновление порядка стоек	Обновляет порядок расположения стоек в дата-центре на основе переданного массива данных.

rack/add¶

Создает новую стойку в указанном дата-центре.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add`
token	✅	string	Токен авторизации
datacenter	✅	integer	ID дата-центра. Должен быть больше 0.

Пример запроса

curl -s "https://invapi.hostkey.ru/rack.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN" \
--data "datacenter=VALUE"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "add",
"rack": {}
}

Примеры ошибок

{
"code": -1,
"message": "Valid datacenter ID is required for operation"
}

rack/show¶

Возвращает детальную информацию о стойке по её ID.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: show
token	✅	string	Токен авторизации
id	✅	integer	ID стойки. Должен быть больше 0.

Пример запроса

curl -s "https://invapi.hostkey.ru/rack.php" -X GET \
--data "action=show" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "show",
"rack": {
"id": 123,
"name": "Rack-01",
"datacenter_id": 5,
"status": "active"
}
}

Примеры ошибок

{
"code": -1,
"message": "Valid rack ID is required for operation"
}

rack/update¶

Обновляет параметры существующей стойки.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: update
token	✅	string	Токен авторизации
id	✅	integer	ID стойки. Должен быть больше 0.

Пример запроса

curl -s "https://invapi.hostkey.ru/rack.php" -X POST \
--data "action=update" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"module": "rack",
"action": "update",
"rack": {
"id": 123,
"name": "Updated Rack",
"datacenter_id": 5,
"status": "active"
}
}

Примеры ошибок

{
"code": -1,
"message": "Valid rack ID is required for operation"
}

rack/relocate¶

Перемещает стойку в другой дата-центр.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `relocate`
token	✅	string	Токен авторизации
id	✅	integer	ID стойки. Должен быть больше 0.
datacenter	✅	integer	ID нового дата-центра. Должен быть больше 0.

Пример запроса

curl -s "https://invapi.hostkey.ru/rack.php" -X POST \
--data "action=relocate" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "datacenter=VALUE"

Пример успешного ответа

{
"result": "OK",
"module": "rack",
"action": "relocate",
"rack": {
"id": 123,
"name": "Rack-01",
"datacenter_id": 6,
"status": "active"
}
}

Примеры ошибок

{
"code": -1,
"message": "Valid rack ID is required for operation"
}

rack/remove¶

Удаляет стойку из системы.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `remove`
token	✅	string	Токен авторизации
id	✅	integer	ID стойки. Должен быть больше 0.

Пример запроса

curl -s "https://invapi.hostkey.ru/rack.php" -X POST \
--data "action=remove" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"module": "rack",
"action": "remove",
"rack": {
"id": 123
}
}

Примеры ошибок

{
"code": -1,
"message": "Valid rack ID is required for operation"
}

rack/list¶

Возвращает список доступных стоек в дата-центре.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/rack.php" -X GET \
--data "action=list" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "list",
"racks_list": [
{
"id": 1,
"name": "Rack-01",
"datacenter_id": 1,
"status": "active"
},
{
"id": 2,
"name": "Rack-02",
"datacenter_id": 1,
"status": "pending"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Access denied"
}

rack/history¶

Возвращает историю событий для конкретной стойки или всех стоек за период.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `history`
token	✅	string	Токен авторизации
id	❌	`array<integer>`	ID стойки для фильтрации истории.
type	❌	`array<string>`	Тип события в истории.
date_from	❌	string	Дата начала периода (формат YYYY-MM-DD). По умолчанию -62 дня.
all	❌	boolean	Флаг получения всей истории без фильтрации по дате.

Пример запроса

curl -s "https://invapi.hostkey.ru/rack.php" -X POST \
--data "action=history" \
--data "token=HOSTKEY_TOKEN" \
--data "id[]=10" \
--data "type[]=rack_created"

Пример успешного ответа

{
"result": "OK",
"module": "rack",
"action": "history",
"history": [
{
"id": 10,
"event": "rack_created",
"date": "2024-05-01T12:00:00Z",
"user": "admin"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Access denied"
}

rack/update-order¶

Обновляет порядок расположения стоек в дата-центре на основе переданного массива данных.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `update-order`
token	✅	string	Токен авторизации пользователя.
params	✅	`array<string>`	Массив данных с информацией о расположении стоек для обновления порядка.

Пример запроса

curl -s "https://invapi.hostkey.ru/rack.php" -X POST \
--data "action=update-order" \
--data "token=HOSTKEY_TOKEN" \
--data "params[]=VALUE1" \
--data "params[]=VALUE2"

Пример успешного ответа

{
"result": "OK",
"module": "rack",
"action": "update-order",
"racks_list": [
{
"id": 1,
"name": "Rack-01",
"status": "active",
"position": 1
},
{
"id": 2,
"name": "Rack-02",
"status": "active",
"position": 2
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Empty requests are not supported"
}