索引
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 | |
---|---|
返回所请求的
|
ListCustomers | |
---|---|
返回所请求的
|
UpdateCustomer | |
---|---|
更新现有
|
DeviceManager
用于管理公民宽带无线电服务设备的 Service。
CreateDeployment | |
---|---|
创建新的
|
CreateDevice | |
---|---|
|
CreateNode | |
---|---|
创建新的
|
CreateSignedDevice | |
---|---|
在
|
DeleteDeployment | |
---|---|
删除
|
DeleteDevice | |
---|---|
删除
|
DeleteNode | |
---|---|
删除
|
GenerateSecret | |
---|---|
生成要与
|
GetDeployment | |
---|---|
返回所请求的
|
GetDevice | |
---|---|
获取有关
|
GetNode | |
---|---|
返回所请求的
|
ListDeployments | |
---|---|
列出
|
ListDevices | |
---|---|
列出
|
ListNodes | |
---|---|
列出
|
MoveDeployment | |
---|---|
将
|
MoveDevice | |
---|---|
将
|
MoveNode | |
---|---|
将
|
SignDevice | |
---|---|
对
|
UpdateDeployment | |
---|---|
更新现有
|
UpdateDevice | |
---|---|
更新
|
UpdateNode | |
---|---|
更新现有
|
UpdateSignedDevice | |
---|---|
更新已签名的
|
ValidateInstaller | |
---|---|
验证经过认证的专业安装人员 (CPI) 的身份。
|
PolicyService
从接入控制服务到频谱资源管理器的访问控制。
GetPolicy | |
---|---|
获取资源的访问权限控制政策。如果资源存在但未设置政策,则返回空政策。
|
SetPolicy 枚举 | |
---|---|
设置对指定资源的访问权限控制政策。替换任何现有政策。
|
TestPermissions | |
---|---|
返回调用者对指定资源拥有的权限。
|
作业
将 members
与 role
关联。
字段 | |
---|---|
role |
必需。分配给 |
members[] |
角色所分配到的身份。它可以具有以下值:
|
BillingMode
CBSD 的结算模式
枚举 | |
---|---|
BILLING_MODE_UNSPECIFIED |
未指定结算模式。 |
MOBILE |
价格取决于 CBSD 的类别:向 SAS 注册的 A 类、B 类。 |
FIXED_WIRELESS |
价格取决于 CBSD 的类型:基站或 CPE。 |
ChannelType
枚举 | |
---|---|
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 |
必需。使用 CPI 私钥签名的 JSON Web 令牌。载荷必须是 |
installer_id |
必需。来自“Certified Professional Installers”数据库的唯一安装者 ID (CPI ID)。 |
客户
表示 SAS 客户的实体。
字段 | |
---|---|
name |
仅限输出。客户的资源名称。 |
display_name |
必需。客户实体所代表的组织的名称。 |
sas_user_ids[] |
相应客户的设备所使用的用户 ID。 |
DeleteDeploymentRequest
对 DeleteDeployment
的请求。
字段 | |
---|---|
name |
必需。 |
DeleteDeviceRequest
对 DeleteDevice
的请求。
字段 | |
---|---|
name |
必需。设备的名称。 |
DeleteNodeRequest
对 DeleteNode
的请求。
字段 | |
---|---|
name |
必需。 |
部署
部署。
字段 | |
---|---|
name |
仅限输出。资源名称。 |
display_name |
部署的显示名称。 |
sas_user_ids[] |
相应部署中的设备所使用的用户 ID。每次部署都应与一个唯一的用户 ID 相关联。 |
default_billing_mode |
部署及其下设备的默认结算模式。 |
allowed_billing_modes[] |
相应部署下允许的结算模式。 |
设备
字段 | |
---|---|
name |
仅限输出。资源路径名称。 |
fcc_id |
设备的 FCC 标识符。 |
serial_number |
设备制造商为设备分配的序列号。 |
preloaded_config |
设备的配置,通过 SAS 门户 API 指定。 |
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 |
可选。此字段与 |
RadioTechnology
获批的无线接入技术类型。
枚举 | |
---|---|
RADIO_TECHNOLOGY_UNSPECIFIED |
|
E_UTRA |
|
CAMBIUM_NETWORKS |
|
FOUR_G_BBW_SAA_1 |
|
NR |
|
DOODLE_CBRS |
|
CW |
|
REDLINE |
|
TARANA_WIRELESS |
DeviceCategory
设备的 FCC 类别,如第 96 部分所定义。
枚举 | |
---|---|
DEVICE_CATEGORY_UNSPECIFIED |
未指定设备类别。 |
DEVICE_CATEGORY_A |
A 类。 |
DEVICE_CATEGORY_B |
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 |
许可授予的最大等效全向辐射功率 (EIRP)。最大 EIRP 的单位为 dBm/MHz。值 |
frequency_range |
传输频率范围。 |
state |
授权的状态。 |
channel_type |
使用的渠道类型。 |
move_list[] |
显示相应授权的 DPA 迁移列表。 |
expire_time |
授权的过期时间。 |
suspension_reason[] |
如果许可被中止,则为中止原因。 |
grant_id |
授权 ID。 |
DeviceMetadata
可由 SAS Portal 和注册请求覆盖的设备数据。
DeviceModel
设备型号的相关信息。
字段 | |
---|---|
vendor |
设备供应商的名称。 |
name |
设备型号的名称。 |
software_version |
设备的软件版本。 |
hardware_version |
设备的硬件版本。 |
firmware_version |
设备的固件版本。 |
DpaMoveList
DPA 的移动列表中的条目。
字段 | |
---|---|
dpa_id |
DPA 的 ID。 |
frequency_range |
移动列表影响的频段。 |
FrequencyRange
频率范围为 low_frequency
到 high_frequency
。
字段 | |
---|---|
low_frequency_mhz |
频率范围的最低频率(以 MHz 为单位)。 |
high_frequency_mhz |
频率范围的最高频率(以 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 |
AMSL 高度是相对于平均海平面测量的。 |
InstallationParams
有关设备安装参数的信息。
字段 | |
---|---|
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 和 359)之间的整数。0 度表示正北,90 度表示正东。对于 A 类设备,此形参是可选的;对于 B 类设备,此形参是条件形参。 |
antenna_downtilt |
天线俯仰角(以度为单位),是一个介于 -90 到 +90(含)之间的整数;负值表示天线向上倾斜(高于水平位置)。对于 A 类设备,此形参是可选的;对于 B 类设备,此形参是条件形参。 |
antenna_gain |
天线峰值增益(以 dBi 为单位)。此参数是一个整数,其值介于 -127 到 +128(含)之间(单位为 dBi)。 |
eirp_capability |
此参数是设备的最大 EIRP,以 dBm/10MHz 为单位,是一个介于 -127 到 +47(含)之间的整数值(单位为 dBm/10 MHz)。如果未包含,SAS 会将其解读为设备类别的最大允许 EIRP(单位为 dBm/10MHz)。 |
antenna_beamwidth |
天线在水平面内的 3 dB 天线波束宽度(以度为单位)。此形参是一个无符号整数,其值介于 0 到 360(度)之间(含边界值);对于 A 类设备,此形参是可选的;对于 B 类设备,此形参是条件形参。 |
antenna_model |
如果使用外部天线,则可以选择在此字段中提供天线型号。字符串的长度上限为 128 个八位字节。 |
cpe_cbsd_indication |
如果存在,此参数用于指定 CBSD 是否为 CPE-CBSD。 |
ListCustomersRequest
对 ListCustomers
的请求。
字段 | |
---|---|
page_size |
响应中可返回的 |
page_token |
从上一次调用 |
ListCustomersResponse
对 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 |
从上一次调用 |
MeasurementCapability
设备测量功能。这些值由 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[] |
相应节点所属设备使用的用户 ID。 |
政策
定义对资源的访问权限控制政策。
字段 | |
---|---|
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 |
必需。使用 CPI 私钥签名的 JSON Web 令牌。载荷必须是 |
installer_id |
必需。来自“认证专业安装者”数据库的唯一安装者 ID (CPI ID)。 |
ValidateInstallerRequest
对 ValidateInstaller
的请求。
字段 | |
---|---|
installer_id |
必需。来自“Certified Professional Installers”数据库的唯一安装者 ID (CPI ID)。 |
secret |
必需。 |
encoded_secret |
必需。使用 CPI 私钥签名的 JSON Web 令牌。载荷必须包含一个“secret”声明,其值为相应 Secret。 |
ValidateInstallerResponse
对 ValidateInstaller
的响应。