REST API

Примечание

Для получения доступа к REST API необходим токен. Получение токена описано во вкладке с дополнительной информацией.


Monitor API

Позволяет управлять настройками резервного копирования, мониторинга. Предоставляет дополнительную информацию, используемую в модуле Monitor.

Информация о модуле

Подробная информация о модуле.

GET
/v1/info
Получение подробной информации о модуле.
Запрос
Пример запроса:
curl -X GET -H "X-Auth-Token: $token" http://controller:9363/v1/info | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
license (Optional) body object Информация о лицензии модуля.
version body string Версия модуля.

Пример получения информации о модуле в JSON формате:

{
    "info": {
        "license": {
            "created_at": 1538141221,
            "expire_at": 1545955201,
            "module_package": "monitor",
            "name": "TestLicense",
            "product": "Monitor",
            "surrogate_name": "Monitor",
            "unique_id": "04-002-4b21d16097656c2c0214",
            "verified": true
        },
        "version": "2.0"
    }
}

Статистические данные виртуальных машин

Предоставляет статистику виртуальной машины и действия для управления мониторингом.

GET
/v1/metrics/{server_id}
Получение статистических данных виртуальной машины.

Получение статистических данных об указанной виртуальной машине.

Запрос
Параметры запроса:
Name In Type Description
server_id path string Идентификатор виртуальной машины.
offset (Optional) path integer Номер позиции для получения данных.
limit (Optional) path integer Ограничение количества получаемых данных.
Пример запроса:
curl -X GET -H "X-Auth-Token: $token" http://controller:9363/v1/metrics/$server_id | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
metrics body string Список статистик и действий.

Пример получения статистических данных по виртуальной машине в JSON формате:

{
    "metrics": {
        u'cpu_util': {
            u'items': [
                (u'2017-03-22T11:27:27.291000', 3.082715849239197),
                (u'2017-03-22T11:17:26.197000', 3.0734477629159596),
                (u'2017-03-21T11:37:26.035000', 3.188243387673628)
            ],
            u'unit': u'%'
        },
        u'disk.read.bytes': {
            u'items': [
                (u'2017-03-22T11:27:27.372000', 20164608.0),
                (u'2017-03-21T11:37:26.089000', 20164608.0)
            ],
            u'unit': u'B'
        },
        u'disk.write.bytes': {
            u'items': [
                (u'2017-03-22T11:27:27.554000', 288768.0),
                (u'2017-03-21T11:37:26.270000', 288768.0)
            ],
            u'unit': u'B'
        }
    }
}
GET
/v1/metrics/names
Получение перечня параметров, по которым выводятся статистические данные.

Получение перечня доступных параметров, по которым выводятся статистические данные.

Запрос
Пример запроса:
curl -X GET -H "X-Auth-Token: $token" http://controller:9363/v1/metrics/names | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
metrics_names body string Наименования метрик.

Пример получения наименований доступных параметров в JSON формате:

{
    "metrics_names": [
        "memory.usage",
        "cpu_util",
        "disk.read.requests.rate",
        "disk.write.requests.rate",
        "disk.read.bytes.rate",
        "disk.write.bytes.rate",
        "disk.latency",
        "disk.iops",
        "network.incoming.bytes.rate",
        "network.outgoing.bytes.rate",
        "network.incoming.packets.rate",
        "network.outgoing.packets.rate",
    ]
}

Системы резервного копирования

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

GET
/v1/backup-systems/
Получение списка систем резервного копирования.

Получение списка систем резервного копирования.

Запрос
Параметры запроса:
Name In Type Description
domain_id (Optional) path string Идентификатор домена.
hostname (Optional) path string Доменное имя системы резервного копирования.
backup_system (Optional) path string Вид системы резервного копирования. Возможные значения: 0 - Bareos. По умолчанию: 0.
offset (Optional) path integer Номер позиции для получения данных.
limit (Optional) path integer Ограничение количества получаемых данных.
Пример запроса:
curl -X GET -H "X-Auth-Token: $token" http://controller:9363/v1/backup-systems/ | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
id body string Идентификатор системы резервного копирования.
domain_id body string Идентификатор домена.
hostname body string Доменное имя системы резервного копирования.
backup_system body string Вид системы резервного копирования. Возможные значения: 0 - Bareos. По умолчанию: 0.

