Протокол¶
Оглавление¶
Схема классов¶
deviceapis/device/v1/deviceapis_device_syslog_v1.proto¶
Сервис управления настройками Syslog-сервера
SyslogSettingsService¶
Сервис управления настройками Syslog-сервера
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| EditSyslogSettings | Метод редактирования настроек Syslog-сервера | deviceapis.device.v1.EditSyslogSettingsRequest | deviceapis.device.v1.EditSyslogSettingsResponse |
| GetSyslogSettings | Метод получения настроек Syslog-сервера | deviceapis.device.v1.GetSyslogSettingsRequest | deviceapis.device.v1.GetSyslogSettingsResponse |
EditSyslogSettingsRequest¶
Запрос редактирования настроек Syslog-сервера
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки Syslog-сервера | deviceapis.device.v1.SyslogSettings | REQUIRED |
| update_mask | Маска полей обновления | google.protobuf.FieldMask |
EditSyslogSettingsResponse¶
Ответ на запрос редактирования настроек Syslog-сервера
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки Syslog-сервера | optional deviceapis.device.v1.SyslogSettings | |
| error | Ошибка | optional deviceapis.device.v1.EditSyslogSettingsResponse.Error |
EditSyslogSettingsResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError |
GetSyslogSettingsRequest¶
Запрос получения настроек Syslog-сервера
GetSyslogSettingsResponse¶
Ответ на запрос получения настроек Syslog-сервера
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки Syslog-сервера | optional deviceapis.device.v1.SyslogSettings |
SyslogSettings¶
Настройки Syslog-сервера
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| protocol_type | Тип протокола | deviceapis.device.v1.SyslogSettings.ProtocolType | |
| address | Адрес Syslog-сервера. Сетевой адрес и порт. Пример: 192.168.0.1:514, syslog.acme.io:6514 | string | |
| log_level_type | Уровень логирования | deviceapis.device.v1.SyslogSettings.LogLevelType |
SyslogSettings.LogLevelType¶
Уровень логирования
| Номер | Тип | Название |
|---|---|---|
| 0 | LOG_LEVEL_TYPE_UNKNOWN | Значение не указано |
| 1 | EMERGENCY | Система не пригодна для использования |
| 2 | ALERT | Требуются немедленные меры |
| 3 | CRIT | Сообщение о критическом состоянии |
| 4 | ERROR | Сообщение об ошибочном состоянии |
| 5 | WARN | Предупреждение |
| 6 | NOTE | Сообщение о значительном нормальном событии |
| 7 | INFO | Информационное сообщение |
| 8 | DEBUG | Сообщение отладочного уровня |
SyslogSettings.ProtocolType¶
Тип протокола
| Номер | Тип | Название |
|---|---|---|
| 0 | PROTOCOL_TYPE_UNKNOWN | Значение не указано |
| 1 | UDP | Протокол UDP |
| 2 | TCP | Протокол TCP |
Скалярные типы значений¶
| .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 |