インデックス
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
市民ブロードバンド無線サービス デバイスを管理するサービス。
| 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[] |
ロールが割り当てられている ID。以下のいずれかの値が設定されます。
|
BillingMode
CBSD の課金モード
| 列挙型 | |
|---|---|
BILLING_MODE_UNSPECIFIED |
課金モードが指定されていません。 |
MOBILE |
価格は、SAS に登録されている CBSD のカテゴリ(カテゴリ 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
CreateSignedDevice のリクエスト。
| フィールド | |
|---|---|
parent |
必須。親リソースの名前。 |
encoded_device |
必須。CPI 秘密鍵を使用して署名された JSON ウェブトークン。ペイロードは |
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。各デプロイは、一意のユーザー 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 Portal と 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
第 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 |
デバイスユーザーの識別子。 |
call_sign |
デバイス オペレーターのコールサイン。 |
state |
構成の状態。 |
is_signed |
出力専用。構成が CPI によって署名されているかどうか。 |
update_time |
出力専用。デバイス構成が最後に編集された日時。 |
州
デバイス構成の状態。CBSD 登録時に使用できるのは、状態が DEVICE_CONFIG_STATE_FINAL の構成のみです。
| 列挙型 | |
|---|---|
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 Portal と登録リクエストの両方でオーバーライド可能なデバイスデータ。
DeviceModel
デバイスのモデルに関する情報。
| フィールド | |
|---|---|
vendor |
デバイス ベンダーの名前。 |
name |
デバイスの機種名。 |
software_version |
デバイスのソフトウェア バージョン。 |
hardware_version |
デバイスのハードウェア バージョン。 |
firmware_version |
デバイスのファームウェア バージョン。 |
DpaMoveList
DPA の移動リストのエントリ。
| フィールド | |
|---|---|
dpa_id |
DPA の 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 |
このパラメータは、dBm/10MHz 単位のデバイスの最大 EIRP で、-127 ~+47(dBm/10 MHz)の範囲の整数です。含まれていない場合、SAS はデバイス カテゴリの dBm/10 MHz 単位の最大許容 EIRP として解釈します。 |
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 |
|
ノード
ノード。
| フィールド | |
|---|---|
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
UpdateSignedDevice のリクエスト。
| フィールド | |
|---|---|
name |
必須。更新するデバイスの名前。 |
encoded_device |
必須。CPI 秘密鍵を使用して署名された JSON ウェブトークン。ペイロードは |
installer_id |
必須。認定プロフェッショナル インストーラ データベースからの一意のインストーラ ID(CPI ID)。 |
ValidateInstallerRequest
ValidateInstaller のリクエスト。
| フィールド | |
|---|---|
installer_id |
必須。認定プロフェッショナル インストーラ データベースからの一意のインストーラ ID(CPI ID)。 |
secret |
必須。 |
encoded_secret |
必須。CPI 秘密鍵を使用して署名された JSON ウェブトークン。ペイロードには、値がシークレットである「secret」クレームが含まれている必要があります。 |
ValidateInstallerResponse
ValidateInstaller へのレスポンス。