Package spectrum.sas.portal.v1alpha1

索引

客户

管理 SAS 客户的服务。

获取客户

rpc GetCustomer(GetCustomerRequest) returns (Customer)

返回请求的 customer

授权范围

需要以下 OAuth 作用域:

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

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

DeviceManager

市民宽带无线装置服务管理服务。

创建部署

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

创建新的 deployment

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/userinfo.email
创建设备

rpc CreateDevice(CreateDeviceRequest) returns (Device)

nodecustomer 下创建 device

授权范围

需要以下 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)

nodecustomer 下创建已签名的 device

授权范围

需要以下 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
DeleteNode

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

删除 node

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/userinfo.email
生成密钥

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

生成与 ValidateInstaller 配合使用的 Secret。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/userinfo.email
获取部署

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

返回请求的 deployment

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/userinfo.email
获取设备

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
ListDeployment

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

列出 deployments

授权范围

需要以下 OAuth 作用域:

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

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

列出 nodecustomer 下的 devices

授权范围

需要以下 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 移到另一个 nodecustomer 下。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/userinfo.email
移动设备

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

device 移到另一个 nodecustomer 下。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/userinfo.email
移动节点

rpc MoveNode(MoveNodeRequest) returns (Operation)

node 移到另一个 nodecustomer 下。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/userinfo.email
签名设备

rpc SignDevice(SignDeviceRequest) returns (Empty)

device 进行签名。

授权范围

需要以下 OAuth 作用域:

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

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
ValidateInstaller 接口中的方法

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

验证 Professional Professional Installer (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
SetPolicy 枚举

rpc SetPolicy(SetPolicyRequest) returns (Policy)

设置对指定资源的访问权限控制政策。替换任何现有政策。

授权范围

需要以下 OAuth 作用域:

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

rpc TestPermissions(TestPermissionsRequest) returns (TestPermissionsResponse)

返回调用者对指定资源拥有的权限。

授权范围

需要以下 OAuth 作用域:

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

作业

membersrole 关联。

字段
role

string

必需,分配给 members 的角色。

members[]

string

角色被分配的身份。它可以具有以下值:

  • {user_email}:表示特定 Google 帐号的电子邮件地址。例如:alice@gmail.com

  • {group_email}:表示 Google 群组的电子邮件地址。例如 viewers@gmail.com

结算模式

CBSD 的结算模式

枚举
BILLING_MODE_UNSPECIFIED 尚未指定结算模式。
MOBILE 价格基于 CBSD 的类别:类别 A,在 SAS 中注册的类别 B。
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_idserial_number。必须设置 user_id 字段。

创建 NodeRequest

CreateNode的请求。

字段
parent

string

必需,要在其中创建节点的父级资源名称。

node

Node

节点详情。name 必须为空。由服务器生成。必须设置节点 display_name

CreateSignedDeviceRequest 类中的方法

CreateSignedDevice的请求。

字段
parent

string

必需,父级资源的名称。

encoded_device

bytes

必需,使用 CPI 私钥签名的 JSON 网络令牌。载荷必须是 device 的 JSON 编码格式。必须设置 user_id 字段。

installer_id

string

必需,认证专业安装程序数据库中的唯一安装程序 ID(每次安装费用 ID)。

客户

代表 SAS 客户的实体。

字段
name

string

仅供输出。客户的资源名称。

display_name

string

必需,客户实体代表的组织的名称。

sas_user_ids[]

string

属于此客户的设备所使用的用户 ID。

删除部署请求

DeleteDeployment的请求。

字段
name

string

必需,deployment 的名称。

DeleteDeviceRequest

DeleteDevice的请求。

字段
name

string

必需,设备的名称。

删除节点请求

DeleteNode的请求。

字段
name

string

必需,node 的名称。

Deployment

Deployment。

字段
name

string

仅供输出。资源名称。

display_name

string

部署的显示名称。

sas_user_ids[]

string

属于此部署的设备所使用的用户 ID。每个部署都应与一个唯一用户 ID 相关联。

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 取消注册。

DeviceAirInterface 接口

设备的空中接口的相关信息。

字段
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

DeviceCategory

设备的 FCC 类别(如第 96 部分所定义)。

枚举
DEVICE_CATEGORY_UNSPECIFIED 未指定的设备类别。
DEVICE_CATEGORY_A A 类。
DEVICE_CATEGORY_B B 类。

DeviceConfig

设备配置的相关信息。

字段
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 以 dBm/MHz 为单位。maxEirp 值表示将使用 FCC 第 96.41 (e)(3) 节中描述的过程测量到的平均 (RMS) EIRP。

frequency_range

FrequencyRange

传输频率范围。

state

GrantState

授权状态。

channel_type

ChannelType

使用的渠道类型。

move_list[]

DpaMoveList

显示此授权的 DPA 移动列表。

expire_time

Timestamp

授权的到期时间。

suspension_reason[]

string

如果补助金被暂停,请说明暂停原因。

grant_id

string

授权 ID。

设备元数据

可通过 SAS 门户和注册请求替换的设备数据。

设备型号

设备型号的相关信息。

字段
vendor

string

设备供应商的名称。

name

string

设备型号的名称。

software_version

string

设备的软件版本。

hardware_version

string

设备的硬件版本。

firmware_version

string

设备的固件版本。

DpaMoveList

DPA 的移动列表中的条目。

字段
dpa_id

StringValue

DPA 的 ID。

frequency_range

FrequencyRange

移动列表影响的频率范围。

频率范围

频次范围:low_frequency - high_frequency

字段
low_frequency_mhz

DoubleValue

频率范围的最低频率(以 MHz 为单位)。

high_frequency_mhz

DoubleValue

频率范围的最高频率(以 MHz 为单位)。

GenerateSecretRequest

GenerateSecret的请求。

GenerateSecretResponse

GenerateSecret 的响应。

字段
secret

string

由字符串生成并由 ValidateInstaller 使用的 Secret。

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 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

天线峰值增益(以 dBi 为单位)。此参数是一个整数,其值介于 -127(含)和 +128(dBi)之间(含首尾数字)。

eirp_capability

Int32Value

此参数是以 dBm/10MHz 为单位的最大设备 EIRP,是一个介于 -127 和 +47(dBm/10 MHz,含)之间的整数。如未加入,SAS 会将其解释为设备类别所允许的最大 EIRP(单位为 dBm/10MHz)。

antenna_beamwidth

Int32Value

天线水平水平天线的 3-dB 天线带宽(以度为单位)。此参数是一个无符号整数,其值介于 0 和 360(度)之间(包括 0 和 360);对于 A 类设备,此参数是可选的;对于 B 类设备,此参数是有条件的。

antenna_model

string

如果使用外部天线,则可以在此字段中选择提供相应天线模型。该字符串的长度上限为 128 个八位字节。

cpe_cbsd_indication

BoolValue

如果存在,则此参数指定 CBSD 是否为 CPE-CBSD。

ListCustomersRequest

ListCustomers的请求。

字段
page_size

int32

响应中要返回的 customers 数量上限。

page_token

string

从上一次调用 ListCustomers 返回的分页令牌,指示此列表应从什么位置继续。

ListCustomersResponse

ListCustomers 的响应。

字段
customers[]

Customer

与请求匹配的 customers 列表。

next_page_token

string

上一次调用 ListCustomers 返回的分页令牌,指示商家信息应从哪里继续。如果此字段缺失或为空,则意味着没有其他客户。

ListDeployments 请求

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 返回的分页令牌,指示商家信息应从哪里继续。如果该字段缺失或为空,则意味着没有更多部署。

ListDevicesRequest

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 返回的分页令牌,指示商家信息应从哪里继续。如果此字段缺失或为空,则表示没有其他设备。

ListNodes 请求

ListNodes的请求。

字段
parent

string

必需,父级资源名称,例如“nodes/1”。

page_size

int32

响应中要返回的节点数上限。

page_token

string

从上一次调用 ListNodes 返回的分页令牌,指示此列表应从什么位置继续。

filter

string

过滤条件表达式。过滤条件应采用以下格式:“DIRECT_CHILDREN”或“direct_children”。过滤条件不区分大小写。如果为空,则不会过滤任何节点。

ListNodesResponse 类的构造函数

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

必需,作为父项部署的新父级资源 nodecustomer 的名称。

移动设备请求

MoveDevice的请求。

字段
name

string

必需,要移动的设备的名称。

destination

string

必需,用于重新设置设备的新父级资源 nodecustomer 的名称。

移动节点请求

MoveNode的请求。

字段
name

string

必需,要移动的 node 的名称。

destination

string

必需,用于重新设置节点的父级的新父级资源 nodecustomer 的名称。

节点

节点。

字段
name

string

仅供输出。资源名称。

display_name

string

节点的显示名称。

sas_user_ids[]

string

属于此节点的设备使用的用户 ID。

政策

定义对资源的访问权限控制政策。

字段
assignments[]

Assignment

assignments 的列表

etag

bytes

etag 用于乐观并发控制,可帮助防止同时进行的政策更新相互覆盖。强烈建议系统在“读取-修改-写入”周期中使用 etag 来执行政策更新以避免竞态条件:在响应 GetPolicy 时返回一个 etag,系统会预计将该 etag 放入对 SetPolicy 的请求中,以确保其更改将应用于同一版本的政策。

如果在调用 GetPolicy 时未提供 etag,则盲目覆盖现有政策。

SetPolicyRequest 类中的方法

SetPolicy 方法的请求消息。

字段
resource

string

必需,为其指定政策的资源。此政策会取代所有现有政策。

policy

Policy

必需,要应用于 resource 的政策。

签名设备请求

SignDevice的请求。

字段
device

Device

必需,要签名的 device。必须设置 device 字段 namefcc_idserial_number。必须设置 user_id 字段。

TestPermissionsRequest

TestPermissions 方法的请求消息。

字段
resource

string

必需,请求权限的资源。

permissions[]

string

要用于检查 resource 的权限集。

TestPermissionsResponse

TestPermissions 方法的响应消息。

字段
permissions[]

string

调用者可以使用的一组权限。

UpdateCustomerRequest

UpdateCustomer的请求。

字段
customer

Customer

必需,customer 的新值。客户必须设置 namedisplay_name

update_mask

FieldMask

要更新的字段。

更新部署请求

UpdateDeployment的请求。

字段
deployment

Deployment

必需,deployment 的新值。必须设置 namedisplay_name

update_mask

FieldMask

要更新的字段。

UpdateDeviceRequest

UpdateDevice的请求。

字段
device

Device

必需,要更新的 device。必须设置 device 字段 namefcc_idserial_number。必须设置 user_id 字段。

update_mask

FieldMask

要更新的字段。

UpdateNodeRequest 类中的方法

UpdateNode的请求。

字段
node

Node

必需,node 的新值。必须设置 namedisplay_name

update_mask

FieldMask

要更新的字段。

UpdateSignedDeviceRequest 中的字段

UpdateSignedDevice的请求。

字段
name

string

必需,要更新的设备的名称。

encoded_device

bytes

必需,使用 CPI 私钥签名的 JSON 网络令牌。载荷必须是 device 的 JSON 编码格式。必须设置 user_id 字段。

installer_id

string

必需,认证的专业安装程序数据库中的唯一安装工 ID(每次安装费用 ID)。

ValidateInstaller 请求

ValidateInstaller的请求。

字段
installer_id

string

必需,认证专业安装程序数据库中的唯一安装程序 ID(每次安装费用 ID)。

secret

string

必需,GenerateSecret 返回的 Secret。

encoded_secret

string

必需,使用 CPI 私钥签名的 JSON 网络令牌。载荷必须包含一个“secret”声明,其值为 Secret。

ValidateInstallerResponse 类的构造函数

ValidateInstaller 的响应。