Пример результата в JSON формате:

{
    "backup_systems": [
        {
            "backup_system": 0,
            "domain_id": "30b9a74c0cef4b7f820d106580b38d31",
            "hostname": "Some Name",
            "id": 1
        },
        {
            "backup_system": 0,
            "domain_id": "09434a2f76e248518acc5825dccb7921",
            "hostname": "Host",
            "id": 3
        }
    ]
}
GET
/v1/backup-systems/count
Получение количества записей о системах резервного копирования.

Получение количества систем резервного копирования.

Запрос
Параметры запроса:
Name In Type Description
domain_id (Optional) path string Идентификатор домена.
hostname (Optional) path string Доменное имя системы резервного копирования.
backup_system (Optional) path string Вид системы резервного копирования. Возможные значения: 0 - Bareos. По умолчанию: 0.
Пример запроса:
curl -X GET -H "X-Auth-Token: $token" http://controller:9363/v1/backup-systems/count | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
count body integer Количество объектов.

Пример результата в JSON формате:

{
    "count": 1
}
POST
/v1/backup-systems/
Создание системы резервного копирования.

Создание системы резервного копирования. Доступно только для администратора домена.

Запрос
Параметры запроса:
Name In Type Description
domain_id body string Идентификатор домена.
hostname body string Доменное имя системы резервного копирования.
password body string Пароль для системы резервного копирования.
private_key body string Ключ для обращения к системе резервного копирования.
Пример запроса:
curl -X POST -H "X-Auth-Token: $token" -H "Content-Type: application/json" -d '{"backup_system": {"domain_id": "30b9a74c0cef4b7f820d106580b38d31", "hostname": "Some Name", "password": "HiddenPassword", "private_key":"MyPrivateKey"}}' http://controller:9363/v1/backup-systems/
Ответ
Параметры ответа:
Name In Type Description
id body string Идентификатор системы резервного копирования.
domain_id body string Идентификатор домена.
hostname body string Доменное имя системы резервного копирования.
backup_system body string Вид системы резервного копирования. Возможные значения: 0 - Bareos. По умолчанию: 0.

Пример результата в JSON формате:

{
    "backup_system": {
        "backup_system": 0,
        "domain_id": "30b9a74c0cef4b7f820d106580b38d31",
        "hostname": "Some Name",
        "id": 1
    }
}
GET
/v1/backup-systems/{backup_system_id}
Получение системы резервного копирования.

Получение информации о конкретной системе резервного копирования.

Запрос
Параметры запроса:
Name In Type Description
backup_system_id path string Идентификатор системы резервного копирования.
Пример запроса:
curl -X GET -H "X-Auth-Token: $token" http://controller:9363/v1/backup-systems/$backup_system_id | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
id body string Идентификатор системы резервного копирования.
domain_id body string Идентификатор домена.
hostname body string Доменное имя системы резервного копирования.
backup_system body string Вид системы резервного копирования. Возможные значения: 0 - Bareos. По умолчанию: 0.

Пример результата в JSON формате:

{
    "backup_system": {
        "backup_system": 0,
        "domain_id": "09434a2f76e248518acc5825dccb7921",
        "hostname": "Some Name",
        "id": 1
    }
}
PUT
/v1/backup-systems/{backup_system_id}
Обновление параметров системы резервного копирования.

Обновление значений параметров системы резервного копирования.

