索引
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
市民ブロードバンドの無線サービス デバイスを管理するサービス。
デプロイの作成 | |
---|---|
新しい
|
CreateDevice | |
---|---|
|
ノードの作成 | |
---|---|
新しい
|
署名付きデバイスを作成 | |
---|---|
|
Deployment を削除する | |
---|---|
|
DeleteDevice | |
---|---|
|
ノードを削除 | |
---|---|
|
GenerateSecret | |
---|---|
|
GetDeployment | |
---|---|
リクエストされた
|
GetDevice | |
---|---|
|
ノードの取得 | |
---|---|
リクエストされた
|
ListDeployment | |
---|---|
|
ListDevices | |
---|---|
|
ListNodes | |
---|---|
|
MoveDeployment | |
---|---|
|
デバイスを移動 | |
---|---|
|
ノードを移動 | |
---|---|
|
サインデバイス | |
---|---|
|
UpdateDeployment | |
---|---|
既存の
|
デバイスの更新 | |
---|---|
|
更新ノード | |
---|---|
既存の
|
署名付きデバイスの更新 | |
---|---|
署名付きの
|
ValidateInstaller | |
---|---|
認定プロフェッショナル インストーラ(CPI)の識別情報を検証します。
|
PolicyService
Spectrum Resource Manager へのアクセス制御サービス。
ポリシーの取得 | |
---|---|
リソースのアクセス制御ポリシーを取得します。リソースが存在し、ポリシーが設定されていない場合は、空のポリシーを返します。
|
SetPolicy | |
---|---|
指定したリソースにアクセス制御ポリシーを設定します。既存のポリシーをすべて置き換えます。
|
TestPermissions | |
---|---|
指定したリソースに対して呼び出し元が持っている権限を返します。
|
割り当て
members
を role
に関連付けます。
フィールド | |
---|---|
role |
必須。 |
members[] |
ロールが割り当てられている ID。以下のいずれかの値が設定されます。
|
お支払いモード
CBSD の課金モード
列挙型 | |
---|---|
BILLING_MODE_UNSPECIFIED |
請求モードが指定されていません。 |
MOBILE |
価格は CBSD のカテゴリに基づきます。SAS に登録されているカテゴリ A、カテゴリ B。 |
FIXED_WIRELESS |
価格は CBSD のタイプ(ベース ステーションまたは CPE)に基づきます。 |
チャンネル タイプ
列挙型 | |
---|---|
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 Token。ペイロードは、 |
installer_id |
必須。認定プロフェッショナル インストーラ データベースに登録されている一意のインストーラ ID(CPI ID)。 |
お客様
SAS の顧客を表すエンティティ。
フィールド | |
---|---|
name |
出力のみ。顧客のリソース名。 |
display_name |
必須。顧客エンティティが表す組織の名前。 |
sas_user_ids[] |
このお客様が所有するデバイスで使用されるユーザー ID。 |
DeleteDeploymentRequest
DeleteDeployment
のリクエスト。
フィールド | |
---|---|
name |
必須。 |
DeleteDeviceRequest
DeleteDevice
のリクエスト。
フィールド | |
---|---|
name |
必須。デバイスの名前。 |
DeleteNodeRequest
DeleteNode
のリクエスト。
フィールド | |
---|---|
name |
必須。 |
デプロイ
Deployment。
フィールド | |
---|---|
name |
出力のみ。リソース名。 |
display_name |
デプロイメントの表示名。 |
sas_user_ids[] |
このデプロイに属するデバイスで使用されるユーザー ID。各デプロイメントは 1 つの一意のユーザー ID に関連付ける必要があります。 |
default_billing_mode |
デプロイとそれ下にあるデバイスのデフォルトの請求モード。 |
allowed_billing_modes[] |
このデプロイで許可される課金モード。 |
デバイス
フィールド | |
---|---|
name |
出力のみ。リソースパス名。 |
fcc_id |
デバイスの FCC 識別子。 |
serial_number |
デバイスのメーカーがデバイスに割り当てるシリアル番号。 |
preloaded_config |
デバイスの構成。SAS Portal API で指定します。 |
active_config |
出力のみ。SAS に登録されているデバイスの現在の構成。 |
state |
出力のみ。デバイスの状態。 |
grants[] |
出力のみ。デバイスに保持されている権限。 |
display_name |
デバイスの表示名。 |
device_metadata |
SAS Portal と SAS 登録リクエストの両方でオーバーライドできるデバイス パラメータ。 |
状態
デバイスの状態。
列挙型 | |
---|---|
DEVICE_STATE_UNSPECIFIED |
未指定の状態 |
RESERVED |
SAS Portal で作成されたデバイスがまだ SAS に登録されていない。 |
REGISTERED |
SAS に登録されているデバイス。 |
DEREGISTERED |
SAS から登録解除されたデバイス。 |
DeviceAirInterface
デバイスのエア インターフェースに関する情報
フィールド | |
---|---|
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
パート 96 で定義されているデバイスの FCC カテゴリ。
列挙型 | |
---|---|
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 |
デバイス付与
デバイスの許可これは、デバイスがハートビートに成功した後に、指定動作パラメータを使用して送信するために Spectrum Access システムによってデバイスに付与される認可です。
フィールド | |
---|---|
max_eirp |
アクセス許可によって許容される最大等価放射電力(EIRP)最大 EIRP は dBm/MHz の単位です。 |
frequency_range |
送信周波数範囲。 |
state |
付与の状態。 |
channel_type |
使用されたチャンネルの種類。 |
move_list[] |
この付与が表示されている DPA Move リスト。 |
expire_time |
付与の有効期限。 |
suspension_reason[] |
助成金が停止された場合は、停止の理由。 |
grant_id |
付与 ID。 |
デバイス メタデータ
SAS ポータル リクエストと登録リクエストの両方でデバイスデータをオーバーライド可能。
DeviceModel
デバイスのモデルに関する情報
フィールド | |
---|---|
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)。 |
GenerateSecretRequest
GenerateSecret
のリクエスト。
GenerateSecretResponse
GenerateSecret
へのレスポンス。
フィールド | |
---|---|
secret |
文字列によって生成され、 |
GetCustomerRequest
GetCustomer
のリクエスト。
フィールド | |
---|---|
name |
必須。 |
GetDeploymentRequest
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 m を下回った場合にのみ指定します。 |
vertical_accuracy |
デバイス アンテナの垂直位置の精度を示す正数(メートル単位)。このオプションのパラメータは、その値が FCC 要件の 3 m より小さい場合にのみ指定する必要があります。 |
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)の範囲の整数です。指定しない場合、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 |
必須。親リソース名(例: 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 ~ 1, 000 の範囲内で指定します。 |
page_token |
前回の |
filter |
フィルタ式。フィルタの形式は「sn=123454" or "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 を使用することを強くおすすめします。これにより、競合状態を回避できるようになります。
|
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 Token。ペイロードは、 |
installer_id |
必須。認定プロフェッショナル インストーラ データベースから取得した、一意のインストーラ ID(CPI ID)。 |
ValidateInstallerRequest
ValidateInstaller
のリクエスト。
フィールド | |
---|---|
installer_id |
必須。認定プロフェッショナル インストーラ データベースに登録されている一意のインストーラ ID(CPI ID)。 |
secret |
必須。 |
encoded_secret |
必須。CPI 秘密鍵を使用して署名された JSON Web Token。ペイロードには、シークレットである値である「secret」を含める必要があります。 |
ValidateInstallerResponse
ValidateInstaller
へのレスポンス。