Main

Перед покупкой

Регистрация в личном кабинете

Настройки личного кабинета

Добавление пользователя

Отключение пользователя

Настройка прав пользователя

Пользователи

Создание плательщика

Управление плательщиками

Плательщики

Партнерская программа

Уведомления о состоянии баланса

Переоформление аккаунта

Расторжение договора

PTR-запись через личный кабинет

Личный кабинет

Способы оплаты

Выставление счетов

Состояние баланса

Обещанный платеж

Автоматический платеж

Как использовать промо-код или сертификат

Акт сверки

Возврат средств

Продление услуг

Оплата услуг

Как правильно написать запрос в техническую поддержку

Обращение в техническую поддержку по телефону

Удаленные руки (remote hands)

Telegram-бот технической поддержки

SLA технической поддержки

Поддержка клиентов

Заказ выделенного сервера

Изменение услуги выделенного сервера

Установка ОС на выделенный сервер

KVM-консоль и IPMI

Начало работы

Как настроить MC-LAG

Мониторинг выделенных серверов

Как настроить Fake-raid

Инструкции

Выделенные серверы

Описание услуги

Документы для доступа в ЦОД

Внос и вынос оборудования

Доступ по PIN-коду

Как доставить оборудование в ЦОД

Правила проведения работ в серверных шкафах

Повышение отказоустойчивости

Подключение удаленного управления (IPMI, iLO, iDRAC)

Подключение внешнего IP-KVM

Управление кодовым замком

Размещение оборудования в ЦОД

Как использовать сертифкат

Заказ облачной платформы

Пополнение счета Облака

Организация сети между облачными серверами и другими услугами

Сети

Установка сервера из своего .iso образа

Облачная платформа

Установка ОС на виртуальный сервер из ISO-образа

Виртуальный серверы

Объектное хранилище S3

Как заказать услугу резервного копирования Кибер Бэкап

Установка агентов Кибер Бэкап

Резервное копирование - Кибер Бэкап

DDoS-защита

Как настроить VRRP на CentOS

Как настроить VRRP на Debian

VRRP

Перенос домена на NS сервер Миран

Создание доменных DNS-записей

Как изменить DNS-записи домена?

DNS хостинг

Сетевые сервисы

Авторизация

Получение информации о балансе

Работа с тикетами

Получение статистики энергопотребления серверных шкафов

Публичный API и автоматизация

Диск для бэкапов (FTP)

Прочие услуги

В API BILLmanager реализованы две функции:

## Получение списка арендованных стоек

**get_rack_list** - получение списка арендованных стоек (выводит номера стоек, относящихся к активным услугам аренды)

\
**Формат запроса:**

```bash
GET https://bill.miran.ru/billmgr?authinfo={username:password}&func=get_rack_list&out={json,xml}
```

\
**Query параметры:**

| Название | Описание | Тип | Обязательный параметр | Допустимые значения |
|----|----|----|----|----|
| **authinfo** | Параметры авторизации в BILLmanager | Строка | Да | имя_пользователя:пароль |
| **func** | Наименование функции запроса | Строка | Да | get_rack_list |
| **out** | Наименование типа формата ответа | Строка | Да | json или xml |

\
XX.YY.ZZZ - полный номер стойки

* XX - номер ЦОД
* YY - Номер серверного зала
* ZZZ - Порядковый номер стойки в зале

\
**Формат успешного ответа:**

JSON

```json
{
  "doc": {
          ...,
            "racks": {
                      "rack": [
                              {
                                  "$": "XX.YY.ZZZ"
                              },
                              ...
                              ]
                      },
                      "tparams": {
                          "out": {
                            "$": "json"
                       },
                      "func": {
                         "$": "get_rack_list"
                       }
                }
        }
}
```

\
XML

```markup
<?xml version="1.0" encoding="UTF-8"?>
<doc ...>
       <racks>
            <rack>XX.YY.ZZZ</rack>
            ...
        </racks>
        <tparams>
          <out>xml</out>
          <func>get_rack_list</func>
        </tparams>
      ...
</doc>
```

\
**Формат ответа с ошибкой:**

JSON

```json
{
  "doc": {
          "error": {
            …,
            "default": {
                 "$": "Во время выполнения запроса произошла ошибка"
            },
            "message": {
                 "$": "описание_ошибки"
            },
            "msg": {
                "$": "Во время выполнения запроса произошла ошибка"
            },
            "stack": {
                "action": {
                    ...,
                    "$": "get_rack_list"
                }
            },
            "status_code": {
                "$": "код_ошибки"
            }
        }
    }
}
```

\
XML

```markup
<?xml version="1.0" encoding="UTF-8"?>
<doc>
    <error ...>
        <status_code>код_ошибки</status_code>
        <message>описание_ошибки</message>
        <stack>
            <action ...>get_rack_list</action>
        </stack>
        <default>Во время выполнения запроса произошла ошибка</default>
        <msg>Во время выполнения запроса произошла ошибка</msg>
    </error>
</doc>
```

\
При возникновении ошибки на стороне модуля выводится код ошибки и краткое описание.

\
Коды ошибок:

* 500. Internal Error - внутренняя ошибка модуля, связанная с недоступностью сервиса.

\
При ошибке на стороне BILLmanager возможны иные виды ответа с ошибкой.

Например:

* некорректные данные в authinfo;
* некорректное название функции;
* некорректный тип формата ответа.

\
## Получение текущего энергопотребления стойки

**get_rack_energy_consumption** - получение энергопотребления стойки

\
**Формат запроса**

```javascript
GET
 https://bill.miran.ru/billmgr?authinfo={username:password}&func=get_rack_energy_consumption&rack
={XX.YY.ZZZ}&out={json,xml}
```

\
**Query параметры:** 

| Название | Описание | Тип | Обязательный параметр | Допустимые значения |
|----|----|----|----|----|
| **authinfo** | Параметры авторизации в BILLmanager | Строка | Да | имя_пользователя:пароль |
| **func** | Наименование функции запроса | Строка | Да | get_rack_energy_consumption |
| **rack_number** | Полный номер стойки | Строка | Да | XX.YY.ZZZXX - номер ЦОД; \n YY - номер зала; \n ZZZ - номер стойки в зале. |
| **out** | Наименование типа формата ответа | Строка | Да | json или xml |

\
**XX.YY.ZZZ** - полный номер стойки.

* XX - Номер ЦОД;
* YY - Номер зала;
* ZZZ - Номер стойки в зале.

**unix_timestamp** - время выполнения запроса в формате Unix-времени с указанием миллисекунд.

**value** - значение энергопотребления в ваттах в момент времени unix_timestamp.

\
**Формат успешного ответа:**

JSON

```json
{
    "doc": {
        ...,
        "rack_number": {
            "$": "XX.YY.ZZZ"
        },
        "timestamp": {
            "$": "unix_timestamp"
        },
        "value": {
            "$": "value"
        },
        "tparams": {
            "out": {
                "$": "json"
            },
            "rack_number": {
                "$": "XX.YY.ZZZ"
            },
            "func": {
                "$": "get_rack_energy_consumption"
            }
        }
    }
}
```

\
XML

```markup
<?xml version="1.0" encoding="UTF-8"?>
<doc ...>
    <rack_number>XX.YY.ZZZ</rack_number>
    <timestamp>unix_timestamp</timestamp>
    <value>value</value>
    <tparams>
        <out>xml</out>
        <rack_number>XX.YY.ZZZ</rack_number>
        <func>get_rack_energy_consumption</func>
    </tparams>
    ...
</doc>
```

\
**Формат ответа с ошибкой:**

JSON

