Протокол¶
Оглавление¶
Схема классов¶
keyapis/telemetry_status/v1/keyapis_telemetry_status_device_v1.proto¶
Сервис реализует функционал опроса статусов сетевой доступности устройств
DeviceStatusService¶
Сервис опроса статусов сетевой доступности устройств. Авторизация: - Authorization: Bearer token. - X-Api-Key: apiKey
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| GetDeviceStatusList | Метод получения списка статусов доступности устройств. Метод доступен для: Token: service, admin. Без учета разрешений. Метод доступен для: ApiKey: Разрешения: telemetry_status:device_status:list | keyapis.telemetry_status.v1.GetDeviceStatusListRequest | keyapis.telemetry_status.v1.GetDeviceStatusListResponse stream |
| GetDeviceStatusCount | Метод получения количества статусов доступности устройств. Метод доступен для: Token: service, admin. Без учета разрешений. Метод доступен для: ApiKey: Разрешения: telemetry_status:device_status:list | keyapis.telemetry_status.v1.GetDeviceStatusCountRequest | keyapis.telemetry_status.v1.GetDeviceStatusCountResponse |
DeviceStatus¶
Статус доступности устройства
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| device_id | Идентификатор устройства | int32 | REQUIRED |
| ip | IP-адрес устройства | string | OUTPUT_ONLY |
| checked_at | Момент проверки статуса | google.protobuf.Timestamp | OUTPUT_ONLY |
| status_type | Тип статуса | keyapis.telemetry_status.v1.DeviceStatus.StatusType | OUTPUT_ONLY |
DeviceStatusFilter¶
Фильтр для запроса статусов доступности устройств. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ. При передаче нескольких разных параметров фильтра они работают в выборке через И
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| device_ids | По списку приборов учета | repeated int32 | |
| status_types | По cтатусам доступности | repeated keyapis.telemetry_status.v1.DeviceStatus.StatusType |
DeviceStatusPaging¶
Пагинация статусов сетевой доступности
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| order_by_type | Тип значения сортировки. По умолчанию: CHECKED_AT | keyapis.telemetry_status.v1.DeviceStatusPaging.OrderByType | |
| direction_type | Тип направления сортировки. По умолчанию: DESC | keyapis.telemetry_status.v1.DeviceStatusPaging.DirectionType | |
| limit | Количество записей на страницу. Минимальное значение: 1. Максимальное значение: 100. По умолчанию: 20. Если значение 0 (не передано), то выставляем значение по умолчанию | int32 | |
| offset | Сдвиг. По умолчанию: 0 | int32 |
GetDeviceStatusCountRequest¶
Запрос получения количества записей
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.telemetry_status.v1.DeviceStatusFilter |
GetDeviceStatusCountResponse¶
Ответ на запрос получения количества записей
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего записей | optional int32 |
GetDeviceStatusListRequest¶
Запрос получения списка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.telemetry_status.v1.DeviceStatusFilter | |
| paging | Пагинация | optional keyapis.telemetry_status.v1.DeviceStatusPaging |
GetDeviceStatusListResponse¶
Ответ на запрос получения списка статусов доступности устройств
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Статус доступности устройства | optional keyapis.telemetry_status.v1.DeviceStatus |
DeviceStatus.StatusType¶
Справочник типов статусов
| Номер | Тип | Название |
|---|---|---|
| 0 | STATUS_TYPE_UNKNOWN | Значение не указано. Проверка доступности не выполнялась |
| 1 | OFFLINE | Не доступен |
| 2 | ONLINE | Доступен |
DeviceStatusPaging.DirectionType¶
Справочник типов направлений сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | DIRECTION_TYPE_UNKNOWN | Значение не указано |
| 1 | DESC | От большего к меньшему |
| 2 | ASC | От меньшего к большему |
DeviceStatusPaging.OrderByType¶
Справочник типов значений сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | ORDER_BY_TYPE_UNKNOWN | Значение не указано |
| 1 | CHECKED_AT | По дате проверки |
| 2 | DEVICE_ID | По идентификатору |
Скалярные типы значений¶
| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
|---|---|---|---|---|---|---|---|---|
| double | float | float64 | Float | double | double | double | float | |
| float | float | float32 | Float | float | float | float | float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| uint32 | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| uint64 | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | int | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | int/long | uint64 | Bignum | ulong | uint64 | long | integer/string |
| sfixed32 | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| sfixed64 | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| bool | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| bytes | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |