Package spectrum.sas.portal.v1alpha1

Индекс

Клиенты

Служба управления клиентами SAS.

ПолучитьКлиент

rpc GetCustomer( GetCustomerRequest ) returns ( Customer )

Возвращает запрошенный customer .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
СписокКлиентов

rpc ListCustomers( ListCustomersRequest ) returns ( ListCustomersResponse )

Возвращает список запрошенных customers .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
ОбновлениеКлиент

rpc UpdateCustomer( UpdateCustomerRequest ) returns ( Customer )

Обновляет существующего customer .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email

Диспетчер устройств

Служба управления устройствами Citizens Broadband Radio Service.

СоздатьРазвертывание

rpc CreateDeployment( CreateDeploymentRequest ) returns ( Deployment )

Создает новое deployment .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Создатьустройство

rpc CreateDevice( CreateDeviceRequest ) returns ( Device )

Создает device под node или customer .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Создать узел

rpc CreateNode( CreateNodeRequest ) returns ( Node )

Создает новый node .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
CreateSignedDevice

rpc CreateSignedDevice( CreateSignedDeviceRequest ) returns ( Device )

Создает подписанное device под node или customer .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Удалить развертывание

rpc DeleteDeployment( DeleteDeploymentRequest ) returns ( Empty )

Удаляет deployment .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Удалить Устройство

rpc DeleteDevice( DeleteDeviceRequest ) returns ( Empty )

Удаляет device .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
УдалитьУзел

rpc DeleteNode( DeleteNodeRequest ) returns ( Empty )

Удаляет node .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Генерировать секрет

rpc GenerateSecret( GenerateSecretRequest ) returns ( GenerateSecretResponse )

Создает секрет для использования с ValidateInstaller .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
GetDeployment

rpc GetDeployment( GetDeploymentRequest ) returns ( Deployment )

Возвращает запрошенное deployment .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
GetDevice

rpc GetDevice( GetDeviceRequest ) returns ( Device )

Получает сведения об device .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
ПолучитьУзел

rpc GetNode( GetNodeRequest ) returns ( Node )

Возвращает запрошенный node .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
ListDeployments

rpc ListDeployments( ListDeploymentsRequest ) returns ( ListDeploymentsResponse )

Списки deployments .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
СписокУстройств

rpc ListDevices( ListDevicesRequest ) returns ( ListDevicesResponse )

Список devices под node или customer .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
ListNodes

rpc ListNodes( ListNodesRequest ) returns ( ListNodesResponse )

Перечисляет nodes .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
MoveDeployment

rpc MoveDeployment( MoveDeploymentRequest ) returns ( Operation )

Перемещает deployment под другой node или customer .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
MoveDevice

rpc MoveDevice( MoveDeviceRequest ) returns ( Operation )

Перемещает device под другой node или customer .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Переместить узел

rpc MoveNode( MoveNodeRequest ) returns ( Operation )

Перемещает node под другой node или customer .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Знак Устройство

rpc SignDevice( SignDeviceRequest ) returns ( Empty )

Подписывает device .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Обновить развертывание

rpc UpdateDeployment( UpdateDeploymentRequest ) returns ( Deployment )

Обновляет существующее deployment .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Обновитьустройство

rpc UpdateDevice( UpdateDeviceRequest ) returns ( Device )

Обновляет device .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Узел обновления

rpc UpdateNode( UpdateNodeRequest ) returns ( Node )

Обновляет существующий node .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Обновить подписанное устройство

rpc UpdateSignedDevice( UpdateSignedDeviceRequest ) returns ( Device )

Обновляет подписанное device .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Проверитьустановщик

rpc ValidateInstaller( ValidateInstallerRequest ) returns ( ValidateInstallerResponse )

Проверяет подлинность сертифицированного профессионального установщика (CPI).

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email

ПолитикаСервис

Служба контроля доступа к Spectrum Resource Manager.

GetPolicy

rpc GetPolicy( GetPolicyRequest ) returns ( Policy )

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

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
СетПолици

rpc SetPolicy( SetPolicyRequest ) returns ( Policy )

Задает политику управления доступом к указанному ресурсу. Заменяет любую существующую политику.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Тестовые разрешения

rpc TestPermissions( TestPermissionsRequest ) returns ( TestPermissionsResponse )

Возвращает разрешения, которые вызывающая сторона имеет для указанного ресурса.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/userinfo.email

Назначение

Связывает members с role .

Поля
role

string

Необходимый. Роли, назначенные members .

members[]

string

Удостоверения, которым назначена роль. Он может иметь следующие значения:

  • {user_email} : адрес электронной почты, представляющий конкретную учетную запись Google. Например: alice@gmail.com .

  • {group_email} : адрес электронной почты, представляющий группу Google. Например, viewers@gmail.com .

BillingMode

Режим выставления счетов CBSD

перечисления
BILLING_MODE_UNSPECIFIED Режим выставления счетов не указан.
MOBILE Цена основана на категории CBSD: Категория A, Категория B, зарегистрированная в SAS.
FIXED_WIRELESS Цена зависит от типа CBSD: базовая станция или CPE.

Тип канала

перечисления
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

CreateDeploymentRequest

Запрос CreateDeployment .

Поля
parent

string

Необходимый. Имя родительского ресурса, в котором должно быть создано развертывание.

deployment

Deployment

Необходимый. Детали развертывания. name должно быть пустым. Он генерируется сервером. display_name быть установлено отображаемое_имя развертывания.

CreateDeviceRequest

Запрос CreateDevice .

Поля
parent

string

Необходимый. Имя родительского ресурса.

device

Device

Детали регистрации device . name должно быть пустым. Он генерируется сервером. Поля device fcc_id и serial_number должны быть установлены. Поле user_id должно быть установлено.

CreateNodeRequest

Запрос на CreateNode .

Поля
parent

string

Необходимый. Имя родительского ресурса, в котором должен быть создан узел.

node

Node

Детали узла. name должно быть пустым. Он генерируется сервером. Узел display_name должен быть установлен.

CreateSignedDeviceRequest

Запрос CreateSignedDevice .

Поля
parent

string

Необходимый. Имя родительского ресурса.

encoded_device

bytes

Необходимый. Веб-токен JSON, подписанный с использованием закрытого ключа CPI. Полезная нагрузка должна представлять собой кодировку JSON device . Поле user_id должно быть установлено.

installer_id

string

Необходимый. Уникальный идентификатор установщика (CPI ID) из базы данных сертифицированных профессиональных установщиков.

Покупатель

Организация, представляющая клиента SAS.

Поля
name

string

Только вывод. Имя ресурса клиента.

display_name

string

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

sas_user_ids[]

string

Идентификаторы пользователей, используемые устройствами, принадлежащими этому клиенту.

УдалитьДеплойментРекуест

Запрос на DeleteDeployment .

Поля
name

string

Необходимый. Имя deployment .

УдалитьДевайцерекуест

Запрос на DeleteDevice .

Поля
name

string

Необходимый. Имя устройства.

УдалитьНодерекуест

Запрос на DeleteNode .

Поля
name

string

Необходимый. Имя node .

Развертывание

Развертывание.

Поля
name

string

Только вывод. Имя ресурса.

display_name

string

Отображаемое имя развертывания.

sas_user_ids[]

string

Идентификатор пользователя, используемый устройствами, принадлежащими этому развертыванию. Каждое развертывание должно быть связано с одним уникальным идентификатором пользователя.

default_billing_mode

BillingMode

Режим выставления счетов по умолчанию для развертывания и устройств под ним.

allowed_billing_modes[]

BillingMode

Разрешенные режимы выставления счетов в этом развертывании.

Устройство

Поля
name

string

Только вывод. Путь к ресурсу.

fcc_id

string

Идентификатор FCC устройства.

serial_number

string

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

preloaded_config

DeviceConfig

Конфигурация устройства, как указано через SAS Portal API.

active_config

DeviceConfig

Только вывод. Текущая конфигурация устройства, зарегистрированного в SAS.

state

State

Только вывод. Состояние устройства.

grants[]

DeviceGrant

Только вывод. Гранты, удерживаемые устройством.

display_name

string

Отображаемое имя устройства.

device_metadata

DeviceMetadata

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

Состояние

Состояние устройства.

перечисления
DEVICE_STATE_UNSPECIFIED Неопределенное состояние.
RESERVED Устройство создано на портале SAS, но еще не зарегистрировано в SAS.
REGISTERED Устройство зарегистрировано в SAS.
DEREGISTERED Регистрация устройства отменена в SAS.

DeviceAirИнтерфейс

Информация о радиоинтерфейсе устройства.

Поля
radio_technology

RadioTechnology

Условный. В этом поле указывается технология радиодоступа, используемая для CBSD.

supported_spec

string

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

Радиотехнологии

Утвержденные типы технологии радиодоступа.

перечисления
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

Категория устройства

Категория FCC устройства, как определено в Части 96.

перечисления
DEVICE_CATEGORY_UNSPECIFIED Неуказанная категория устройства.
DEVICE_CATEGORY_A Категория А.
DEVICE_CATEGORY_B Категория Б.

Конфигурация устройства

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

Поля
category

DeviceCategory

Категория FCC устройства.

model

DeviceModel

Информация об этой модели устройства.

air_interface

DeviceAirInterface

Информация о радиоинтерфейсе этого устройства.

installation_params

InstallationParams

Параметры установки устройства.

measurement_capabilities[]

MeasurementCapability

Возможности отчета об измерениях устройства.

user_id

StringValue

Идентификатор пользователя устройства.

call_sign

string

Позывной оператора устройства.

state

State

Состояние конфигурации.

is_signed

BoolValue

Только вывод. Была ли конфигурация подписана CPI.

update_time

Timestamp

Только вывод. Время последнего редактирования конфигурации устройства.

Состояние

Состояние конфигурации устройства. Во время регистрации CBSD можно использовать только конфиги в состоянии DEVICE_CONFIG_STATE_FINAL .

перечисления
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

ДевайсГрант

Грант устройства. Это разрешение, предоставляемое системой доступа к спектру устройству для передачи с использованием заданных рабочих параметров после успешного подтверждения устройства.

Поля
max_eirp

DoubleValue

Максимальная эквивалентная изотропно излучаемая мощность (EIRP), разрешенная грантом. Максимальная EIRP выражается в дБм/МГц. Значение maxEirp представляет собой среднеквадратичное значение EIRP, которое можно измерить с помощью процедуры, определенной в части 96.41(e)(3) FCC.

frequency_range

FrequencyRange

Диапазон частот передачи.

state

GrantState

Состояние гранта.

channel_type

ChannelType

Тип используемого канала.

move_list[]

DpaMoveList

Списки перемещений DPA, в которых появляется этот грант.

expire_time

Timestamp

Срок действия гранта.

suspension_reason[]

string

Если предоставление гранта приостановлено, укажите причину (причины) приостановления.

grant_id

string

Идентификатор гранта.

Метаданные устройства

Данные устройства могут быть переопределены как порталом SAS, так и запросами на регистрацию.

Модель устройства

Информация о модели устройства.

Поля
vendor

string

Имя производителя устройства.

name

string

Название модели устройства.

software_version

string

Версия программного обеспечения устройства.

hardware_version

string

Аппаратная версия устройства.

firmware_version

string

Версия прошивки устройства.

Дпамовелист

Запись в списке перемещений DPA.

Поля
dpa_id

StringValue

Идентификатор DPA.

frequency_range

FrequencyRange

Диапазон частот, на который влияет список перемещений.

Диапазон частот

Диапазон частот от low_frequency до high_frequency .

Поля
low_frequency_mhz

DoubleValue

Самая низкая частота частотного диапазона в МГц.

high_frequency_mhz

DoubleValue

Самая высокая частота частотного диапазона в МГц.

генерировать секретрекуест

Запрос на GenerateSecret .

Генерировать секретответ

Ответ для GenerateSecret .

Поля
secret

string

Секрет, сгенерированный строкой и используемый ValidateInstaller .

GetCustomerRequest

Запрос GetCustomer .

Поля
name

string

Необходимый. Имя customer .

GetDeploymentRequest

Запрос GetDeployment .

Поля
name

string

Необходимый. Имя deployment .

GetDeviceRequest

Запрос GetDevice .

Поля
name

string

Необходимый. Имя устройства.

GetNodeRequest

Запрос GetNode .

Поля
name

string

Необходимый. Имя node .

GetPolicyRequest

Сообщение запроса для метода GetPolicy .

Поля
resource

string

Необходимый. Ресурс, для которого запрашивается политика.

ГрантСтейт

Состояние гранта.

перечисления
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED Грант был предоставлен, но устройство на нем не бьется.
GRANT_STATE_TERMINATED Грант был прекращен SAS.
GRANT_STATE_SUSPENDED Грант был приостановлен SAS.
GRANT_STATE_AUTHORIZED В настоящее время устройство передает.
GRANT_STATE_EXPIRED Грант истек.

Тип высоты

Указывает, как измеряется высота.

перечисления
HEIGHT_TYPE_UNSPECIFIED Неопределенный тип высоты.
HEIGHT_TYPE_AGL Высота AGL измеряется относительно уровня земли.
HEIGHT_TYPE_AMSL Высота над уровнем моря измеряется относительно среднего уровня моря.

Параметры установки

Информация о параметрах установки устройства.

Поля
latitude

DoubleValue

Широта расположения антенны устройства в градусах относительно системы отсчета WGS 84. Допустимый диапазон: от -90,000000 до +90,000000. Положительные значения представляют широты к северу от экватора; отрицательные значения к югу от экватора.

longitude

DoubleValue

Долгота местоположения антенны устройства в градусах относительно системы отсчета WGS 84. Допустимый диапазон от -180.000000 до +180.000000. Положительные значения представляют долготу к востоку от нулевого меридиана; отрицательные значения к западу от нулевого меридиана.

height

DoubleValue

Высота антенны устройства в метрах. Когда значением параметра heightType является "AGL", высота антенны должна быть указана относительно уровня земли. Когда значением параметра heightType является «AMSL», оно задается относительно системы отсчета WGS84.

height_type

HeightType

Указывает, как измеряется высота.

horizontal_accuracy

DoubleValue

Положительное число в метрах, указывающее на точность горизонтального положения антенны устройства. Этот необязательный параметр должен присутствовать только в том случае, если его значение меньше требования FCC, равного 50 метрам.

vertical_accuracy

DoubleValue

Положительное число в метрах, указывающее на точность вертикального положения антенны устройства. Этот необязательный параметр должен присутствовать только в том случае, если его значение меньше, чем требование FCC, равное 3 метрам.

indoor_deployment

BoolValue

Находится ли антенна устройства в помещении или нет. true : в помещении. false : на открытом воздухе.

antenna_azimuth

Int32Value

Направление визирования горизонтальной плоскости антенны в градусах относительно истинного севера. Значение этого параметра — целое число от 0 до 359 включительно. Значение 0 градусов означает истинный север; значение 90 градусов означает восток. Этот параметр является необязательным для устройств категории A и условным для устройств категории B.

antenna_downtilt

Int32Value

Наклон антенны вниз в градусах и представляет собой целое число со значением от -90 до +90 включительно; отрицательное значение означает, что антенна наклонена вверх (выше горизонтали). Этот параметр является необязательным для устройств категории A и условным для устройств категории B.

antenna_gain

Int32Value

Пиковое усиление антенны в дБи. Этот параметр представляет собой целое число со значением от -127 до +128 (дБи) включительно.

eirp_capability

Int32Value

Этот параметр представляет собой максимальную э.и.и.м. устройства в дБм/10 МГц и представляет собой целое число со значением от -127 до +47 (дБм/10 МГц) включительно. Если он не указан, SAS интерпретирует его как максимально допустимую э.и.и.м. в единицах дБм/10 МГц для категории устройств.

antenna_beamwidth

Int32Value

Ширина луча антенны по уровню 3 дБ в горизонтальной плоскости в градусах. Этот параметр представляет собой целое число без знака, имеющее значение от 0 до 360 (градусов) включительно; это необязательно для устройств категории A и условно для устройств категории B.

antenna_model

string

Если используется внешняя антенна, в этом поле дополнительно указывается модель антенны. Строка имеет максимальную длину 128 октетов.

cpe_cbsd_indication

BoolValue

Если он присутствует, этот параметр указывает, является ли CBSD CPE-CBSD или нет.

СписокКлиентовЗапрос

Запрос для ListCustomers .

Поля
page_size

int32

Максимальное количество customers , чтобы вернуться в ответ.

page_token

string

Маркер разбивки на страницы, возвращенный из предыдущего вызова ListCustomers , указывает, с чего следует продолжить этот список.

СписокКлиентовОтвет

Ответ для ListCustomers .

Поля
customers[]

Customer

Список customers , соответствующих запросу.

next_page_token

string

Маркер разбивки на страницы, возвращенный из предыдущего вызова ListCustomers , указывает, с чего следует продолжить листинг. Если поле отсутствует или пустое, значит клиентов больше нет.

ListDeploymentsRequest

Запрос ListDeployments .

Поля
parent

string

Необходимый. Имя родительского ресурса, например, "nodes/1", customer/1/nodes/2.

page_size

int32

Максимальное количество развертываний, возвращаемых в ответе.

page_token

string

Маркер разбивки на страницы, возвращенный из предыдущего вызова ListDeployments , указывает, откуда следует продолжить этот список.

filter

string

Выражение фильтра. Фильтр должен иметь следующий формат: "DIRECT_CHILDREN" или формат: "direct_children". Фильтр нечувствителен к регистру. Если пусто, развертывания не фильтруются.

ListDeploymentsResponse

Ответ для ListDeployments .

Поля
deployments[]

Deployment

deployments , соответствующие запросу.

next_page_token

string

Маркер разбиения на страницы, возвращенный из предыдущего вызова ListDeployments , который указывает, откуда следует продолжить листинг. Если поле отсутствует или пусто, это означает, что развертываний больше нет.

СписокУстройствЗапрос

Запрос ListDevices .

Поля
parent

string

Необходимый. Имя родительского ресурса.

page_size

int32

Максимальное количество устройств, возвращаемых в ответе. Если пусто или ноль, будут перечислены все устройства. Должно быть в диапазоне [0, 1000].

page_token

string

Маркер разбивки на страницы, возвращенный из предыдущего вызова ListDevices , указывает, с чего следует продолжить этот список.

filter

string

Выражение фильтра. Фильтр должен иметь один из следующих форматов: "sn=123454" или "display_name=MyDevice". sn соответствует серийному номеру устройства. Фильтр нечувствителен к регистру.

ListDevicesResponse

Ответ для ListDevices .

Поля
devices[]

Device

devices , соответствующие запросу.

next_page_token

string

Маркер разбиения на страницы, возвращенный из предыдущего вызова ListDevices , который указывает, с чего следует продолжить листинг. Если поле отсутствует или пусто, это означает, что устройств больше нет.

ListNodesRequest

Запрос ListNodes .

Поля
parent

string

Необходимый. Имя родительского ресурса, например, "nodes/1".

page_size

int32

Максимальное количество узлов, возвращаемых в ответе.

page_token

string

Маркер разбивки на страницы, возвращенный из предыдущего вызова ListNodes , указывает, с чего следует продолжить этот список.

filter

string

Выражение фильтра. Фильтр должен иметь следующий формат: "DIRECT_CHILDREN" или формат: "direct_children". Фильтр нечувствителен к регистру. Если пусто, то никакие узлы не фильтруются.

Ответ узлов списка

Ответ для ListNodes .

Поля
nodes[]

Node

nodes , соответствующие запросу.

next_page_token

string

Маркер разбивки на страницы, возвращенный из предыдущего вызова ListNodes , указывает, с чего следует продолжить листинг. Если поле отсутствует или пусто, это означает, что узлов больше нет.

Возможности измерения

Возможность измерения устройства. Значения определены WINNF-SSC-0002.

перечисления
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

Моведеплойментрекуест

Запрос на MoveDeployment .

Поля
name

string

Необходимый. Имя deployment для перемещения.

destination

string

Необходимый. Имя нового родительского node ресурсов или customer , для которого развертывание будет изменено.

MoveDeviceRequest

Запрос MoveDevice .

Поля
name

string

Необходимый. Имя устройства для перемещения.

destination

string