```json
{
    "doc": {
        "error": {
            ...,
            "default": {
                "$": "Во время выполнения запроса произошла ошибка"
            },
            "message": {
                "$": "описание_ошибки"
            },
            "msg": {
                "$": "Во время выполнения запроса произошла ошибка"
            },
            "stack": {
                "action": {
                    ...,
                    "$": "get_rack_energy_consumption"
                }
            },
            "status_code": {
                "$": "код_ошибки"
            }
        }
    }
}
```

\
XML

```markup
<?xml version="1.0" encoding="UTF-8"?>
<doc>
    <error ...>
        <status_code>код_ошибки</status_code>
        <message>описание_ошибки</message>
        <stack>
            <action ...>get_rack_energy_consumption</action>
        </stack>
        <default>Во время выполнения запроса произошла ошибка</default>
        <msg>Во время выполнения запроса произошла ошибка</msg>
    </error>
</doc>
```

\
При возникновении ошибки на стороне модуля выводится код ошибки и краткое описание.

\
Коды ошибок:

* **400. Bad Request** - пользовательская ошибка (не предоставлен номер стойки, некорректный формат номера стойки и т.д.);
* **403. Forbidden** - у пользователя нет доступа к услуге с данной стойкой или услуга не находится в состоянии "активен";
* **500. Internal Error** - внутренняя ошибка модуля, связанная с недоступностью сервиса.

\
При ошибке на стороне BILLmanager возможны иные виды ответа с ошибкой.

Например:

* некорректные данные в authinfo;
* некорректное название функции;
* некорректный тип формата ответа.

\
## Получение среднего, максимального и минимального значений энергопотребления стойки за период

**get_rack_energy_consumption_stats** - получение среднего, максимального и минимального значений энергопотребления стойки в **Вт** за указанный промежуток времени.

\
**Формат запроса**

```javascript
GET https://bill.miran.ru/billmgr?authinfo={username:password}&func=get_rack_energy_consumption_stats&rack_number={XX.YY.ZZZ}&start_date={yyyy-mm-dd}&end_date={yyyy-mm-dd}&out={json,xml}
```

\
**Query параметры:** 

| Название | Описание | Тип | Обязательный параметр | Допустимые значения |
|----|----|----|----|----|
| **authinfo** | Параметры авторизации в BILLmanager | Строка | Да | имя_пользователя:пароль |
| **func** | Наименование функции запроса | Строка | Да | get_rack_energy_consumption_stats |
| **rack_number** | Полный номер стойки | Строка | Да | XX.YY.ZZZXX - номер ЦОД; \n YY - номер зала; \n ZZZ - номер стойки в зале. |
| **start_date** | Левая граница промежутка времени расчета статистик | Строка | Да | yyyy-mm-ddyyyy - год; \n mm - месяц; \n dd - день. |
| **end_date** | Правая граница промежутка времени расчета статистик | Строка | Да |    |
| **out** | Наименование типа формата ответа | Строка | Да | json или xml |

\
**Особенности:** 

* start_date и end_date считаются датами в формате **yyyy-mm-ddT00:00:00+03:00**;
* Расчет статистик ведется в полных днях, считая дни до end_date, количество полных дней рассчитывается как end_date - start_date; \n Пример: start_date = 2024-01-01, end_date=2024-01-05 \n количество полных дней: 5 - 1 = 4, таким образом, в расчете статистик будут участвовать дни 2024-01-01, 2024-01-02, 2024-01-03, 2024-01-04.
* Если дата открытия услуги позже start_date, то в качестве start_date будет использоваться дата открытия услуги в формате **yyyy-mm-ddT00:00:00+03:00**;
* Максимальное количество дней для расчета - 365. Если (end_date - start_date) > 365, то start_date будет скорректирован до end_date - 365;
* Минимальное количество дней для расчета - 1.

  \

**XX.YY.ZZZ** - полный номер стойки.

* XX - Номер ЦОД;
* YY - Номер зала;
* ZZZ - Номер стойки в зале.

**start_unix_timestamp** - левая граница временного промежутка в формате Unix-времени с указанием миллисекунд.

**end_unix_timestamp** - правая граница временного промежутка в формате Unix-времени с указанием миллисекунд.

**average_value** - среднее значение энергопотребления в ваттах за промежуток времени с start_unix_timestamp до end_unix_timestamp.

**min_value** - минимальное значение энергопотребления в ваттах за промежуток времени с start_unix_timestamp до end_unix_timestamp.

**max_value** - максимальное значение энергопотребления в ваттах за промежуток времени с start_unix_timestamp до end_unix_timestamp.

 **days** - количество полных дней, для которых считаются статистики.

\
**Формат успешного ответа:**

JSON

```json
{
    "doc": {
        ...,
        "rack_number": {
            "$": "XX.YY.ZZZ"
        },
        "start_timestamp": {
            "$": "start_unix_timestamp"
        },
        "end_timestamp": {
            "$": "end_unix_timestamp"
        },
        "days": {
            "$": "days"
        },
        "average": {
            "$": "average_value"
        },
        "min": {
            "$": "min_value"
        },
        "max": {
            "$": "max_value"
        },
        "tparams": {
            "end_date": {
                "$": "yyyy-mm-dd"
            },
            "out": {
                "$": "json"
            },
            "rack_number": {
                "$": "XX.YY.ZZZ"
            },
            "start_date": {
                "$": "yyyy-mm-dd"
            },
            "func": {
                "$": "get_rack_energy_consumption_stats"
            }
        }
    }
}
```

\
XML

```markup
<?xml version="1.0" encoding="UTF-8"?>
<doc ...>
    <rack_number>XX.YY.ZZZ</rack_number>
    <start_timestamp>start_unix_timestamp</start_timestamp>
    <end_timestamp>end_unix_timestamp</end_timestamp>
    <days>days</days>
    <average>average_value</average>
    <min>min_value</min>
    <max>max_value</max>
    <tparams>
        <end_date>yyyy-mm-dd</end_date>
        <out>xml</out>
        <rack_number>XX.YY.ZZZ</rack_number>
        <start_date>yyyy-mm-dd</start_date>
        <func>get_rack_energy_consumption_stats</func>
    </tparams>
    ...
</doc>
```

\
**Формат ответа с ошибкой:**

JSON

```json
{
    "doc": {
        "error": {
            ...,
            "default": {
                "$": "Во время выполнения запроса произошла ошибка"
            },
            "message": {
                "$": "описание_ошибки"
            },
            "msg": {
                "$": "Во время выполнения запроса произошла ошибка"
            },
            "stack": {
                "action": {
                    ...,
                    "$": "get_rack_energy_consumption_stats"
                }
            },
            "status_code": {
                "$": "код_ошибки"
            }
        }
    }
}
```

\
XML

```markup
<?xml version="1.0" encoding="UTF-8"?>
<doc>
    <error ...>
        <status_code>код_ошибки</status_code>
        <message>описание_ошибки</message>
        <stack>
            <action ...>get_rack_energy_consumption_stats</action>
        </stack>
        <default>Во время выполнения запроса произошла ошибка</default>
        <msg>Во время выполнения запроса произошла ошибка</msg>
    </error>
</doc>
```

\
При возникновении ошибки на стороне модуля выводится код ошибки и краткое описание.

\
Коды ошибок:

* **400. Bad Request** - пользовательская ошибка (не предоставлен номер стойки, некорректный формат номера стойки и т.д.);
* **403. Forbidden** - у пользователя нет доступа к услуге с данной стойкой или услуга не находится в состоянии "активен";
* **500. Internal Error** - внутренняя ошибка модуля, связанная с недоступностью сервиса.

\
При ошибке на стороне BILLmanager возможны иные виды ответа с ошибкой.

Например:

* некорректные данные в authinfo;
* некорректное название функции;
* некорректный тип формата ответа.

\


Miran - база знаний