索引
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
管理 Citizens Broadband Radio 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
存取控制服務至 Spectrum Resource Manager。
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
欄位 | |
---|---|
parent |
必要欄位。父項資源的名稱。 |
encoded_device |
必要欄位。使用 CPI 私密金鑰簽署的 JSON Web Token。酬載必須是 |
installer_id |
必要欄位。認證專業安裝人員資料庫中的專屬安裝人員 ID (每次安裝費用 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 ID。 |
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 |
裝置使用者的 ID。 |
call_sign |
裝置操作人員的呼號。 |
state |
設定狀態。 |
is_signed |
僅供輸出。設定是否已由 CPI 簽署。 |
update_time |
僅供輸出。上次編輯裝置設定的時間。 |
州
裝置設定的狀態。只有處於 DEVICE_CONFIG_STATE_FINAL
狀態的設定,才能在 CBSD 註冊期間使用。
列舉 | |
---|---|
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 入口網站和註冊要求覆寫。
DeviceModel
裝置型號的相關資訊。
欄位 | |
---|---|
vendor |
裝置供應商名稱。 |
name |
裝置型號名稱。 |
software_version |
裝置的軟體版本。 |
hardware_version |
裝置的硬體版本。 |
firmware_version |
裝置的韌體版本。 |
DpaMoveList
DPA 搬移清單中的項目。
欄位 | |
---|---|
dpa_id |
動態產品廣告的 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 度表示正北,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) 之間的整數 (含 -127 和 +47)。如果未納入,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 |
|
節點
The Node。
欄位 | |
---|---|
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
欄位 | |
---|---|
name |
必要欄位。要更新的裝置名稱。 |
encoded_device |
必要欄位。使用 CPI 私密金鑰簽署的 JSON Web Token。酬載必須是 |
installer_id |
必要欄位。認證專業安裝人員資料庫中的專屬安裝人員 ID (每次安裝費用 ID)。 |
ValidateInstallerRequest
欄位 | |
---|---|
installer_id |
必要欄位。認證專業安裝人員資料庫中的專屬安裝人員 ID (每次安裝費用 ID)。 |
secret |
必要欄位。 |
encoded_secret |
必要欄位。使用 CPI 私密金鑰簽署的 JSON Web Token。酬載必須包含「secret」聲明,且值為密鑰。 |
ValidateInstallerResponse
對 ValidateInstaller
的回應。