sg dashboards

Обзор

Предоставляет информацию с экземпляров роли sg.

Запросы

HTTP verb Endpoint Описание

GET

/rest/v1/master/logicalroles/sg/dashboards

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

GET

/rest/v1/master/logicalroles/sg/dashboards/info

Получение информации об экземплярах роли sg

GET

/rest/v1/master/logicalroles/sg/dashboards/sipusers

Получение информации о зарегистрированных пользователях в разрезе экземпляров ролей sg и доменов

GET

/rest/v1/master/logicalroles/sg/dashboards/regcount

Получение количества зарегистрированных пользователей в разрезе по экземплярам ролей sg

Общие скоуп-параметры запросов

Приведенные параметры используются в URL (?param=value) для ограничения скоупа применения запроса (состава экземпляров ролей, к которым применяется запрос). Все они являются опциональными и могут отсутствовать. Имеет смысл указывать не более одного из них, либо не указывать ни одного.

Table 1. Возможные параметры
Имя Тип Описание

site

str

Имя сайта из конфигурации.

Например SITE8.

sites

array<str>

Список имен сайтов, разделенных запятыми.

Например SITE1,SITE3.

server

str

Алиас сервера. Может быть IP адресом, номером или полным именем сервера из конфигурации.

Например 192.168.0.12 или 372.

servers

array<str>

Список алиасов серверов, разделенных запятыми.

Например 192.168.0.12,372,server05.

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

Запрос

Пример запроса
GET /rest/v1/master/logicalroles/sg/dashboards HTTP/1.1

Ответ

Возвращает список дашбордов роли sg и относительных URL для их получения.

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "name": "info",
    "_links": {
      "self": {
        "href": "/rest/v1/master/logicalroles/sg/dashboards/info",
        "params": []
      }
    }
  },
  {
    "name": "sipusers",
    "_links": {
      "self": {
        "href": "/rest/v1/master/logicalroles/sg/dashboards/sipusers",
        "params": []
      }
    }
  },
  {
    "name": "regcount",
    "_links": {
      "self": {
        "href": "/rest/v1/master/logicalroles/sg/dashboards/regcount",
        "params": []
      }
    }
  }
]

Получение информации об экземплярах роли sg

Предоставляет информацию обо всех экземплярах роли sg, входящих в скоуп запроса, указанный скоуп-параметрами в URL.

Запрос

URL может содержать скоуп-параметры.

Пример запроса
GET /rest/v1/master/logicalroles/sg/dashboards/info HTTP/1.1

Ответ

Возвращает список объектов, представляющих собой серверы/ноды, каждая из которых содержит экземпляр роли sg.

Table 2. Поля объекта
Поле Описание

site

Название сайта.

srvidx

Числовой идентификатор этой ноды (roleid из конфигурации).

node

Название этой ноды.

online

Признак доступности этой ноды с веб-сервера, исполняющего API-запрос.

addr

IP-адрес роли esg в этой ноде. Указывается только если нода доступна.

load

Объект, представляющий собой количество обработанных SIP-запросов основных типов.

Поля объекта:

  • count_all_req – информация о количестве всех запросов.

  • count_invite – информация о количестве запросов INVITE.

  • count_notify – информация о количестве запросов NOTIFY.

  • count_register – информация о количестве запросов REGISTER.

  • count_subscribe – информация о количестве запросов SUBSCRIBE.

Значение каждого из перечисленных полей содержит количество обработанных запросов за последнюю секунду (seq1) и за 20 последних секунд (seq20).

Указывается для доступных нод.
Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "site": "SITE1",
    "srvidx": 7,
    "node": "site1_h7@192.168.0.10",
    "addr": "192.168.0.10",
    "online": true,
    "load": {
      "count_all_req": {
        "sec1": 0,
        "sec20": 12
      },
      "count_invite": {
        "sec1": 0,
        "sec20": 0
      },
      "count_notify": {
        "sec1": 0,
        "sec20": 4
      },
      "count_register": {
        "sec1": 0,
        "sec20": 3
      },
      "count_subscribe": {
        "sec1": 0,
        "sec20": 4
      }
    }
  },
  {
    "site": "SITE1",
    "srvidx": 4,
    "node": "site1_h4@192.168.0.10",
    "addr": "192.168.0.10",
    "online": true,
    "load": {
      "count_all_req": {
        "sec1": 1,
        "sec20": 0
      },
      "count_invite": {
        "sec1": 0,
        "sec20": 0
      },
      "count_notify": {
        "sec1": 0,
        "sec20": 0
      },
      "count_register": {
        "sec1": 1,
        "sec20": 0
      },
      "count_subscribe": {
        "sec1": 0,
        "sec20": 0
      }
    }
  },
  {
    "site": "SITE2",
    "srvidx": 104,
    "node": "site2_h4@192.168.0.10",
    "addr": "192.168.0.10",
    "online": false
  }
]

Получение информации о зарегистрированных пользователях в разрезе экземпляров ролей sg и доменов

Возвращает информацию о составе зарегистрированных учетных записей SIP-пользователей. Информация возвращается с экземпляров ролей sg, входящих в скоуп запроса, указанный скоуп-параметрами в URL.

Экземпляр роли sg, обслуживший запрос REGISTER оказывается в маршруте обслуживания прочих запросов, поступающих как с SIP-устройства, так и на SIP устройство.

Запрос

URL может содержать скоуп-параметры.

Пример запроса
GET /rest/v1/master/master/logicalroles/sg/dashboards/sipusers?site=SITE1 HTTP/1.1

Ответ

Возвращает объект с информацией о составе сайтов, серверов, доменов и зарегистрированных через них учетных записей SIP-пользователей.

Table 3. Структура объекта результата
Уровень Поле Описание

root

sites

Список сайтов, содержащих согласно конфигурации экземпляры ролей esg. Каждый сайт представлен в виде объекта.

site

site

Название сайта.

site

gates

Список нод на этом сайте, где выполняется экземпляр роли sg. Каждая нода представлена в виде объекта.

gate

srvidx

Числовой идентификатор этой ноды (roleid из конфигурации).

gate

node

Название этой ноды.

gate

ports

Список портов экземпляра роли sg, выполняемого на этой ноде. Каждый порт представлен в виде объекта.

port

port

Локальный порт экземпляра роли sg.

port

domains

Список доменов, имеющих регистрации на этом порте/ноде/сайте. Каждый домен представлен в виде объекта.

domain

domain

Имя домена.

domain

regs

Список регистраций учетных записей SIP-пользователей этого домена, обслуженных на этом порте/ноде/сайте.

Каждое значение в списке имеет формат контактного URI: proto:username@device_address:device_port.

Одна учетная запись может иметь несколько регистраций.
Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "sites": [
    {
      "site": "SITE1",
      "gates": [
        {
          "srvidx": 4,
          "node": "site1_h4@192.168.0.10",
          "ports": [
            {
              "port": 5060,
              "domains": [
                {
                  "domain": "test.rootdomain.ru",
                  "regs": [
                    "udp:sip3@192.168.0.203:5062",
                    "udp:sip6@192.168.0.200:5060"
                  ]
                }
              ]
            }
          ]
        },
        {
          "srvidx": 7,
          "node": "site1_h7@192.168.0.10",
          "ports": []
        }
      ]
    }
  ]
}

Получение количества зарегистрированных пользователей в разрезе по экземплярам ролей sg

Возвращает информацию о количестве зарегистрированных учетных записей SIP-пользователей. Информация возвращается с экземпляров ролей sg, входящих в скоуп запроса, указанный скоуп-параметрами в URL.

Экземпляр роли sg, обслуживший запрос REGISTER оказывается в маршруте обслуживания прочих запросов, поступающих как с SIP-устройства, так и на SIP устройство.

Запрос

URL может содержать скоуп-параметры.

Пример запроса
GET /rest/v1/master/logicalroles/sg/dashboards/regcount HTTP/1.1

Ответ

Возвращает объект с информацией о составе сайтов, серверов и количестве зарегистрированных через них учетных записей SIP-пользователей.

Table 4. Структура объекта результата
Уровень Поле Описание

root

sites

Список сайтов, содержащих согласно конфигурации экземпляры ролей esg. Каждый сайт представлен в виде объекта.

site

site

Название сайта.

site

gates

Список нод на этом сайте, где выполняется экземпляр роли sg. Каждая нода представлена в виде объекта.

gate

srvidx

Числовой идентификатор этой ноды (roleid из конфигурации).

gate

node

Название этой ноды.

gate

ports

Список портов экземпляра роли sg, выполняемого на этой ноде. Каждый порт представлен в виде объекта.

port

port

Локальный порт экземпляра роли sg.

port

regcount

Количество регистраций учетных записей SIP-пользователей, обслуженных на этом порте/ноде/сайте.

Одна учетная запись может иметь несколько регистраций.
Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "sites": [
    {
      "site": "SITE1",
      "gates": [
        {
          "srvidx": 4,
          "node": "site1_h4@192.168.0.10",
          "ports": [
            {
              "port": 5060,
              "regcount": 2
            }
          ]
        },
        {
          "srvidx": 7,
          "node": "site1_h7@192.168.0.10",
          "ports": []
        }
      ]
    },
    {
      "site": "SITE2",
      "gates": [
        {
          "srvidx": 104,
          "node": "site2_h4@192.168.0.10",
          "ports": []
        }
      ]
    }
  ]
}

См. также

  • Персонализация
  • Увеличить шрифт
  • Уменьшить шрифт