Запрос
Параметры запроса:
Name In Type Description
domain_id (Optional) body string Идентификатор домена.
hostname (Optional) body string Доменное имя системы резервного копирования.
password (Optional) body string Пароль для системы резервного копирования.
private_key (Optional) body string Ключ для обращения к системе резервного копирования.
backup_system body string Вид системы резервного копирования. Возможные значения: 0 - Bareos. По умолчанию: 0.
backup_system_id path string Идентификатор системы резервного копирования.
Пример запроса:
curl -X PUT -H "X-Auth-Token: $token" -H "Content-Type: application/json" -d '{"backup_system": {"hostname":"Some New Name"}}' http://controller:9363/v1/backup-systems/$backup_system_id | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
id body string Идентификатор системы резервного копирования.
domain_id body string Идентификатор домена.
hostname body string Доменное имя системы резервного копирования.
backup_system body string Вид системы резервного копирования. Возможные значения: 0 - Bareos. По умолчанию: 0.

Пример результата в JSON формате:

{
    "backup_system": {
        "backup_system": 0,
        "domain_id": "09434a2f76e248518acc5825dccb7921",
        "hostname": "Some New Name",
        "id": 1
    }
}
DELETE
/v1/backup-systems/{backup_system_id}
Удаление системы резервного копирования.

Удаление конкретной системы резервного копирования.

Запрос
Параметры запроса:
Name In Type Description
backup_system_id path string Идентификатор системы резервного копирования.
Пример запроса:
curl -X DELETE -H "X-Auth-Token: $token" http://controller:9363/v1/backup-systems/$backup_system_id

Эта операция не имеет содержания ответа.

GET
/v1/backup-systems/parameters
Получение параметров системы резервного копирования.

Получение параметров системы резервного копирования, назначенной на домен.

Запрос
Параметры запроса:
Name In Type Description
domain_id path string Идентификатор домена.
backup_system path string Вид системы резервного копирования. Возможные значения: 0 - Bareos. По умолчанию: 0.
Пример запроса:
curl -X GET -H "X-Auth-Token: $token" "http://controller:9363/v1/backup-systems/parameters?backup_system=$backup_system&domain_id=$backup_system" | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
job_defs body string Тип ресурса JobDefs для данного шаблона резервного копирования, предоставляет настройки по умолчанию для ресурса Job.
file_set body string Тип ресурса FileSet для данного шаблона резервного копирования, задаёт набор файлов, подлежащих резервному копированию.
schedule body string Тип ресурса Sсhedule для данного шаблона резервного копирования, задаёт расписание выполнения резервного копирования.

Пример результата в JSON формате:

{
    "file_set": [
        "Catalog",
        "LinuxAll",
        "LinuxHome",
        "SelfTest",
        "Windows All Drives"
    ],
    "job_defs": [
        "DefaultJob"
    ],
    "schedule": [
        "WeeklyCycleAfterBackup",
        "WeeklyCycle"
    ]
}
GET
/v1/backup-systems/director-name
Получение имени сервера резервного копирования.

Получение имени сервера резервного копирования, назначенного на домен.

Запрос
Параметры запроса:
Name In Type Description
domain_id path string Идентификатор домена.
backup_system path string Вид системы резервного копирования. Возможные значения: 0 - Bareos. По умолчанию: 0.
Пример запроса:
curl -X GET -H "X-Auth-Token: $token" "http://controller:9363/v1/backup-systems/director-name?backup_system=$backup_system&domain_id=$domain_id" | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
name body string Имя сервера резервного копирования.

Пример результата в JSON формате:

{
    "name": "bareos-dir"
}
POST
/v1/backup-templates/
Создание шаблона резервного копирования.

Создание шаблона резервного копирования. Доступно только для администратора домена.

Запрос
Параметры запроса:
Name In Type Description
domain_id (Optional) body integer Идентификатор домена, обязательный параметр при создании системы резервного копирования.
name (Optional) body string Имя шаблона резервного копирования. Если не указано при создании, будет сгенерировано автоматически.
description (Optional) body string Описание шаблона резервного копирования.
level (Optional) body integer

Уровень резервного копирования. Возможные значения:

  • 0 - Incremental (Инкрементный);
  • 1 - Differential (Дифференциальный);
  • 2 - Full (Полный).
