Package spectrum.sas.portal.v1alpha1

索引

客户

管理 SAS 客户的服务。

GetCustomer

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
UpdateCustomer

rpc UpdateCustomer(UpdateCustomerRequest) returns (Customer)

更新现有 customer

授权范围

需要以下 OAuth 范围:

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

DeviceManager

用于管理公民宽带无线电服务设备的 Service。

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

创建新的 deployment

授权范围

需要以下 OAuth 范围:

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

rpc CreateDevice(CreateDeviceRequest) returns (Device)

nodecustomer 下创建 device

授权范围

需要以下 OAuth 范围:

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

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
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

删除 deployment

授权范围

需要以下 OAuth 范围:

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

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
GenerateSecret

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

生成要与 ValidateInstaller 搭配使用的 Secret。

授权范围

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

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

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

device 移动到另一个 nodecustomer 下。

授权范围

需要以下 OAuth 范围:

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

rpc MoveNode(MoveNodeRequest) returns (Operation)

node 移动到另一个 nodecustomer 下。

授权范围

需要以下 OAuth 范围:

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

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
UpdateDevice

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

更新 device

授权范围

需要以下 OAuth 范围:

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

rpc UpdateNode(UpdateNodeRequest) returns (Node)

更新现有 node

授权范围

需要以下 OAuth 范围:

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

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

更新已签名的 device

授权范围

需要以下 OAuth 范围:

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

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

验证经过认证的专业安装人员 (CPI) 的身份。

授权范围

需要以下 OAuth 范围:

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

PolicyService

从接入控制服务到频谱资源管理器的访问控制。

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

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

string

必需。要在其中创建部署的父资源名称。

deployment

Deployment

必需。部署详情。name 必须为空。由服务器生成。必须设置部署 display_name

CreateDeviceRequest

CreateDevice 的请求。

字段
parent

string

必需。父级资源的名称。

device

Device

device 注册详细信息。name 必须为空。由服务器生成。必须设置 device 字段 fcc_idserial_number。必须设置 user_id 字段。

CreateNodeRequest

CreateNode 的请求。

字段
parent

string

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

node

Node

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

CreateSignedDeviceRequest

CreateSignedDevice 的请求。

字段
parent

string

必需。父级资源的名称。

encoded_device

bytes

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

installer_id

string

必需。来自“Certified Professional Installers”数据库的唯一安装者 ID (CPI ID)。

客户

表示 SAS 客户的实体。

字段
name

string

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

display_name

string

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

sas_user_ids[]

string

相应客户的设备所使用的用户 ID。

DeleteDeploymentRequest

DeleteDeployment 的请求。

字段
name

string

必需。deployment 的名称。

DeleteDeviceRequest

DeleteDevice 的请求。

字段
name

string

必需。设备的名称。

DeleteNodeRequest

DeleteNode 的请求。

字段
name

string

必需。node 的名称。

部署

部署。

字段
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 门户 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 在注册时所符合的空中接口规范。

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

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

DeviceGrant

设备授权。这是频谱接入系统向设备提供的授权,允许设备在成功发送心跳信号后使用指定的运行参数进行传输。

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

DeviceMetadata

可由 SAS Portal 和注册请求覆盖的设备数据。

DeviceModel

设备型号的相关信息。

字段
vendor

string

设备供应商的名称。

name

string

设备型号的名称。

software_version

string

设备的软件版本。

hardware_version

string

设备的硬件版本。

firmware_version

string

设备的固件版本。

DpaMoveList

DPA 的移动列表中的条目。

字段
dpa_id

StringValue

DPA 的 ID。

frequency_range

FrequencyRange

移动列表影响的频段。

FrequencyRange

频率范围为 low_frequencyhigh_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

必需。要为其请求政策的资源。

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

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 和 359)之间的整数。0 度表示正北,90 度表示正东。对于 A 类设备,此形参是可选的;对于 B 类设备,此形参是条件形参。

antenna_downtilt

Int32Value

天线俯仰角(以度为单位),是一个介于 -90 到 +90(含)之间的整数;负值表示天线向上倾斜(高于水平位置)。对于 A 类设备,此形参是可选的;对于 B 类设备,此形参是条件形参。

antenna_gain

Int32Value

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

eirp_capability

Int32Value

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

antenna_beamwidth

Int32Value

天线在水平面内的 3 dB 天线波束宽度(以度为单位)。此形参是一个无符号整数,其值介于 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 返回的分页令牌,指示列表应从什么位置继续。如果该字段缺失或为空,则表示没有更多客户。

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 返回的分页令牌,指示列表应从什么位置继续。如果该字段缺失或为空,则表示没有更多部署。

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 返回的分页令牌,指示列表应从什么位置继续。如果该字段缺失或为空,则表示没有更多设备。

ListNodesRequest

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 返回的分页令牌,指示列表应从什么位置继续。如果该字段缺失或为空,则表示没有更多节点。

MeasurementCapability

设备测量功能。这些值由 WINNF-SSC-0002 定义。

枚举
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

MoveDeploymentRequest

MoveDeployment 的请求。

字段
name

string

必需。要移动的 deployment 的名称。

destination

string

必需。要将部署重新归属到的新父资源 nodecustomer 的名称。

MoveDeviceRequest

MoveDevice 的请求。

字段
name

string

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

destination

string

必需。要将设备重新归属到的新父资源 nodecustomer 的名称。

MoveNodeRequest

MoveNode 的请求。

字段
name

string

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

destination

string

必需。要将节点重新归属到的新父资源 nodecustomer 的名称。

节点

节点。

字段
name

string

仅限输出。资源名称。

display_name

string

节点的显示名称。

sas_user_ids[]

string

相应节点所属设备使用的用户 ID。

政策

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

字段
assignments[]

Assignment

assignments 的列表

etag

bytes

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

如果在调用 GetPolicy 时未提供 etag,则现有政策将被覆盖而毫无提示。

SetPolicyRequest

SetPolicy 方法的请求消息。

字段
resource

string

必需。要为其指定政策的资源。此政策会替换任何现有政策。

policy

Policy

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

SignDeviceRequest

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

要更新的字段。

UpdateDeploymentRequest

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 Web 令牌。载荷必须是 device 的 JSON 编码。必须设置 user_id 字段。

installer_id

string

必需。来自“认证专业安装者”数据库的唯一安装者 ID (CPI ID)。

ValidateInstallerRequest

ValidateInstaller 的请求。

字段
installer_id

string

必需。来自“Certified Professional Installers”数据库的唯一安装者 ID (CPI ID)。

secret

string

必需。GenerateSecret 返回的 Secret。

encoded_secret

string

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

ValidateInstallerResponse

ValidateInstaller 的响应。