索引
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 客戶的服務。
取得客戶 | |
---|---|
傳回要求的
|
列出客戶 | |
---|---|
傳回所要求
|
更新客戶 | |
---|---|
更新現有的
|
DeviceManager
管理 Citizens Broadband Radio Service Device 的服務。
建立部署作業 | |
---|---|
建立新的
|
建立裝置 | |
---|---|
|
建立節點 | |
---|---|
建立新的
|
建立已簽署的裝置 | |
---|---|
在
|
刪除部署作業 | |
---|---|
刪除
|
刪除裝置 | |
---|---|
刪除
|
刪除節點 | |
---|---|
刪除
|
產生密鑰 | |
---|---|
產生要與
|
取得部署作業 | |
---|---|
傳回要求的
|
取得裝置 | |
---|---|
取得
|
GetNode | |
---|---|
傳回要求的
|
列出部署作業 | |
---|---|
列出
|
列出裝置 | |
---|---|
在
|
ListNode | |
---|---|
列出
|
移動部署 | |
---|---|
將
|
移動裝置 | |
---|---|
將
|
移動節點 | |
---|---|
將
|
簽署裝置 | |
---|---|
簽署
|
更新部署作業 | |
---|---|
更新現有的
|
更新裝置 | |
---|---|
更新
|
更新節點 | |
---|---|
更新現有的
|
更新已簽署的裝置 | |
---|---|
更新已簽署的
|
驗證安裝工具 | |
---|---|
驗證認證專業安裝人數 (CPI) 的身分。
|
政策服務
具備 Spectrum Resource Manager 的存取權控管服務。
GetPolicy | |
---|---|
取得資源的存取權控管政策。如果該資源存在且未設定政策,則會傳回空的政策。
|
已設定政策 | |
---|---|
設定指定資源的存取權控管政策,取代任何現有的政策。
|
測試權限 | |
---|---|
傳回呼叫者對指定資源的權限。
|
指派作業
將 members
與 role
建立關聯。
欄位 | |
---|---|
role |
必要,指派給 |
members[] |
指派角色的身分。可能會有下列值:
|
帳單模式
CBSD 的計費模式
列舉 | |
---|---|
BILLING_MODE_UNSPECIFIED |
未指定帳單模式。 |
MOBILE |
價格以 CBSD 的類別為準:類別 A、類別為 B。 |
FIXED_WIRELESS |
價格取決於 CBSD 類型:基地站或 CPE。 |
頻道類型
列舉 | |
---|---|
CHANNEL_TYPE_UNSPECIFIED |
|
CHANNEL_TYPE_GAA |
|
CHANNEL_TYPE_PAL |
建立部署作業要求
請求 CreateDeployment
。
欄位 | |
---|---|
parent |
必要,要建立部署的父項資源名稱。 |
deployment |
必要,部署作業詳細資料。 |
CreateDeviceRequest
請求 CreateDevice
。
欄位 | |
---|---|
parent |
必要,父項資源的名稱。 |
device |
「 |
建立節點要求
請求 CreateNode
。
欄位 | |
---|---|
parent |
必要,要建立節點的父項資源名稱。 |
node |
節點詳細資料。 |
建立已簽署的裝置要求
欄位 | |
---|---|
parent |
必要,父項資源的名稱。 |
encoded_device |
必要,使用 CPI 私密金鑰簽署的 JSON Web Token。酬載必須是 |
installer_id |
必要,認證專業安裝人數資料庫的專屬安裝程式 ID (CPI ID)。 |
客戶
代表 SAS 客戶的實體。
欄位 | |
---|---|
name |
僅供輸出。客戶的資源名稱。 |
display_name |
必要,客戶實體代表的機構名稱。 |
sas_user_ids[] |
此客戶的裝置使用的使用者 ID。 |
刪除部署作業要求
請求 DeleteDeployment
。
欄位 | |
---|---|
name |
必要, |
DeleteDeviceRequest
請求 DeleteDevice
。
欄位 | |
---|---|
name |
必要,裝置名稱。 |
刪除節點要求
請求 DeleteNode
。
欄位 | |
---|---|
name |
必要, |
Deployment
部署作業。
欄位 | |
---|---|
name |
僅供輸出。資源名稱。 |
display_name |
部署作業的顯示名稱。 |
sas_user_ids[] |
這項部署作業的裝置使用的使用者 ID。每個部署項目都應該與一組不重複的使用者 ID 建立關聯。 |
default_billing_mode |
部署作業和其預設裝置的預設帳單模式。 |
allowed_billing_modes[] |
此部署作業中允許的帳單模式。 |
裝置
欄位 | |
---|---|
name |
僅供輸出。資源路徑名稱。 |
fcc_id |
裝置的 FCC ID。 |
serial_number |
裝置製造商指派給裝置的序號。 |
preloaded_config |
透過 SAS Portal API 指定的裝置設定。 |
active_config |
僅供輸出。向 SAS 註冊的裝置目前的設定。 |
state |
僅供輸出。裝置狀態。 |
grants[] |
僅供輸出。由裝置保存的授權。 |
display_name |
裝置顯示名稱。 |
device_metadata |
SAS 入口網站和 SAS 註冊要求可以覆寫的裝置參數。 |
狀態
裝置狀態。
列舉 | |
---|---|
DEVICE_STATE_UNSPECIFIED |
未指定狀態。 |
RESERVED |
但已在 SAS 入口網站中建立的裝置,但尚未向 SAS 註冊。 |
REGISTERED |
裝置已向 SAS 註冊。 |
DEREGISTERED |
裝置已透過 SAS 取消註冊。 |
裝置空氣介面
裝置空氣介面的相關資訊。
欄位 | |
---|---|
radio_technology |
條件式。這個欄位會指定 CBSD 所用的無線電存取技術。 |
supported_spec |
選用,這個欄位與 |
無線電技術
已獲得核准的無線電存取技術類型。
列舉 | |
---|---|
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 |
僅供輸出。上次編輯裝置設定的時間。 |
狀態
裝置設定的狀態。CBSD 註冊期間只能使用 DEVICE_CONFIG_STATE_FINAL
狀態的設定。
列舉 | |
---|---|
DEVICE_CONFIG_STATE_UNSPECIFIED |
|
DRAFT |
|
FINAL |
裝置授權
裝置授權。可讓「頻譜存取系統」為裝置提供的授權,在裝置成功產生心跳後,透過指定的作業參數進行傳輸。
欄位 | |
---|---|
max_eirp |
本授權範圍內的最高等效輻射功率 (EIRP)。最高 EIRP 的單位為 dBm/MHz。 |
frequency_range |
傳輸頻率範圍。 |
state |
授權狀態。 |
channel_type |
使用的頻道類型。 |
move_list[] |
DPA 移動清單列出這項授權。 |
expire_time |
授權的到期時間。 |
suspension_reason[] |
如果帳戶遭到停權,停權的原因。 |
grant_id |
授權 ID |
裝置中繼資料
SAS Portal 和註冊要求可覆寫裝置資料。
裝置型號
裝置型號的相關資訊。
欄位 | |
---|---|
vendor |
裝置供應商的名稱。 |
name |
裝置型號名稱。 |
software_version |
裝置的軟體版本。 |
hardware_version |
裝置的硬體版本。 |
firmware_version |
裝置的韌體版本。 |
DpaMoveList
DPA' 移動清單中的項目。
欄位 | |
---|---|
dpa_id |
DPA 的 ID。 |
frequency_range |
移動清單會影響的頻率範圍。 |
頻率範圍
頻率範圍從 low_frequency
到 high_frequency
。
欄位 | |
---|---|
low_frequency_mhz |
頻率範圍的最低頻率 (以 MHz 為單位)。 |
high_frequency_mhz |
頻率範圍的最高頻率 (以 MHz 為單位)。 |
產生密鑰要求
請求 GenerateSecret
。
產生密鑰回應
對 GenerateSecret
的回應
欄位 | |
---|---|
secret |
由字串產生的密鑰,並由 |
GetCustomerRequest
請求 GetCustomer
。
欄位 | |
---|---|
name |
必要, |
取得部署作業要求
請求 GetDeployment
。
欄位 | |
---|---|
name |
必要, |
GetDeviceRequest
請求 GetDevice
。
欄位 | |
---|---|
name |
必要,裝置名稱。 |
GetNodeRequest
請求 GetNode
。
欄位 | |
---|---|
name |
必要, |
GetPolicyRequest
要求 GetPolicy
方法的訊息。
欄位 | |
---|---|
resource |
必要,要求政策的資源。 |
授權州
授權狀態。
列舉 | |
---|---|
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 高度是根據平均海拔測量而得。 |
InstallationParams
裝置參數相關資訊。
欄位 | |
---|---|
latitude |
裝置天線位置 (以度為單位,與 WGS 84 基準面相同) 的緯度。允許的範圍介於 -90.000000 到 +90.000000。正數代表赤道以北的緯度,代表赤道以南的負值。 |
longitude |
裝置天線位置的經度 (以度為單位,以 WGS 84 資料為依據)。允許的範圍介於 -180.000000 到 +180.000000。正值代表初經子宮東側的經度,數值為西經子宮西側的負值。 |
height |
裝置天線高度 (單位為公尺)。當 |
height_type |
指定高度的測量方式。 |
horizontal_accuracy |
以公尺為單位的數值,代表裝置天線水平位置的準確度。只有在選用值小於 FCC 50 公尺的情況下,才需要顯示這個選用參數。 |
vertical_accuracy |
以公尺為單位表示裝置天線垂直位置的準確度。只有在選用值小於 3 公尺的 FCC 規定時,才需要顯示這個選用參數。 |
indoor_deployment |
裝置天線是否為室內裝置。 |
antenna_azimuth |
天線水平平面的垂直方向,以正北為基準。這個參數的值是介於 0 到 359 (含) 之間的整數。0 度代表正北,90 度代表東方。對於 A 類裝置,這個參數為選用,而 B 類別裝置則是選擇性使用。 |
antenna_downtilt |
天線向下傾斜度,是介於 -90 到 +90 (含) 之間的整數;負數則代表天線向上傾斜 (水平以上)。對於 A 類裝置,這個參數為選用,而 B 類別裝置則是選擇性使用。 |
antenna_gain |
最高天線增益 (dBi)這個參數是介於 -127 和 +128 (dBi) 之間的整數。 |
eirp_capability |
這項參數是 dBm/10MHz 的單位裝置最高 IIRP,其值為介於 -127 和 +47 (dBm/10 MHz) 之間的整數。如果沒有納入,SAS 會將該裝置視為裝置類別允許的上限 EdRP (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 |
從先前呼叫 |
列出部署作業
請求 ListDeployments
。
欄位 | |
---|---|
parent |
必要,父項資源名稱,例如「quonode;nodes/1」、「customer/1/nodes/2」。 |
page_size |
回應中傳回的部署作業數量上限。 |
page_token |
從先前呼叫 |
filter |
篩選運算式。篩選器應採用下列格式:「quot;DIRECT_CHILDREN」或格式:「&direct_children」。篩選器不會區分大小寫。如果空白,則不會篩選任何部署作業。 |
ListDeploymentsResponse
對 ListDeployments
的回應
欄位 | |
---|---|
deployments[] |
符合要求的 |
next_page_token |
從先前呼叫 |
ListDevicesRequest
請求 ListDevices
。
欄位 | |
---|---|
parent |
必要,父項資源的名稱。 |
page_size |
回應中傳回的裝置數量上限。如果空白或零,則會列出所有裝置。範圍必須介於 [0, 1000] 之間。 |
page_token |
從先前呼叫 |
filter |
篩選運算式。篩選器應包含下列其中一種格式:「"sn=123454"」或「quo_;display_name=MyDevice"」。sn 對應裝置的序號。篩選器不會區分大小寫。 |
ListDevicesResponse
對 ListDevices
的回應
欄位 | |
---|---|
devices[] |
符合要求的 |
next_page_token |
從先前呼叫 |
列出節點
請求 ListNodes
。
欄位 | |
---|---|
parent |
必要,父項資源名稱,例如「nodenode/1」。 |
page_size |
回應中傳回的節點數量上限。 |
page_token |
從先前呼叫 |
filter |
篩選運算式。篩選器應採用下列格式:「quot;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 |
移動部署要求
請求 MoveDeployment
。
欄位 | |
---|---|
name |
必要,要移動的 |
destination |
|
移動裝置要求
請求 MoveDevice
。
欄位 | |
---|---|
name |
必要,要移動的裝置名稱。 |
destination |
|
移動節點要求
請求 MoveNode
。
欄位 | |
---|---|
name |
必要,要移動的 |
destination |
|
節點
節點,
欄位 | |
---|---|
name |
僅供輸出。資源名稱。 |
display_name |
節點的顯示名稱。 |
sas_user_ids[] |
屬於此節點的裝置使用的使用者 ID。 |
Policy
定義資源的存取權控管政策。
欄位 | |
---|---|
assignments[] |
|
etag |
這個 etag 是用來最佳化的並行並行控制,防止政策同時同時覆寫。強烈建議您使用讀取/修改-寫入週期中的 eTag 來執行政策更新,以避免競爭狀況:在 如果呼叫 |
SetPolicyRequest
要求 SetPolicy
方法的訊息。
欄位 | |
---|---|
resource |
必要,用來指定政策的資源。這項政策會覆寫任何現有的政策。 |
policy |
必要,要套用至 |
簽署裝置要求
請求 SignDevice
。
欄位 | |
---|---|
device |
必要,要簽署的 |
測試權限要求
要求 TestPermissions
方法的訊息。
欄位 | |
---|---|
resource |
必要,要求權限的資源。 |
permissions[] |
檢查 |
測試權限回應
TestPermissions
方法的回應訊息。
欄位 | |
---|---|
permissions[] |
允許呼叫端的一組權限。 |
UpdateCustomerRequest
請求 UpdateCustomer
。
欄位 | |
---|---|
customer |
必要, |
update_mask |
要更新的欄位。 |
更新部署作業要求
請求 UpdateDeployment
。
欄位 | |
---|---|
deployment |
必要, |
update_mask |
要更新的欄位。 |
UpdateDeviceRequest
請求 UpdateDevice
。
欄位 | |
---|---|
device |
必要,要更新的 |
update_mask |
要更新的欄位。 |
更新節點要求
請求 UpdateNode
。
欄位 | |
---|---|
node |
必要, |
update_mask |
要更新的欄位。 |
更新已簽署的裝置要求
欄位 | |
---|---|
name |
必要,要更新的裝置名稱。 |
encoded_device |
必要,使用 CPI 私密金鑰簽署的 JSON Web Token。酬載必須是 |
installer_id |
必要,認證專業安裝人數資料庫的專屬安裝程式 ID (CPI ID)。 |
驗證安裝工具要求
欄位 | |
---|---|
installer_id |
必要,認證專業安裝人數資料庫的專屬安裝程式 ID (CPI ID)。 |
secret |
必要, |
encoded_secret |
必要,使用 CPI 私密金鑰簽署的 JSON Web Token。酬載必須包含「祕密」聲明,值則須為密鑰。 |
驗證安裝工具回應
對 ValidateInstaller
的回應