job_defs (Optional) body string Тип ресурса JobDefs для данного шаблона резервного копирования, предоставляет настройки по умолчанию для ресурса Job.
file_set (Optional) body string Тип ресурса FileSet для данного шаблона резервного копирования, задаёт набор файлов, подлежащих резервному копированию.
schedule (Optional) body string Тип ресурса Sсhedule для данного шаблона резервного копирования, задаёт расписание выполнения резервного копирования.
Пример запроса:
curl -X POST -H "X-Auth-Token: $token" -H "Content-Type: application/json" -d '{"backup_template": {"domain_id": "3ace73b59639489e8ae0d3c42d6aa36d", "name": "template name", "description": "Backup template", "level": 0, "job_defs": "DefaultJob", "file_set": "Catalog", "schedule": "WeeklyCycle"}}' http://controller:9363/v1/backup-templates/ | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
id body integer Идентификатор шаблона резервного копирования.
domain_id body integer Идентификатор домена, обязательный параметр при создании системы резервного копирования.
name body string Имя шаблона резервного копирования. Если не указано при создании, будет сгенерировано автоматически.
description body string Описание шаблона резервного копирования.
level body integer

Уровень резервного копирования. Возможные значения:

  • 0 - Incremental (Инкрементный);
  • 1 - Differential (Дифференциальный);
  • 2 - Full (Полный).
job_defs body string Тип ресурса JobDefs для данного шаблона резервного копирования, предоставляет настройки по умолчанию для ресурса Job.
file_set body string Тип ресурса FileSet для данного шаблона резервного копирования, задаёт набор файлов, подлежащих резервному копированию.
schedule body string Тип ресурса Sсhedule для данного шаблона резервного копирования, задаёт расписание выполнения резервного копирования.

Пример результата в JSON формате:

{
    "backup_template": {
        "id": 1,
        "domain_id": "3ace73b59639489e8ae0d3c42d6aa36d",
        "name": "template name",
        "description": "Backup template",
        "level": 0,
        "job_defs": "DefaultJob",
        "file_set": "Catalog",
        "schedule": "WeeklyCycle"
    }
}
GET
/v1/backup-templates/
Получение списка шаблонов резервного копирования.

Получение списка шаблонов резервного копирования.

Запрос
Параметры запроса:
Name In Type Description
domain_id (Optional) path integer Идентификатор домена, обязательный параметр при создании системы резервного копирования.
name (Optional) path string Имя шаблона резервного копирования. Если не указано при создании, будет сгенерировано автоматически.
level (Optional) path integer

Уровень резервного копирования. Возможные значения:

  • 0 - Incremental (Инкрементный);
  • 1 - Differential (Дифференциальный);
  • 2 - Full (Полный).
job_defs (Optional) path string Тип ресурса JobDefs для данного шаблона резервного копирования, предоставляет настройки по умолчанию для ресурса Job.
file_set (Optional) path string Тип ресурса FileSet для данного шаблона резервного копирования, задаёт набор файлов, подлежащих резервному копированию.
schedule (Optional) path string Тип ресурса Sсhedule для данного шаблона резервного копирования, задаёт расписание выполнения резервного копирования.
Пример запроса:
curl -X GET -H "X-Auth-Token: $token" http://controller:9363/v1/backup-templates/ | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
id body integer Идентификатор шаблона резервного копирования.
domain_id body integer Идентификатор домена, обязательный параметр при создании системы резервного копирования.
name body string Имя шаблона резервного копирования. Если не указано при создании, будет сгенерировано автоматически.
description body string Описание шаблона резервного копирования.
level body integer

Уровень резервного копирования. Возможные значения:

  • 0 - Incremental (Инкрементный);
  • 1 - Differential (Дифференциальный);
  • 2 - Full (Полный).
job_defs body string Тип ресурса JobDefs для данного шаблона резервного копирования, предоставляет настройки по умолчанию для ресурса Job.
file_set body string Тип ресурса FileSet для данного шаблона резервного копирования, задаёт набор файлов, подлежащих резервному копированию.
schedule body string Тип ресурса Sсhedule для данного шаблона резервного копирования, задаёт расписание выполнения резервного копирования.
assigned_servers body list Список идентификаторов виртуальных машин, которым назначен шаблон.

