# Протокол

## Оглавление

- [keyapis/vc/v1/keyapis_vc_monitoring_v1.proto](#keyapis_vc_v1_keyapis_vc_monitoring_v1-proto)
    - [MonitoringService](#keyapis-vc-v1-MonitoringService)
  
    - [CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge)
    - [CameraMonitoringBadge.AdditionalDataEntry](#keyapis-vc-v1-CameraMonitoringBadge-AdditionalDataEntry)
    - [GetMonitoringCompanyCameraRequest](#keyapis-vc-v1-GetMonitoringCompanyCameraRequest)
    - [GetMonitoringCompanyCameraResponse](#keyapis-vc-v1-GetMonitoringCompanyCameraResponse)
    - [GetMonitoringCompanyCameraResponse.Error](#keyapis-vc-v1-GetMonitoringCompanyCameraResponse-Error)
    - [MonitoringData](#keyapis-vc-v1-MonitoringData)
  


## [Схема классов](/svg/protos/key/keyapis/vc/v1/keyapis_vc_monitoring_v1.proto.svg)
<a href="/svg/protos/key/keyapis/vc/v1/keyapis_vc_monitoring_v1.proto.svg"><img src="/svg/protos/key/keyapis/vc/v1/keyapis_vc_monitoring_v1.proto.svg" alt="/svg/protos/key/keyapis/vc/v1/keyapis_vc_monitoring_v1.proto.svg" style="height:100%;"></a>




<a name="keyapis_vc_v1_keyapis_vc_monitoring_v1-proto"></a>

## [keyapis/vc/v1/keyapis_vc_monitoring_v1.proto](/protos/key/keyapis/vc/v1/keyapis_vc_monitoring_v1.proto)
Спецификация для получения данных мониторинга


<a name="keyapis-vc-v1-MonitoringService"></a>

### MonitoringService
 Сервис получения данных мониторинга

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-vc-v1-GetMonitoringCompanyCamera"></a> [GetMonitoringCompanyCamera](#keyapis-vc-v1-GetMonitoringCompanyCamera) | Метод получения данных мониторинга камеры. Метод доступен для: admin, service, bti | [keyapis.vc.v1.GetMonitoringCompanyCameraRequest](#keyapis-vc-v1-GetMonitoringCompanyCameraRequest) | [keyapis.vc.v1.GetMonitoringCompanyCameraResponse](#keyapis-vc-v1-GetMonitoringCompanyCameraResponse) |

 <!-- end services -->


<a name="keyapis-vc-v1-CameraMonitoringBadge"></a>


### [CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge)
 Бейдж данных мониторинга камеры


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-CameraMonitoringBadge-color"></a> [color](#keyapis-vc-v1-CameraMonitoringBadge-color) | Цвет |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraMonitoringBadge-title"></a> [title](#keyapis-vc-v1-CameraMonitoringBadge-title) | Наименование |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraMonitoringBadge-additional_data"></a> [additional_data](#keyapis-vc-v1-CameraMonitoringBadge-additional_data) | Дополнительные данные |  repeated  [keyapis.vc.v1.CameraMonitoringBadge.AdditionalDataEntry](#keyapis-vc-v1-CameraMonitoringBadge-AdditionalDataEntry) | <nil>|






<a name="keyapis-vc-v1-CameraMonitoringBadge-AdditionalDataEntry"></a>


### [CameraMonitoringBadge.AdditionalDataEntry](#keyapis-vc-v1-CameraMonitoringBadge-AdditionalDataEntry)
 


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-CameraMonitoringBadge-AdditionalDataEntry-key"></a> [key](#keyapis-vc-v1-CameraMonitoringBadge-AdditionalDataEntry-key) |  |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraMonitoringBadge-AdditionalDataEntry-value"></a> [value](#keyapis-vc-v1-CameraMonitoringBadge-AdditionalDataEntry-value) |  |    [string](#scalar-types) | <nil>|






<a name="keyapis-vc-v1-GetMonitoringCompanyCameraRequest"></a>


### [GetMonitoringCompanyCameraRequest](#keyapis-vc-v1-GetMonitoringCompanyCameraRequest)
 Запрос на получение данных мониторинга камеры


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetMonitoringCompanyCameraRequest-camera_uid"></a> [camera_uid](#keyapis-vc-v1-GetMonitoringCompanyCameraRequest-camera_uid) | uid видеопотока камеры |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-GetMonitoringCompanyCameraRequest-company_id"></a> [company_id](#keyapis-vc-v1-GetMonitoringCompanyCameraRequest-company_id) | Идентификатор компании. # Диапазон: 1..2147483647 |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-vc-v1-GetMonitoringCompanyCameraResponse"></a>


### [GetMonitoringCompanyCameraResponse](#keyapis-vc-v1-GetMonitoringCompanyCameraResponse)
 Ответ на запрос на получение данных мониторинга камеры


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetMonitoringCompanyCameraResponse-data"></a> [data](#keyapis-vc-v1-GetMonitoringCompanyCameraResponse-data) | Мониторинг камеры |  optional  [keyapis.vc.v1.MonitoringData](#keyapis-vc-v1-MonitoringData) | <nil>|
| <a id="keyapis-vc-v1-GetMonitoringCompanyCameraResponse-error"></a> [error](#keyapis-vc-v1-GetMonitoringCompanyCameraResponse-error) | Ошибка |  optional  [keyapis.vc.v1.GetMonitoringCompanyCameraResponse.Error](#keyapis-vc-v1-GetMonitoringCompanyCameraResponse-Error) | <nil>|






<a name="keyapis-vc-v1-GetMonitoringCompanyCameraResponse-Error"></a>


### [GetMonitoringCompanyCameraResponse.Error](#keyapis-vc-v1-GetMonitoringCompanyCameraResponse-Error)
 Ошибка запроса


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetMonitoringCompanyCameraResponse-Error-validation"></a> [validation](#keyapis-vc-v1-GetMonitoringCompanyCameraResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.vc.v1.ValidationError](#keyapis-vc-v1-ValidationError) | <nil>|






<a name="keyapis-vc-v1-MonitoringData"></a>


### [MonitoringData](#keyapis-vc-v1-MonitoringData)
 Мониторинг камеры


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-MonitoringData-camera_uid"></a> [camera_uid](#keyapis-vc-v1-MonitoringData-camera_uid) | uid видеопотока камеры |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-company_id"></a> [company_id](#keyapis-vc-v1-MonitoringData-company_id) | Идентификатор компании |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-is_channel_presence"></a> [is_channel_presence](#keyapis-vc-v1-MonitoringData-is_channel_presence) | Флаг наличия каналов |    [bool](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-data_center_name"></a> [data_center_name](#keyapis-vc-v1-MonitoringData-data_center_name) | Название дата-центра |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-vuf_status_badge"></a> [vuf_status_badge](#keyapis-vc-v1-MonitoringData-vuf_status_badge) | Бейдж состояния vuf |    [keyapis.vc.v1.CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-violet_status_badge"></a> [violet_status_badge](#keyapis-vc-v1-MonitoringData-violet_status_badge) | Бейдж состояния фиалки |    [keyapis.vc.v1.CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-violet_cameras_count_badge"></a> [violet_cameras_count_badge](#keyapis-vc-v1-MonitoringData-violet_cameras_count_badge) | Бейдж кол-ва камер фиалки |    [keyapis.vc.v1.CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-rose_status_badge"></a> [rose_status_badge](#keyapis-vc-v1-MonitoringData-rose_status_badge) | Бейдж кол-ва камер розы |    [keyapis.vc.v1.CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-rabbit_status_badge"></a> [rabbit_status_badge](#keyapis-vc-v1-MonitoringData-rabbit_status_badge) | Бейдж состояния RabbitMQ |    [keyapis.vc.v1.CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-vuf_camera_status_badge"></a> [vuf_camera_status_badge](#keyapis-vc-v1-MonitoringData-vuf_camera_status_badge) | Бейдж состояния камеры vuf |    [keyapis.vc.v1.CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-camera_receiving_status_badge"></a> [camera_receiving_status_badge](#keyapis-vc-v1-MonitoringData-camera_receiving_status_badge) | Бейдж приёма данных камеры |    [keyapis.vc.v1.CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-camera_streaming_status_badge"></a> [camera_streaming_status_badge](#keyapis-vc-v1-MonitoringData-camera_streaming_status_badge) | Бейдж трансляции данных камеры |    [keyapis.vc.v1.CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-camera_uptime_status_badge"></a> [camera_uptime_status_badge](#keyapis-vc-v1-MonitoringData-camera_uptime_status_badge) | Бейдж активного времени камеры |    [keyapis.vc.v1.CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-camera_uuc_status_badge"></a> [camera_uuc_status_badge](#keyapis-vc-v1-MonitoringData-camera_uuc_status_badge) | Бейдж состояния камеры пользователя |    [keyapis.vc.v1.CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-pg_status_badge"></a> [pg_status_badge](#keyapis-vc-v1-MonitoringData-pg_status_badge) | Бейдж состояния pg |    [keyapis.vc.v1.CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-redis_status_badge"></a> [redis_status_badge](#keyapis-vc-v1-MonitoringData-redis_status_badge) | Бейдж состояния redis |    [keyapis.vc.v1.CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-camera_online_badge"></a> [camera_online_badge](#keyapis-vc-v1-MonitoringData-camera_online_badge) | Бейдж онлайн состояния камеры |    [keyapis.vc.v1.CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge) | <nil>|
| <a id="keyapis-vc-v1-MonitoringData-channel_status_badge"></a> [channel_status_badge](#keyapis-vc-v1-MonitoringData-channel_status_badge) | Бейдж состояния канала камеры |    [keyapis.vc.v1.CameraMonitoringBadge](#keyapis-vc-v1-CameraMonitoringBadge) | <nil>|





 <!-- end messages -->

 <!-- end enums -->

 <!-- end HasExtensions -->



## Скалярные типы значений
<a id="scalar-types"></a>

| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
| ----------- | ---------- | ------ | -- | ---- | -- | --- | ---- | --- |
| [double](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float64 | Float | double | double | double | float |
| [float](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float32 | Float | float | float | float | float |
| [int32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [uint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| [sint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sfixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [bool](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean |
| [string](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| [bytes](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |