Индекс
-
Customers
(интерфейс) -
DeviceManager
(интерфейс) -
PolicyService
(интерфейс) -
Assignment
(сообщение) -
BillingMode
(перечисление) -
ChannelType
(перечисление) -
CreateDeploymentRequest
(сообщение) -
CreateDeviceRequest
(сообщение) -
CreateNodeRequest
(сообщение) -
CreateSignedDeviceRequest
(сообщение) -
Customer
(сообщение) -
DeleteDeploymentRequest
(сообщение) -
DeleteDeviceRequest
(сообщение) -
DeleteNodeRequest
(сообщение) -
Deployment
(сообщение) -
Device
(сообщение) -
Device.State
(перечисление) -
DeviceAirInterface
(сообщение) -
DeviceAirInterface.RadioTechnology
(перечисление) -
DeviceCategory
(перечисление) -
DeviceConfig
(сообщение) -
DeviceConfig.State
(перечисление) -
DeviceGrant
(сообщение) -
DeviceMetadata
(сообщение) -
DeviceModel
(сообщение) -
DpaMoveList
(сообщение) -
FrequencyRange
(сообщение) -
GenerateSecretRequest
(сообщение) -
GenerateSecretResponse
(сообщение) -
GetCustomerRequest
(сообщение) -
GetDeploymentRequest
(сообщение) -
GetDeviceRequest
(сообщение) -
GetNodeRequest
(сообщение) -
GetPolicyRequest
(сообщение) -
GrantState
(перечисление) -
HeightType
(перечисление) -
InstallationParams
(сообщение) -
ListCustomersRequest
(сообщение) -
ListCustomersResponse
(сообщение) -
ListDeploymentsRequest
(сообщение) -
ListDeploymentsResponse
(сообщение) -
ListDevicesRequest
(сообщение) -
ListDevicesResponse
(сообщение) -
ListNodesRequest
(сообщение) -
ListNodesResponse
(сообщение) -
MeasurementCapability
(перечисление) -
MoveDeploymentRequest
(сообщение) -
MoveDeviceRequest
(сообщение) -
MoveNodeRequest
(сообщение) -
Node
(сообщение) -
Policy
(сообщение) -
SetPolicyRequest
(сообщение) -
SignDeviceRequest
(сообщение) -
TestPermissionsRequest
(сообщение) -
TestPermissionsResponse
(сообщение) -
UpdateCustomerRequest
(сообщение) -
UpdateDeploymentRequest
(сообщение) -
UpdateDeviceRequest
(сообщение) -
UpdateNodeRequest
(сообщение) -
UpdateSignedDeviceRequest
(сообщение) -
ValidateInstallerRequest
(сообщение) -
ValidateInstallerResponse
(сообщение)
Клиенты
Управление службами клиентов SAS.
GetCustomer | |
---|---|
Возвращает запрошенного
|
Список клиентов | |
---|---|
Возвращает список запрошенных
|
ОбновлениеКлиента | |
---|---|
Обновляет существующего
|
Диспетчер устройств
Служба управления устройствами широкополосной радиосвязи для граждан.
CreateDeployment | |
---|---|
Создает новое
|
CreateDevice | |
---|---|
Создает
|
CreateNode | |
---|---|
Создает новый
|
CreateSignedDevice | |
---|---|
Создает подписанное
|
DeleteDeployment | |
---|---|
Удаляет
|
Удалить устройство | |
---|---|
Удаляет
|
УдалитьУзел | |
---|---|
Удаляет
|
GenerateSecret | |
---|---|
Генерирует секрет для использования с
|
GetDeployment | |
---|---|
Возвращает запрошенное
|
GetDevice | |
---|---|
Получает сведения об
|
GetNode | |
---|---|
Возвращает запрошенный
|
Список развертываний | |
---|---|
Перечисляет
|
Список устройств | |
---|---|
Перечисляет
|
ListNodes | |
---|---|
Перечисляет
|
MoveDeployment | |
---|---|
Перемещает
|
Переместить устройство | |
---|---|
Перемещает
|
ПереместитьУзел | |
---|---|
Перемещает
|
SignDevice | |
---|---|
Подписывает
|
ОбновлениеРазвертывание | |
---|---|
Обновляет существующее
|
Обновление устройства | |
---|---|
Обновляет
|
UpdateNode | |
---|---|
Обновляет существующий
|
UpdateSignedDevice | |
---|---|
Обновляет подписанное
|
ValidateInstaller | |
---|---|
Подтверждает личность сертифицированного профессионального установщика (CPI).
|
PolicyService
Служба контроля доступа к диспетчеру ресурсов спектра.
GetPolicy | |
---|---|
Получает политику управления доступом для ресурса. Возвращает пустую политику, если ресурс существует и для него не установлена политика.
|
Установить политику | |
---|---|
Устанавливает политику управления доступом для указанного ресурса. Заменяет любую существующую политику.
|
TestPermissions | |
---|---|
Возвращает разрешения, которые вызывающий объект имеет на указанный ресурс.
|
Назначение
Связывает members
с role
.
Поля | |
---|---|
role | Обязательно. Роль, назначаемая |
members[] | Идентификаторы, которым назначена роль. Роль может иметь следующие значения:
|
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 | Обязательно. Имя родительского ресурса, где будет создано развертывание. |
deployment | Обязательно. Сведения о развертывании. |
CreateDeviceRequest
Запрос на CreateDevice
.
Поля | |
---|---|
parent | Обязательно. Имя родительского ресурса. |
device | Регистрационные данные |
CreateNodeRequest
Запрос на CreateNode
.
Поля | |
---|---|
parent | Обязательно. Имя родительского ресурса, где будет создан узел. |
node | Сведения об узле. |
CreateSignedDeviceRequest
Запрос на CreateSignedDevice
.
Поля | |
---|---|
parent | Обязательно. Имя родительского ресурса. |
encoded_device | Обязательно. JSON Web Token, подписанный с использованием закрытого ключа CPI. Полезная нагрузка должна представлять собой JSON-кодировку |
installer_id | Обязательно. Уникальный идентификатор установщика (CPI ID) из базы данных сертифицированных профессиональных установщиков. |
Клиент
Организация, представляющая клиента SAS.
Поля | |
---|---|
name | Только вывод. Имя ресурса клиента. |
display_name | Обязательно. Название организации, которую представляет клиент. |
sas_user_ids[] | Идентификаторы пользователей, используемые устройствами, принадлежащими этому клиенту. |
DeleteDeploymentRequest
Запрос на DeleteDeployment
.
Поля | |
---|---|
name | Обязательно. Имя |
DeleteDeviceRequest
Запрос на DeleteDevice
.
Поля | |
---|---|
name | Обязательно. Имя устройства. |
DeleteNodeRequest
Запрос на DeleteNode
.
Поля | |
---|---|
name | Обязательно. Имя |
Развертывание
Развертывание.
Поля | |
---|---|
name | Только вывод. Имя ресурса. |
display_name | Отображаемое имя развертывания. |
sas_user_ids[] | Идентификатор пользователя, используемый устройствами, принадлежащими этому развертыванию. Каждое развертывание должно быть связано с одним уникальным идентификатором пользователя. |
default_billing_mode | Режим биллинга по умолчанию для развертывания и устройств в нем. |
allowed_billing_modes[] | Разрешенные режимы биллинга в рамках данного развертывания. |
Устройство
Поля | |
---|---|
name | Только вывод. Имя пути к ресурсу. |
fcc_id | Идентификатор FCC устройства. |
serial_number | Серийный номер, присвоенный устройству производителем. |
preloaded_config | Конфигурация устройства, как указано через API SAS Portal. |
active_config | Только вывод. Текущая конфигурация устройства, зарегистрированная в SAS. |
state | Только вывод. Состояние устройства. |
grants[] | Только вывод. Гранты, удерживаемые устройством. |
display_name | Отображаемое имя устройства. |
device_metadata | Параметры устройства, которые могут быть переопределены как порталом SAS, так и запросами на регистрацию SAS. |
Состояние
Состояние устройства.
Перечисления | |
---|---|
DEVICE_STATE_UNSPECIFIED | Неопределенное состояние. |
RESERVED | Устройство создано на портале SAS, однако еще не зарегистрировано в SAS. |
REGISTERED | Устройство зарегистрировано в SAS. |
DEREGISTERED | Устройство снято с регистрации в SAS. |
DeviceAirInterface
Информация о радиоинтерфейсе устройства.
Поля | |
---|---|
radio_technology | Условно. В этом поле указывается технология радиодоступа, используемая для CBSD. |
supported_spec | Необязательное поле. Это поле относится к |
Радиотехнологии
Утвержденные типы технологий радиодоступа.
Перечисления | |
---|---|
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 | Категория Б. |
DeviceConfig
Информация о конфигурации устройства.
Поля | |
---|---|
category | Категория устройства FCC. |
model | Информация о данной модели устройства. |
air_interface | Информация о радиоинтерфейсе этого устройства. |
installation_params | Параметры установки устройства. |
measurement_capabilities[] | Возможности устройства по предоставлению отчетов об измерениях. |
user_id | Идентификатор пользователя устройства. |
call_sign | Позывной оператора аппарата. |
state | Состояние конфигурации. |
is_signed | Только вывод. Подписана ли конфигурация CPI. |
update_time | Только вывод. Время последнего редактирования конфигурации устройства. |
Состояние
Состояние конфигурации устройства. Во время регистрации CBSD можно использовать только конфигурации в состоянии DEVICE_CONFIG_STATE_FINAL
.
Перечисления | |
---|---|
DEVICE_CONFIG_STATE_UNSPECIFIED | |
DRAFT | |
FINAL |
DeviceGrant
Разрешение на использование устройства. Это разрешение, предоставляемое системой доступа к спектру устройству на передачу данных с заданными рабочими параметрами после успешного подтверждения устройством своего состояния.
Поля | |
---|---|
max_eirp | Максимальная эквивалентная изотропно излучаемая мощность (ЭИИМ), разрешенная грантом. Максимальная ЭИИМ измеряется в дБм/МГц. Значение |
frequency_range | Диапазон частот передачи. |
state | Состояние гранта. |
channel_type | Тип используемого канала. |
move_list[] | В списке DPA фигурирует этот грант. |
expire_time | Срок действия гранта. |
suspension_reason[] | Если грант приостановлен, укажите причину(ы) приостановления. |
grant_id | Идентификатор гранта. |
DeviceMetadata
Данные устройства могут быть переопределены как порталом SAS, так и запросами на регистрацию.
Модель устройства
Информация о модели устройства.
Поля | |
---|---|
vendor | Название поставщика устройства. |
name | Название модели устройства. |
software_version | Версия программного обеспечения устройства. |
hardware_version | Аппаратная версия устройства. |
firmware_version | Версия прошивки устройства. |
DpaMoveList
Запись в списке действий DPA.
Поля | |
---|---|
dpa_id | Идентификатор DPA. |
frequency_range | Диапазон частот, на который влияет список перемещений. |
Диапазон частот
Диапазон частот от low_frequency
до high_frequency
.
Поля | |
---|---|
low_frequency_mhz | Самая низкая частота частотного диапазона в МГц. |
high_frequency_mhz | Самая высокая частота частотного диапазона в МГц. |
GenerateSecretRequest
Запрос на GenerateSecret
.
GenerateSecretResponse
Ответ для GenerateSecret
.
Поля | |
---|---|
secret | Секрет, сгенерированный строкой и используемый |
GetCustomerRequest
Запрос на GetCustomer
.
Поля | |
---|---|
name | Обязательно. Имя |
GetDeploymentRequest
Запрос на GetDeployment
.
Поля | |
---|---|
name | Обязательно. Имя |
GetDeviceRequest
Запрос GetDevice
.
Поля | |
---|---|
name | Обязательно. Имя устройства. |
GetNodeRequest
Запрос на GetNode
.
Поля | |
---|---|
name | Обязательно. Имя |
GetPolicyRequest
Запрос сообщения для метода GetPolicy
.
Поля | |
---|---|
resource | Обязательно. Ресурс, для которого запрашивается политика. |
GrantState
Состояние гранта.
Перечисления | |
---|---|
GRANT_STATE_UNSPECIFIED | |
GRANT_STATE_GRANTED | Грант был предоставлен, но устройство не работает. |
GRANT_STATE_TERMINATED | Грант был прекращен SAS. |
GRANT_STATE_SUSPENDED | Грант был приостановлен SAS. |
GRANT_STATE_AUTHORIZED | В данный момент устройство осуществляет передачу. |
GRANT_STATE_EXPIRED | Срок действия гранта истек. |
HeightType
Указывает, как измеряется высота.
Перечисления | |
---|---|
HEIGHT_TYPE_UNSPECIFIED | Неуказанный тип высоты. |
HEIGHT_TYPE_AGL | Высота AGL измеряется относительно уровня земли. |
HEIGHT_TYPE_AMSL | Высота среднего уровня моря измеряется относительно среднего уровня моря. |
Параметры установки
Информация о параметрах установки устройства.
Поля | |
---|---|
latitude | Широта местоположения антенны устройства в градусах относительно системы координат WGS 84. Допустимый диапазон — от -90,000000 до +90,000000. Положительные значения соответствуют широте к северу от экватора, отрицательные — к югу от экватора. |
longitude | Долгота местоположения антенны устройства в градусах относительно системы координат WGS 84. Допустимый диапазон — от -180,000000 до +180,000000. Положительные значения соответствуют долготе к востоку от нулевого меридиана, отрицательные — к западу от нулевого меридиана. |
height | Высота антенны устройства в метрах. Если параметр |
height_type | Указывает, как измеряется высота. |
horizontal_accuracy | Положительное число в метрах, указывающее точность определения местоположения антенны устройства в горизонтальной плоскости. Этот необязательный параметр должен присутствовать только в том случае, если его значение меньше требования FCC (50 метров). |
vertical_accuracy | Положительное число в метрах, указывающее точность определения положения антенны устройства по вертикали. Этот необязательный параметр должен присутствовать только в том случае, если его значение меньше требования FCC (3 метра). |
indoor_deployment | Является ли антенна устройства внутренней или нет. |
antenna_azimuth | Направление визирования горизонтальной плоскости антенны в градусах относительно истинного севера. Значение этого параметра — целое число от 0 до 359 включительно. Значение 0 градусов соответствует истинному северу; значение 90 градусов соответствует востоку. Этот параметр необязателен для устройств категории A и является условным для устройств категории B. |
antenna_downtilt | Наклон антенны вниз (в градусах) — это целое число от -90 до +90 включительно; отрицательное значение означает, что антенна наклонена вверх (выше горизонтали). Этот параметр необязателен для устройств категории A и является условным для устройств категории B. |
antenna_gain | Пиковое усиление антенны в дБи. Этот параметр представляет собой целое число от -127 до +128 (дБи) включительно. |
eirp_capability | Этот параметр представляет собой максимально допустимую EIRP устройства в единицах дБм/10 МГц и представляет собой целое число от -127 до +47 (дБм/10 МГц) включительно. Если параметр не указан, SAS интерпретирует его как максимально допустимую EIRP в единицах дБм/10 МГц для данной категории устройств. |
antenna_beamwidth | Ширина диаграммы направленности антенны по уровню 3 дБ в горизонтальной плоскости в градусах. Этот параметр представляет собой беззнаковое целое число в диапазоне от 0 до 360 (градусов) включительно; он необязателен для устройств категории A и является условным для устройств категории B. |
antenna_model | Если используется внешняя антенна, в этом поле можно указать её модель (необязательно). Максимальная длина строки — 128 октетов. |
cpe_cbsd_indication | Если присутствует, этот параметр указывает, является ли CBSD CPE-CBSD или нет. |
ListCustomersRequest
Запрос на ListCustomers
.
Поля | |
---|---|
page_size | Максимальное количество |
page_token | Токен пагинации, возвращенный из предыдущего вызова |
СписокОтветовКлиентов
Ответ для ListCustomers
.
Поля | |
---|---|
customers[] | Список |
next_page_token | Токен пагинации, возвращаемый из предыдущего вызова |
ListDeploymentsRequest
Запрос на ListDeployments
.
Поля | |
---|---|
parent | Обязательно. Имя родительского ресурса, например, «nodes/1», customer/1/nodes/2. |
page_size | Максимальное количество развертываний, возвращаемых в ответе. |
page_token | Токен пагинации, возвращенный из предыдущего вызова |
filter | Выражение фильтра. Фильтр должен иметь следующий формат: "DIRECT_CHILDREN" или "direct_children". Фильтр нечувствителен к регистру. Если значение пустое, то развёртывания не фильтруются. |
ListDeploymentsResponse
Ответ для ListDeployments
.
Поля | |
---|---|
deployments[] | |
next_page_token | Токен пагинации, возвращаемый предыдущим вызовом |
ListDevicesRequest
Запрос ListDevices
.
Поля | |
---|---|
parent | Обязательно. Имя родительского ресурса. |
page_size | Максимальное количество устройств, возвращаемых в ответе. Если значение пусто или равно нулю, будут перечислены все устройства. Должно быть в диапазоне [0, 1000]. |
page_token | Токен пагинации, возвращенный из предыдущего вызова |
filter | Выражение фильтра. Фильтр должен иметь один из следующих форматов: "sn=123454" или "display_name=MyDevice". sn соответствует серийному номеру устройства. Фильтр нечувствителен к регистру. |
ListDevicesResponse
Ответ для ListDevices
.
Поля | |
---|---|
devices[] | |
next_page_token | Токен пагинации, возвращаемый предыдущим вызовом |
ListNodesRequest
Запрос ListNodes
.
Поля | |
---|---|
parent | Обязательно. Имя родительского ресурса, например, «nodes/1». |
page_size | Максимальное количество узлов, возвращаемых в ответе. |
page_token | Токен пагинации, возвращенный из предыдущего вызова |
filter | Выражение фильтра. Фильтр должен иметь следующий формат: "DIRECT_CHILDREN" или "direct_children". Фильтр нечувствителен к регистру. Если значение пустое, то ни один узел не фильтруется. |
ListNodesResponse
Ответ для ListNodes
.
Поля | |
---|---|
nodes[] | |
next_page_token | Токен пагинации, возвращаемый предыдущим вызовом |
Возможность измерения
Возможности измерения устройства. Значения определены в стандарте WINNF-SSC-0002.
Перечисления | |
---|---|
MEASUREMENT_CAPABILITY_UNSPECIFIED | |
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT | |
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT |
MoveDeploymentRequest
Запрос на MoveDeployment
.
Поля | |
---|---|
name | Обязательно. Имя |
destination | Обязательно. Имя нового родительского |
MoveDeviceRequest
Запрос на MoveDevice
.
Поля | |
---|---|
name | Обязательно. Имя перемещаемого устройства. |
destination | Обязательно. Имя нового родительского |
MoveNodeRequest
Запрос на MoveNode
.
Поля | |
---|---|
name | Обязательно. Имя перемещаемого |
destination | Обязательно. Имя нового родительского |
Узел
Узел.
Поля | |
---|---|
name | Только вывод. Имя ресурса. |
display_name | Отображаемое имя узла. |
sas_user_ids[] | Идентификаторы пользователей, используемые устройствами, принадлежащими этому узлу. |
Политика
Определяет политику контроля доступа к ресурсам.
Поля | |
---|---|
assignments[] | Список |
etag | Тег etag используется для оптимистичного управления параллельными процессами, чтобы предотвратить перезапись одновременных обновлений политики. Настоятельно рекомендуется, чтобы системы использовали etag в цикле «чтение-изменение-запись» для обновления политики, чтобы избежать состояний гонки: etag возвращается в ответе на Если в вызове |
SetPolicyRequest
Запрос сообщения для метода SetPolicy
.
Поля | |
---|---|
resource | Обязательно. Ресурс, для которого указывается политика. Эта политика заменяет любую существующую политику. |
policy | Обязательно. Политика, применяемая к |
SignDeviceRequest
Запрос на SignDevice
.
Поля | |
---|---|
device | Обязательно. |
TestPermissionsRequest
Сообщение-запрос для метода TestPermissions
.
Поля | |
---|---|
resource | Обязательно. Ресурс, для которого запрашиваются разрешения. |
permissions[] | Набор разрешений для проверки |
TestPermissionsResponse
Ответное сообщение для метода TestPermissions
.
Поля | |
---|---|
permissions[] | Набор разрешений, разрешенных вызывающему абоненту. |
UpdateCustomerRequest
Запрос на UpdateCustomer
.
Поля | |
---|---|
customer | Обязательно. Новые значения для |
update_mask | Поля, которые необходимо обновить. |
UpdateDeploymentRequest
Запрос на UpdateDeployment
.
Поля | |
---|---|
deployment | Обязательно. Новые значения для |
update_mask | Поля, которые необходимо обновить. |
UpdateDeviceRequest
Запрос на UpdateDevice
.
Поля | |
---|---|
device | Обязательно. |
update_mask | Поля, которые необходимо обновить. |
UpdateNodeRequest
Запрос на UpdateNode
.
Поля | |
---|---|
node | Обязательно. Новые значения для |
update_mask | Поля, которые необходимо обновить. |
UpdateSignedDeviceRequest
Запрос на UpdateSignedDevice
.
Поля | |
---|---|
name | Обязательно. Имя устройства для обновления. |
encoded_device | Обязательно. JSON Web Token, подписанный с использованием закрытого ключа CPI. Полезная нагрузка должна представлять собой JSON-кодировку |
installer_id | Обязательно. Уникальный идентификатор установщика (CPI ID) из базы данных сертифицированных профессиональных установщиков. |
ValidateInstallerRequest
Запрос на ValidateInstaller
.
Поля | |
---|---|
installer_id | Обязательно. Уникальный идентификатор установщика (CPI ID) из базы данных сертифицированных профессиональных установщиков. |
secret | Обязательно. Секрет, возвращаемый |
encoded_secret | Обязательно. JSON Web Token, подписанный с использованием закрытого ключа CPI. Полезная нагрузка должна включать «секретное» утверждение, значение которого является секретом. |
ValidateInstallerResponse
Ответ для ValidateInstaller
.