Пример результата в JSON формате:

{
    "backup_templates": [
        {
            "id": 1,
            "domain_id": "3ace73b59639489e8ae0d3c42d6aa36d",
            "name": "template name",
            "description": "Backup template",
            "level": 0,
            "job_defs": "DefaultJob",
            "file_set": "Catalog",
            "schedule": "WeeklyCycle",
            "assigned_servers": [
                "e3ea2f73-907e-4c06-9e09-a172d85fd220",
                "a6ddf474-7bd6-4ea2-846a-8713abea6c4f"
            ]
        },
        {
            "id": 2,
            "domain_id": "5e9ee20b6ea347e9bc0d011d2ed2b0c1",
            "name": "template name 2",
            "description": "Backup template 2",
            "level": 1,
            "job_defs": "DefaultJob",
            "file_set": "LinuxAll",
            "schedule": "WeeklyCycleAfterBackup",
            "assigned_servers": [
                "6e8815c0-a872-4fe7-9a9a-83368e7fa545",
            ]
        }
    ]
}
GET
/v1/backup-templates/count
Получение количества записей о шаблонах резервного копирования.
Запрос
Параметры запроса:
Name In Type Description
domain_id (Optional) path integer Идентификатор домена, обязательный параметр при создании системы резервного копирования.
name (Optional) path string Имя шаблона резервного копирования. Если не указано при создании, будет сгенерировано автоматически.
level (Optional) path integer

Уровень резервного копирования. Возможные значения:

  • 0 - Incremental (Инкрементный);
  • 1 - Differential (Дифференциальный);
  • 2 - Full (Полный).
job_defs (Optional) path string Тип ресурса JobDefs для данного шаблона резервного копирования, предоставляет настройки по умолчанию для ресурса Job.
file_set (Optional) path string Тип ресурса FileSet для данного шаблона резервного копирования, задаёт набор файлов, подлежащих резервному копированию.
schedule (Optional) path string Тип ресурса Sсhedule для данного шаблона резервного копирования, задаёт расписание выполнения резервного копирования.
Пример запроса:
curl -X GET -H "X-Auth-Token: $token" http://controller:9363/v1/backup-templates/count | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
count body integer Количество объектов.

Пример результата в JSON формате:

{
    "count": 2
}
GET
/1/backup-templates/{template_id}
Получение шаблона резервного копирования.
Запрос
Параметры запроса:
Name In Type Description
template_id path integer Идентификатор шаблона резервного копирования.
Пример запроса:
curl -X GET -H "X-Auth-Token: $token" http://controller:9363/v1/backup-templates/{template_id} | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
id body integer Идентификатор шаблона резервного копирования.
domain_id body integer Идентификатор домена, обязательный параметр при создании системы резервного копирования.
name body string Имя шаблона резервного копирования. Если не указано при создании, будет сгенерировано автоматически.
description body string Описание шаблона резервного копирования.
level body integer

Уровень резервного копирования. Возможные значения:

  • 0 - Incremental (Инкрементный);
  • 1 - Differential (Дифференциальный);
  • 2 - Full (Полный).
job_defs body string Тип ресурса JobDefs для данного шаблона резервного копирования, предоставляет настройки по умолчанию для ресурса Job.
file_set body string Тип ресурса FileSet для данного шаблона резервного копирования, задаёт набор файлов, подлежащих резервному копированию.
schedule body string Тип ресурса Sсhedule для данного шаблона резервного копирования, задаёт расписание выполнения резервного копирования.
assigned_servers body list Список идентификаторов виртуальных машин, которым назначен шаблон.

Пример результата в JSON формате:

{
    "backup_template": {
        "id": 1,
        "domain_id": "3ace73b59639489e8ae0d3c42d6aa36d",
        "name": "template name",
        "description": "Backup template",
        "level": 0,
        "job_defs": "DefaultJob",
        "file_set": "Catalog",
        "schedule": "WeeklyCycle",
        "assigned_servers": [
            "e3ea2f73-907e-4c06-9e09-a172d85fd220",
            "a6ddf474-7bd6-4ea2-846a-8713abea6c4f"
        ]
    }
}
DELETE
/v1/backup-templates/{template_id}
Удаление шаблона резервного копирования.