Необходимый. Имя нового родительского ресурсного node или customer , под которым будет переопределено устройство.

MoveNodeRequest

Запрос MoveNode .

Поля
name

string

Необходимый. Имя node для перемещения.

destination

string

Необходимый. Имя нового родительского node ресурса или customer , под которым нужно изменить родительский узел.

Узел

Узел.

Поля
name

string

Только вывод. Имя ресурса.

display_name

string

Отображаемое имя узла.

sas_user_ids[]

string

Идентификаторы пользователей, используемые устройствами, принадлежащими этому узлу.

Политика

Определяет политику управления доступом к ресурсам.

Поля
assignments[]

Assignment

Список assignments

etag

bytes

Тег etag используется для управления оптимистичным параллелизмом, чтобы предотвратить перезапись одновременных обновлений политики друг другом. Настоятельно рекомендуется, чтобы системы использовали etag в цикле чтения-изменения-записи для выполнения обновлений политики, чтобы избежать условий гонки: etag возвращается в ответ на GetPolicy , и ожидается, что системы поместят этот etag в запрос в SetPolicy , чтобы убедиться, что их изменение будет применено к той же версии политики.

Если в вызове GetPolicy не указан etag, существующая политика перезаписывается вслепую.

СетПолицирекуест

Сообщение запроса для метода SetPolicy .

Поля
resource

string

Необходимый. Ресурс, для которого указывается политика. Эта политика заменяет любую существующую политику.

policy

Policy

Необходимый. Политика, применяемая к resource .

SignDeviceRequest

Запрос SignDevice .

Поля
device

Device

Необходимый. device для подписи. Поля device name , fcc_id и serial_number должны быть установлены. Поле user_id должно быть установлено.

ТестПермишнсрекуест

Сообщение запроса для метода TestPermissions .

Поля
resource

string

Необходимый. Ресурс, для которого запрашиваются разрешения.

permissions[]

string

Набор разрешений для проверки resource .

ТестПермишнсОтвет

Ответное сообщение для метода TestPermissions .

Поля
permissions[]

string

Набор разрешений, которые разрешены вызывающей стороне.

ОбновитьЗапросКлиента

Запрос на UpdateCustomer .

Поля
customer

Customer

Необходимый. Новые ценности для customer . У клиента должны быть установлены name и display_name .

update_mask

FieldMask

Поля, которые необходимо обновить.

Упдейдеплойментрекуест

Запрос на UpdateDeployment .

Поля
deployment

Deployment

Необходимый. Новые значения для deployment . name и display_name должны быть установлены.

update_mask

FieldMask

Поля, которые необходимо обновить.

ОбновитьDeviceRequest

Запрос UpdateDevice .

Поля
device

Device

Необходимый. device для обновления. Поля device name , fcc_id и serial_number должны быть установлены. Поле user_id должно быть установлено.

update_mask

FieldMask

Поля, которые необходимо обновить.

апдейтнодерекуест

Запрос на UpdateNode .

Поля
node

Node

Необходимый. Новые значения для node . name и display_name должны быть установлены.

update_mask

FieldMask

Поля, которые необходимо обновить.

апдейтсигнеддевицерекуест

Запрос на UpdateSignedDevice .

Поля
name

string

Необходимый. Имя устройства для обновления.

encoded_device

bytes

Необходимый. Веб-токен JSON подписан с использованием закрытого ключа CPI. Полезная нагрузка должна представлять собой кодировку JSON device . Поле user_id должно быть установлено.

installer_id

string

Необходимый. Уникальный идентификатор установщика (CPI ID) из базы данных сертифицированных профессиональных установщиков.

Валидатеинсталлеррекуест

Запрос на ValidateInstaller .

Поля
installer_id

string

Необходимый. Уникальный идентификатор установщика (CPI ID) из базы данных сертифицированных профессиональных установщиков.

secret

string

Необходимый. Секрет, возвращенный GenerateSecret .

encoded_secret

string

Необходимый. Веб-токен JSON, подписанный с использованием закрытого ключа CPI. Полезная нагрузка должна включать «секретное» утверждение, значением которого является секрет.

ValidateInstallerResponse

Ответ для ValidateInstaller .