Удаление конкретного шаблона резервного копирования.

Запрос
Параметры запроса:
Name In Type Description
template_id path integer Идентификатор шаблона резервного копирования.
Пример запроса:
curl -X DELETE -H "X-Auth-Token: $token" http://controller:9363/v1/backup-templates/$template_id

Эта операция не имеет содержания ответа.

GET
/v1/servers/{server_id}/backup-templates/
Получение списка шаблонов резервного копирования виртуальной машины.

Получение списка шаблонов резервного копирования виртуальной машины.

Запрос
Параметры запроса:
Name In Type Description
server_id path string Идентификатор виртуальной машины.
Пример запроса:
curl -X GET -H "X-Auth-Token: $token" http://controller:9363/v1/servers/$server_id/backup-templates/ | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
id body integer Идентификатор шаблона резервного копирования.
domain_id body integer Идентификатор домена, обязательный параметр при создании системы резервного копирования.
name body string Имя шаблона резервного копирования. Если не указано при создании, будет сгенерировано автоматически.
description body string Описание шаблона резервного копирования.
level body integer

Уровень резервного копирования. Возможные значения:

  • 0 - Incremental (Инкрементный);
  • 1 - Differential (Дифференциальный);
  • 2 - Full (Полный).
job_defs body string Тип ресурса JobDefs для данного шаблона резервного копирования, предоставляет настройки по умолчанию для ресурса Job.
file_set body string Тип ресурса FileSet для данного шаблона резервного копирования, задаёт набор файлов, подлежащих резервному копированию.
schedule body string Тип ресурса Sсhedule для данного шаблона резервного копирования, задаёт расписание выполнения резервного копирования.
assigned_servers body list Список идентификаторов виртуальных машин, которым назначен шаблон.

Пример результата в JSON формате:

{
    "backup_templates": [
        {
            "id": 1,
            "domain_id": "3ace73b59639489e8ae0d3c42d6aa36d",
            "name": "template name",
            "description": "Backup template",
            "level": 0,
            "job_defs": "DefaultJob",
            "file_set": "Catalog",
            "schedule": "WeeklyCycle",
            "assigned_servers": [
                "e3ea2f73-907e-4c06-9e09-a172d85fd220",
                "a6ddf474-7bd6-4ea2-846a-8713abea6c4f"
            ]
        }
    ]
}
POST
/v1/servers/{server_id}/actions/assign-backup-templates
Назначение шаблонов резервного копирования.

Назначение шаблонов резервного копирования виртуальной машине.

Запрос
Параметры запроса:
Name In Type Description
server_id path string Идентификатор виртуальной машины.
Пример запроса:
curl -X POST -H "X-Auth-Token: $token" -H "Content-Type: application/json" http://controller:9363/v1/servers/{server_id}/actions/assign-backup-templates -d '{"template_ids": [1]}'

Эта операция не имеет содержания ответа.

POST
/v1/servers/{server_id}/actions/unassign-backup-templates
Снятие назначения шаблонов резервного копирования.

Снятие назначения шаблонов резервного копирования виртуальной машины.

Запрос
Параметры запроса:
Name In Type Description
server_id path string Идентификатор виртуальной машины.
Пример запроса:
curl -X POST -H "X-Auth-Token: $token" -H "Content-Type: application/json" http://controller:9363/v1/servers/{server_id}/actions/unassign-backup-templates -d '{"template_ids": [1]}'

Эта операция не имеет содержания ответа.

Мониторинг

Управление мониторингом сети в системе Zabbix.

POST
/v1/zabbix/actions/setup_monitoring
Настройка аутентификации в системе мониторинга Zabbix.

Настройка аутентификации в Zabbix для указанного проекта или домена.

Запрос
Параметры запроса:
Name In Type Description
object_id path string Объект, для которого осуществляется настройка мониторинга. Если настройка осуществляется для проекта, то в качестве значения - ID проекта. Если настройка осуществляется для узлов, то в качестве значения - ID домена.
object_type path string Тип объекта, для которого осуществляется настройка мониторинга. Если настройка осуществляется для проекта, то в качестве значения - project. Если настройка осуществляется для узлов, то в качестве значения - domain.
zabbix_user_login path string Имя пользователя в службе мониторинга Zabbix.
zabbix_user_password path string Пароль пользователя в службе мониторинга Zabbix. Пароль хранится в зашифрованном виде.
Пример запроса:
curl -X POST -H "X-Auth-Token: $token" -H "Content-Type: application/json" -d '{"object_id": "5d421f16bb7a405799299d9cfb249748", "object_type": "project", "zabbix_user_login": "login", "zabbix_user_password": "password"}' http://controller:9363/v1/zabbix/actions/setup_monitoring

Эта операция не имеет содержания ответа.

GET
/v1/zabbix/templates/
Получение доступных шаблонов из системы мониторинга Zabbix.

Получение доступных шаблонов из группы узлов, определенной в конфигурационном файле.

Запрос
Параметры запроса:
Name In Type Description
object_id (Optional) path string Объект, для которого осуществляется настройка мониторинга. Если настройка осуществляется для проекта, то в качестве значения - ID проекта. Если настройка осуществляется для узлов, то в качестве значения - ID домена.
offset (Optional) path integer Номер позиции для получения данных.
limit (Optional) path integer Ограничение количества получаемых данных.
Пример запроса:
curl -X GET -H "X-Auth-Token: $token" -H "Content-Type: application/json" http://controller:9363/v1/zabbix/templates/?object_id=object_id | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
available (Optional) body string Доступность.
description (Optional) body string Подробное описание.
disable_until (Optional) body string Отключен до времени.
error (Optional) body string Сообщение ошибки.
errors_from (Optional) body string Источник ошибок.
flags (Optional) body string Установленные флаги.
host (Optional) body string Узел.
ipmi_authtype (Optional) body string Тип авторизации IPMI.
ipmi_available (Optional) body string Доступность IPMI.
ipmi_disable_until (Optional) body string IPMI отключен до времени.
ipmi_error (Optional) body string Ошибка IPMI.
ipmi_errors_from (Optional) body string Источник ошибок IPMI.
ipmi_password (Optional) body string Пароль IPMI.
ipmi_privilege (Optional) body string Привилегии IPMI.
ipmi_username (Optional) body string Имя пользователя IPMI.
jmx_available (Optional) body string Доступность JMX.
jmx_disable_until (Optional) body string JMX отключен до времени.
jmx_error (Optional) body string Ошибка JMX.
jmx_errors_from (Optional) body string Источник ошибок JMX.
lastaccess (Optional) body string Время последнего доступа.
maintenance_from (Optional) body string Источник поддержки.
maintenance_status (Optional) body string Статус поддержки.
maintenance_type (Optional) body string Тип поддержки.
maintenanceid (Optional) body string Идентификатор поддержки.
name (Optional) body string Имя шаблона резервного копирования.
proxy_hostid (Optional) body string Идентификатор прокси хоста.
snmp_available (Optional) body string Доступность SNMP.
snmp_disable_until (Optional) body string SNMP отключен до времени.
snmp_error (Optional) body string Ошибка SNMP.
snmp_errors_from (Optional) body string Источник ошибок SNMP.
status (Optional) body string Статус.
templateid (Optional) body string Идентификатор шаблона.
tls_accept (Optional) body string Принято.
tls_connect (Optional) body string Соединение.
tls_issuer (Optional) body string Провайдер.
tls_psk (Optional) body string Ключ.
tls_psk_identity (Optional) body string Идентичность ключа.
tls_subject (Optional) body string Субъект.

Пример получения информации о модуле в JSON формате:

{
    "templates": [
        {
            "available": "0",
            "description": "",
            "disable_until": "0",
            "error": "",
            "errors_from": "0",
            "flags": "0",
            "host": "HTTP.check",
            "ipmi_authtype": "0",
            "ipmi_available": "0",
            "ipmi_disable_until": "0",
            "ipmi_error": "",
            "ipmi_errors_from": "0",
            "ipmi_password": "",
            "ipmi_privilege": "2",
            "ipmi_username": "",
            "jmx_available": "0",
            "jmx_disable_until": "0",
            "jmx_error": "",
            "jmx_errors_from": "0",
            "lastaccess": "0",
            "maintenance_from": "0",
            "maintenance_status": "0",
            "maintenance_type": "0",
            "maintenanceid": "0",
            "name": "HTTP.check",
            "proxy_hostid": "0",
            "snmp_available": "0",
            "snmp_disable_until": "0",
            "snmp_error": "",
            "snmp_errors_from": "0",
            "status": "3",
            "templateid": "10105",
            "tls_accept": "1",
            "tls_connect": "1",
            "tls_issuer": "",
            "tls_psk": "",
            "tls_psk_identity": "",
            "tls_subject": ""
        }
    ]
}
POST
/v1/zabbix/hosts/
Создание узла сети в системе мониторинга Zabbix.

Создание узла сети в Zabbix для мониторинга виртуальной машины или гипервизора.

Запрос
Параметры запроса:
Name In Type Description
instance_id (Optional) body string Идентификатор виртуальной машины.
hostname (Optional) body string Имя узла.
templates (Optional) body list Список идентификаторов шаблонов для присоединения к узлу сети.
Пример запроса:
curl -X POST -H "X-Auth-Token: $token" -H "Content-Type: application/json" -d '{"host":{"instance_id": "a34fc37c-22d9-4f13-aba0-e84b7493dc5d", "templates": ["10093", "10102"]}}' http://controller:9363/v1/zabbix/hosts/ | python -m json.tool

Эта операция не имеет содержания ответа.

PUT
/v1/zabbix/hosts/{host_id}
Обновление узла сети в системе мониторинга Zabbix.

Обновление узла сети в Zabbix для мониторинга виртуальной машины или гипервизора.

Запрос
Параметры запроса:
Name In Type Description
host_id path string Идентификатор узла сети Zabbix.
templates body list Список идентификаторов шаблонов для присоединения к узлу сети.
Пример запроса:
curl -X PUT -H "X-Auth-Token: $token" -H "Content-Type: application/json" -d '{"host":{"templates": ["10093", "10102"]}}' http://controller:9363/v1/zabbix/hosts/$host_id | python -m json.tool

Эта операция не имеет содержания ответа.

GET
/v1/zabbix/hosts/{host_id}
Получение узла сети из системы мониторинга Zabbix.

Получение узла сети в Zabbix для мониторинга виртуальной машины или гипервизора.

Запрос
Параметры запроса:
Name In Type Description
host_id path string Идентификатор узла сети Zabbix.
Пример запроса:
curl -X GET -H "X-Auth-Token: $token" http://controller:9363/v1/zabbix/hosts/$host_id | python -m json.tool
Ответ
Параметры ответа:
Name In Type Description
host body string Узел.

Пример получения информации о модуле в JSON формате:

{
    "host": {
        "hostid": "10084",
        "parentTemplates": [
            {
                "name": "Template OS Linux",
                "templateid": "10001"
            },
            {
                "name": "Template App Zabbix Server",
                "templateid": "10047"
            }
        ]
    }
}
DELETE
/v1/zabbix/hosts/{host_id}
Удаление узла сети из системы мониторинга Zabbix.

Удаление узла сети в Zabbix для мониторинга виртуальной машины или гипервизора.

Запрос
Параметры запроса:
Name In Type Description
host_id path string Идентификатор узла сети Zabbix.
Пример запроса:
curl -X DELETE -H "X-Auth-Token: $token" -H "Content-Type: application/json" http://controller:9363/v1/zabbix/hosts/$host_id

Эта операция не имеет содержания ответа.

Подробное описание кодов ответа на запросы доступно во вкладке с дополнительной информацией.