Package spectrum.sas.portal.v1alpha1

Indeks

Klienci

Usługa do zarządzania klientami SAS.

Pobranie klienta

rpc GetCustomer(GetCustomerRequest) returns (Customer)

Zwraca żądaną wartość customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Wyświetlanie listy klientów

rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse)

Zwraca listę żądanych elementów customers.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc UpdateCustomer(UpdateCustomerRequest) returns (Customer)

Aktualizuje obecne customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Menedżer urządzeń

Usługa zarządzania urządzeniami radiowymi obywatelskimi.

Utworzenie wdrożenia

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Tworzy nowy element: deployment.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Utworzenie urządzenia

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Tworzy device w node lub customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Utworzenie węzła

rpc CreateNode(CreateNodeRequest) returns (Node)

Tworzy nowy element: node.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc CreateSignedDevice(CreateSignedDeviceRequest) returns (Device)

Tworzy podpisany device w node lub customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Usuń wdrożenie

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Usuwa deployment.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Usunięcie urządzenia

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Usuwa device.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

Usuwa node.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Wygeneruj tajny klucz

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

Generuje obiekt tajny do użycia w: ValidateInstaller.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Pobranie wdrożenia

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Zwraca żądaną wartość deployment.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Pobranie urządzenia

rpc GetDevice(GetDeviceRequest) returns (Device)

Otrzymuje szczegółowe informacje o tagu device.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Pobieranie węzła

rpc GetNode(GetNodeRequest) returns (Node)

Zwraca żądaną wartość node.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Wyświetlenie listy wdrożeń

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Wyświetla listę deployments.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Wyświetlanie listy urządzeń

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Wyświetla listę devices pod etykietą node lub customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Lista węzłów

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

Wyświetla listę nodes.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Wdrażanie wdrożenia

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

Przenoszę element deployment pod inny node lub customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Przenieś urządzenie

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

Przenoszę element device pod inny node lub customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Węzeł przenoszenia

rpc MoveNode(MoveNodeRequest) returns (Operation)

Przenoszę element node pod inny node lub customer.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc SignDevice(SignDeviceRequest) returns (Empty)

Podpis: device.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Aktualizowanie wdrożenia

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

Aktualizuje obecne deployment.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Aktualizacja urządzenia

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

Aktualizuje device.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/userinfo.email
Zaktualizuj węzeł

rpc UpdateNode(UpdateNodeRequest) returns (Node)

Aktualizuje obecne node.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

Aktualizuje podpisane device.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

Weryfikuje tożsamość certyfikowanego instalatora (CPI).

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Usługa zasad

Usługa kontroli dostępu do menedżera zasobów Spectrum.

Uzyskaj zasady

rpc GetPolicy(GetPolicyRequest) returns (Policy)

Pobiera zasadę kontroli dostępu do zasobu. Zwraca pustą zasadę, jeśli zasób istnieje i nie ma ustawionych zasad.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc SetPolicy(SetPolicyRequest) returns (Policy)

Ustawia zasadę kontroli dostępu do określonego zasobu. Zastępuje istniejące zasady.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

rpc TestPermissions(TestPermissionsRequest) returns (TestPermissionsResponse)

Zwraca uprawnienia, które rozmówca ma w odniesieniu do określonego zasobu.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Projekt

Powiąże zadanie members z: role.

Pola
role

string

Wymagany. Rola przypisana do użytkownika members.
members[]

string

Tożsamości, do których przypisana jest rola. Może zawierać te wartości:

  • {user_email}: adres e-mail reprezentujący konkretne konto Google. Na przykład: alice@gmail.com.

  • {group_email}: adres e-mail reprezentujący grupę dyskusyjną Google. Na przykład: viewers@gmail.com.

Tryb płatności

Tryb rozliczeniowy CBSD

Wartości w polu enum
BILLING_MODE_UNSPECIFIED Tryb rozliczeniowy nie został określony.
MOBILE Cena została określona na podstawie kategorii CBSD: kategorii A i B zarejestrowanej w SAS.
FIXED_WIRELESS Cena zależy od strefy CBSD: stacji bazowej lub CPE.

Typ kanału

Wartości w polu enum
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

Utwórz żądanie wdrożenia

Prośba o CreateDeployment.

Pola
parent

string

Wymagany. Nazwa zasobu nadrzędnego, w którym zostanie utworzone wdrożenie.
deployment

Deployment

Wymagany. Szczegóły wdrożenia. Pole name musi być puste. Jest on generowany przez serwer. Należy ustawić wdrożenie display_name.

Utworzenie żądania urządzenia

Prośba o CreateDevice.

Pola
parent

string

Wymagany. Nazwa zasobu nadrzędnego.
device

Device

Szczegóły rejestracji device. Pole name musi być puste. Jest on generowany przez serwer. Musisz ustawić pola device fcc_id i serial_number. Pole user_id musi być ustawione.

Utwórz żądanie węzła

Prośba o CreateNode.

Pola
parent

string

Wymagany. Nazwa zasobu nadrzędnego, w którym ma zostać utworzony węzeł.
node

Node

Szczegóły węzła. Pole name musi być puste. Jest on generowany przez serwer. Węzeł display_name musi być ustawiony.

Utworzenie żądania DeviceSignedDevice

Prośba o CreateSignedDevice.

Pola
parent

string

Wymagany. Nazwa zasobu nadrzędnego.
encoded_device

bytes

Wymagany. Token internetowy JSON podpisany kluczem prywatnym CPI. Ładunek musi być kodowaniem JSON właściwości device. Pole user_id musi być ustawione.
installer_id

string

Wymagany. Unikalny identyfikator instalatora (identyfikator CPI) pochodzący z bazy danych Certyfikowanych instalatorów.

Klient

Podmiot reprezentujący klienta SAS.

Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu klienta.
display_name

string

Wymagany. Nazwa organizacji reprezentowanej przez klienta.
sas_user_ids[]

string

Identyfikatory użytkowników używane przez urządzenia należące do tego klienta.

Usunięcie żądania wdrożenia

Prośba o DeleteDeployment.

Pola
name

string

Wymagany. Nazwa elementu deployment.

Usunięcie urządzenia

Prośba o DeleteDevice.

Pola
name

string

Wymagany. Nazwa urządzenia.

Żądanie usunięcia węzła

Prośba o DeleteNode.

Pola
name

string

Wymagany. Nazwa elementu node.

Wdrażanie

Wdrożenie.

Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu.
display_name

string

Wyświetlana nazwa wdrożenia.
sas_user_ids[]

string

Identyfikator użytkownika używany przez urządzenia należące do tego wdrożenia. Każde wdrożenie powinno być powiązane z 1 unikalnym identyfikatorem użytkownika.
default_billing_mode

BillingMode

Domyślny tryb płatności dla wdrożenia i urządzeń, które się w nim znajdują.
allowed_billing_modes[]

BillingMode

Dozwolone tryby płatności w ramach tego wdrożenia.

Urządzenie

Pola
name

string

Tylko dane wyjściowe. Nazwa ścieżki zasobu.
fcc_id

string

Identyfikator FCC urządzenia.
serial_number

string

Numer seryjny przypisany do urządzenia przez producenta.
preloaded_config

DeviceConfig

Konfiguracja urządzenia określona za pomocą interfejsu SAS Portal API.
active_config

DeviceConfig

Tylko dane wyjściowe. Obecna konfiguracja urządzenia zarejestrowana w SAS.
state

State

Tylko dane wyjściowe. Stan urządzenia.
grants[]

DeviceGrant

Tylko dane wyjściowe. Przyznane urządzenia.
display_name

string

Wyświetlana nazwa urządzenia.
device_metadata

DeviceMetadata

Parametry urządzenia, które mogą być zastąpione przez żądania rejestracji w portalu SAS i żądania SAS.

Stan

Stan urządzenia.

Wartości w polu enum
DEVICE_STATE_UNSPECIFIED Nieokreślony stan.
RESERVED Urządzenie utworzone w portalu SAS, ale niezarejestrowane jeszcze w SAS.
REGISTERED Urządzenie zarejestrowane w SAS.
DEREGISTERED Urządzenie zostało wyrejestrowane przez SAS.

Interfejs urządzenia AirAir

Informacje o interfejsie powietrza w urządzeniu.

Pola
radio_technology

RadioTechnology

Tryb warunkowy. To pole określa technologię dostępu radiową używaną w przypadku CBSD.
supported_spec

string

Opcjonalne. To pole jest związane z dokumentem radioTechnology i zawiera specyfikację interfejsu lotniczego, z którą zgodne jest CBSD w momencie rejestracji.

Technologia radiowa

Zatwierdzone rodzaje technologii dostępu radiowego.

Wartości w polu enum
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

Kategoria urządzenia

Kategoria FCC dotycząca urządzenia określona w sekcji 96.

Wartości w polu enum
DEVICE_CATEGORY_UNSPECIFIED Nieokreślona kategoria urządzenia.
DEVICE_CATEGORY_A Kategoria A.
DEVICE_CATEGORY_B Kategoria B.

Konfiguracja urządzenia

Informacje o konfiguracji urządzenia.

Pola
category

DeviceCategory

Kategoria FCC na urządzeniu.
model

DeviceModel

Informacje o tym modelu urządzenia.
air_interface

DeviceAirInterface

Informacje o interfejsie powietrza na tym urządzeniu.
installation_params

InstallationParams

Parametry instalacji urządzenia.
measurement_capabilities[]

MeasurementCapability

Uprawnienia do raportowania pomiarów urządzenia.
user_id

StringValue

Identyfikator użytkownika urządzenia.
call_sign

string

Znak wywołania operatora urządzenia.
state

State

Stan konfiguracji.
is_signed

BoolValue

Tylko dane wyjściowe. Określa, czy konfiguracja została podpisana przez CPI.
update_time

Timestamp

Tylko dane wyjściowe. data ostatniej modyfikacji konfiguracji urządzenia,

Stan

Stan konfiguracji urządzenia. Podczas rejestracji zarządzania przeglądarką Chrome w chmurze można używać tylko konfiguracji w stanie DEVICE_CONFIG_STATE_FINAL.

Wartości w polu enum
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

Przyznanie urządzeń

Przyznanie urządzenia. To autoryzacja zapewniana przez system dostępu do Spectrum do przesyłania na podstawie określonych parametrów operacyjnych po udanym tętnie urządzenia.

Pola
max_eirp

DoubleValue

Maksymalna równoważna siła promieniowania izotropowego (EIRP) dozwolona w przypadku przyznania. Maksymalna EIRP to jednostki dBm/MHz. Wartość maxEirp odpowiada średniemu EIRP (RMS), który można zmierzyć za pomocą procedury określonej w FCC części 96.41(e)(3).
frequency_range

FrequencyRange

Zakres częstotliwości przesyłania.
state

GrantState

Stan grantu.
channel_type

ChannelType

Typ użytego kanału.
move_list[]

DpaMoveList

Listy Aneksu o przetwarzaniu danych, w których pojawiają się te granty.
expire_time

Timestamp

Data ważności grantu.
suspension_reason[]

string

Przyczyny zawieszenia konta z powodu zawieszenia.
grant_id

string

Identyfikator przyznania.

Metadane urządzenia

Dane urządzenia mogą być zastąpione przez portal SAS i żądania rejestracji.

Model urządzenia

Informacje o modelu urządzenia.

Pola
vendor

string

Nazwa dostawcy urządzenia.
name

string

Nazwa modelu urządzenia.
software_version

string

Wersja oprogramowania urządzenia.
hardware_version

string

Wersja sprzętowa urządzenia.
firmware_version

string

Wersja oprogramowania układowego urządzenia.

Lista DpaMoves

Wpis na liście Aneksów o przetwarzaniu danych.

Pola
dpa_id

StringValue

Identyfikator organu ochrony danych.
frequency_range

FrequencyRange

Zakres częstotliwości wpływający na listę przeniesienia.

Zakres częstotliwości

Zakres częstotliwości od low_frequency do high_frequency.

Pola
low_frequency_mhz

DoubleValue

Najniższa częstotliwość zakresu częstotliwości w MHz.
high_frequency_mhz

DoubleValue

Najwyższa częstotliwość zakresu częstotliwości w MHz.

Wygeneruj tajny klucz

Prośba o GenerateSecret.

Wygeneruj tajny klucz

Odpowiedź dotycząca: GenerateSecret.

Pola
secret

string

Tajny klucz wygenerowany przez ciąg znaków i używany przez ValidateInstaller.

GetCustomerRequest

Prośba o GetCustomer .

Pola
name

string

Wymagany. Nazwa elementu customer.

Pobranie żądania wdrożenia

Prośba o GetDeployment.

Pola
name

string

Wymagany. Nazwa elementu deployment.

Pobranie żądania urządzenia

Prośba o GetDevice.

Pola
name

string

Wymagany. Nazwa urządzenia.

Żądanie GetNode

Prośba o GetNode.

Pola
name

string

Wymagany. Nazwa elementu node.

Żądanie GetPolicyPolicy

Wyślij prośbę o metodę GetPolicy.

Pola
resource

string

Wymagany. Zasób, którego dotyczy zasada.

GrantState,

Stan grantu.

Wartości w polu enum
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED Przyznano grant, ale urządzenie nie bije serduszka.
GRANT_STATE_TERMINATED Dotacja została zakończona przez SAS.
GRANT_STATE_SUSPENDED Dotacja została zawieszona przez platformę SAS.
GRANT_STATE_AUTHORIZED Trwa przesyłanie urządzenia.
GRANT_STATE_EXPIRED Grant wygasł.

Typ wzrostu

Określa sposób pomiaru wysokości.

Wartości w polu enum
HEIGHT_TYPE_UNSPECIFIED Nieokreślony typ wzrostu.
HEIGHT_TYPE_AGL Wysokość AGL jest mierzona w odniesieniu do poziomu gruntu.
HEIGHT_TYPE_AMSL Wysokość AMSL jest mierzona w stosunku do średniego poziomu morza.

Etapy instalacji

Informacje o parametrach instalacji urządzeń.

Pola
latitude

DoubleValue

Szerokość geograficzna anteny urządzenia w stopniach względem punktu odniesienia WGS 84. Dozwolony zakres to od -90.000000 do +90.000000. Wartości dodatnie oznaczają szerokość geograficzną na północ od równika, wartości ujemne na południe od równika.
longitude

DoubleValue

Długość geograficzna anteny urządzenia w stopniach względem punktu odniesienia WGS 84. Dozwolony zakres wynosi od -180 000 000 do +180 000 000. Wartości dodatnie oznaczają długość geograficzną na wschód od południka zerowego; wartości ujemne na zachód od południka zerowego.
height

DoubleValue

Wysokość anteny urządzenia: m. Gdy wartość parametru heightType to "AGL", wysokość anteny należy podać względem poziomu gruntu. Gdy wartość parametru heightType to "AMSL", jest ona podawana w odniesieniu do punktu odniesienia WGS84.
height_type

HeightType

Określa sposób pomiaru wysokości.
horizontal_accuracy

DoubleValue

Wartość dodatnia w metrach, która wskazuje dokładność anteny urządzenia w poziomie. Ten opcjonalny parametr powinien być podany tylko wtedy, gdy jego wartość jest mniejsza niż zgodnie z wymaganiami FCC (50 metrów).
vertical_accuracy

DoubleValue

Wartość dodatnia (w metrach), która wskazuje dokładną lokalizację anteny urządzenia. Ten opcjonalny parametr powinien być podany tylko wtedy, gdy jego wartość jest mniejsza niż wymagane przez FCC (3 metry).
indoor_deployment

BoolValue

Czy antena urządzenia jest wewnątrz, czy nie. true: wewnątrz. false: na zewnątrz.
antenna_azimuth

Int32Value

Kierunek obserwacyjny poziomej płazy anteny w stopniach względem prawdziwej północy. Wartość tego parametru jest liczbą całkowitą z zakresu od 0 do 359 włącznie. Wartość 0 stopni oznacza prawdziwą północ, a 90 stopni oznacza wschód. Ten parametr jest opcjonalny w przypadku urządzeń kategorii A i warunkowych w przypadku urządzeń B.
antenna_downtilt

Int32Value

Przechylenie anteny w stopniach to liczba całkowita z zakresem od -90 do +90 włącznie. Wartość ujemna oznacza, że antena jest przechylona do góry (poziomo). Ten parametr jest opcjonalny w przypadku urządzeń kategorii A i warunkowych w przypadku urządzeń B.
antenna_gain

Int32Value

Szczytowa wartość anteny w dBi. Ten parametr to liczba całkowita z wartością od -127 do +128 (dBi).
eirp_capability

Int32Value

Ten parametr określa maksymalną wartość EIRP urządzenia w dBm/10 MHz i jest liczbą całkowitą z zakresu od -127 do +47 (dBm/10 MHz) włącznie. Jeśli nie zostanie podany, funkcja SAS interpretuje ją jako maksymalną dozwoloną wartość EIRP w jednostkach dBm/10 MHz dla kategorii urządzenia.
antenna_beamwidth

Int32Value

Antena 3 dB anteny na płaszczyźnie poziomej. Ten parametr to niepodpisana liczba całkowita z wartością od 0 do 360 stopni (włącznie). W przypadku urządzeń z kategorii A jest opcjonalna, a w przypadku urządzeń B – warunkowa.
antenna_model

string

Jeśli korzystasz z anteny zewnętrznej, w tym polu podany jest model anteny. Ciąg może mieć maksymalnie 128 oktetów.
cpe_cbsd_indication

BoolValue

Jeśli ten parametr jest obecny, określa, czy CBSD to CPE-CBSD.

Żądanie ListCustomers

Prośba o ListCustomers.

Pola
page_size

int32

Maksymalna liczba wartości customers zwracana w odpowiedzi.
page_token

string

Token podziału na strony zwrócony z poprzedniego wywołania do ListCustomers, który wskazuje, gdzie powinien zaczynać się ten wpis.

OdpowiedźListCustomers

Odpowiedź dotycząca: ListCustomers.

Pola
customers[]

Customer

Lista elementów customers pasujących do żądania.
next_page_token

string

Token, podzielony na strony z poprzedniego wywołania do ListCustomers, wskazuje, gdzie należy kontynuować wpis. Jeśli brakuje tego pola lub jest ono puste, oznacza to, że nie ma więcej klientów.

Wyświetlenie listy próśb o wdrożenie

Prośba o ListDeployments.

Pola
parent

string

Wymagany. Nazwa zasobu nadrzędnego, np. "nodes/1" client/1/nodes/2.
page_size

int32

Maksymalna liczba wdrożeń, które zostaną zwrócone w odpowiedzi.
page_token

string

Token podziału na strony zwrócony z poprzedniego wywołania do ListDeployments, który wskazuje, gdzie powinien zaczynać się ten wpis.
filter

string

Wyrażenie filtra. Filtr powinien mieć format: "DIRECT_CHILDREN" lub format: "direct_children". Filtr nie uwzględnia wielkości liter. Jeśli to pole jest puste, wdrożenia nie są filtrowane.

Odpowiedź o listach wdrożeń

Odpowiedź dotycząca: ListDeployments.

Pola
deployments[]

Deployment

deployments zgodny z żądaniem.
next_page_token

string

Token, podzielony na strony z poprzedniego wywołania do ListDeployments, wskazuje, gdzie należy kontynuować wpis. Jeśli brakuje tego pola lub jest ono puste, oznacza to, że nie ma więcej wdrożeń.

Wyświetlanie listy urządzeń

Prośba o ListDevices.

Pola
parent

string

Wymagany. Nazwa zasobu nadrzędnego.
page_size

int32

Maksymalna liczba urządzeń, które zostaną zwrócone w odpowiedzi. Jeśli nic nie ma lub nie ma żadnej wartości, wyświetlane są wszystkie urządzenia. Musi się mieścić w zakresie [0, 1000].
page_token

string

Token podziału na strony zwrócony z poprzedniego wywołania do ListDevices, który wskazuje, gdzie powinien zaczynać się ten wpis.
filter

string

Wyrażenie filtra. Filtr powinien mieć jeden z tych formatów: "sn=123454" lub "display_name=Moje urządzenie". sn oznacza numer seryjny urządzenia. Filtr nie uwzględnia wielkości liter.

Odpowiedź ListDevices

Odpowiedź dotycząca: ListDevices.

Pola
devices[]

Device

devices zgodny z żądaniem.
next_page_token

string

Token, podzielony na strony z poprzedniego wywołania do ListDevices, wskazuje, gdzie należy kontynuować wpis. Jeśli nie ma tego pola lub jest ono puste, oznacza to, że nie ma więcej urządzeń.

Żądanie ListNodes

Prośba o ListNodes.

Pola
parent

string

Wymagany. Nazwa zasobu nadrzędnego, na przykład "nodes/1".
page_size

int32

Maksymalna liczba węzłów do zwrócenia w odpowiedzi.
page_token

string

Token podziału na strony zwrócony z poprzedniego wywołania do ListNodes, który wskazuje, gdzie powinien zaczynać się ten wpis.
filter

string

Wyrażenie filtra. Filtr powinien mieć format: "DIRECT_CHILDREN" lub format: "direct_children". Filtr nie uwzględnia wielkości liter. Brak wartości oznacza, że żadne węzły nie są filtrowane.

Odpowiedź ListNodesResponse

Odpowiedź dotycząca: ListNodes.

Pola
nodes[]

Node

nodes zgodny z żądaniem.
next_page_token

string

Token, podzielony na strony z poprzedniego wywołania do ListNodes, wskazuje, gdzie należy kontynuować wpis. Jeśli brakuje pola lub jest ono puste, oznacza to, że nie ma więcej węzłów.

Możliwość pomiaru

Możliwość pomiaru urządzenia. Wartości są zdefiniowane przez WINNF-SSC-0002.

Wartości w polu enum
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

Prośba o przeniesienie

Prośba o MoveDeployment.

Pola
name

string

Wymagany. Nazwa elementu deployment do przeniesienia.
destination

string

Wymagany. Nazwa nowego zasobu nadrzędnego node lub customer, w której chcesz przywrócić wdrożenie.

Żądanie przeniesienia urządzenia

Prośba o MoveDevice.

Pola
name

string

Wymagany. Nazwa urządzenia, które chcesz przenieść.
destination

string

Wymagany. Nazwa nowego zasobu nadrzędnego node lub customer, w której chcesz przywrócić urządzenie.

Żądanie nodeNode

Prośba o MoveNode.

Pola
name

string

Wymagany. Nazwa elementu node do przeniesienia.
destination

string

Wymagany. Nazwa nowego zasobu nadrzędnego node lub customer, w której chcesz przywrócić węzeł.

Węzeł

Węzeł.

Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu.
display_name

string

Wyświetlana nazwa węzła.
sas_user_ids[]

string

Identyfikatory użytkowników używane przez urządzenia należące do tego węzła.

Zasady

Określa zasadę kontroli dostępu do zasobów.

Pola
assignments[]

Assignment

Lista assignments
etag

bytes

Tag ten służy do optymalnej kontroli równoczesności, która ma na celu zapobieganie jednoczesnemu przesyłaniu zasad. Zdecydowanie zaleca się, aby w systemach do odczytu i zapisu w celu uniknięcia warunków wyścigu tag korzystał z tagu w trybie do odczytu i zapisu: w odpowiedzi na żądanie GetPolicy tag zostanie zwrócony, a systemy powinny umieścić ten tag w żądaniu do SetPolicy, by zapewnić, że zmiana zostanie zastosowana do tej samej wersji zasady.

Jeśli w wywołaniu funkcji GetPolicy nie ma żadnego tagu, obecna zasada jest zaślepiona.

Żądanie ustawienia zasad

Wyślij prośbę o metodę SetPolicy.

Pola
resource

string

Wymagany. Zasób, dla którego określono zasadę. Ta zasada zastępuje wszystkie istniejące zasady.
policy

Policy

Wymagany. Zasada, którą mają zostać zastosowane resource.

Podpisywanie urządzenia

Prośba o SignDevice.

Pola
device

Device

Wymagany. device do podpisania. Musisz ustawić pola device name, fcc_id i serial_number. Pole user_id musi być ustawione.

Żądanie uprawnień

Wyślij prośbę o metodę TestPermissions.

Pola
resource

string

Wymagany. Zasób, do którego wymagane są uprawnienia.
permissions[]

string

Zestaw uprawnień do sprawdzenia w przypadku resource.

Testowanie uprawnień

Odpowiedź na metodę TestPermissions.

Pola
permissions[]

string

Zestaw uprawnień, które rozmówca jest dozwolony.

Żądanie klienta

Prośba o UpdateCustomer.

Pola
customer

Customer

Wymagany. Nowe wartości w polu customer. Klient musi ustawić właściwości name i display_name.
update_mask

FieldMask

Pola do zaktualizowania.

Aktualizacja żądania wdrożenia

Prośba o UpdateDeployment.

Pola
deployment

Deployment

Wymagany. Nowe wartości w polu deployment. Należy ustawić zasady name i display_name.
update_mask

FieldMask

Pola do zaktualizowania.

Żądanie aktualizacji urządzenia

Prośba o UpdateDevice.

Pola
device

Device

Wymagany. device do zaktualizowania. Musisz ustawić pola device name, fcc_id i serial_number. Pole user_id musi być ustawione.
update_mask

FieldMask

Pola do zaktualizowania.

Żądanie UpdateNode

Prośba o UpdateNode.

Pola
node

Node

Wymagany. Nowe wartości w polu node. Należy ustawić zasady name i display_name.
update_mask

FieldMask

Pola do zaktualizowania.

UpdateSignedDeviceRequest

Prośba o UpdateSignedDevice.

Pola
name

string

Wymagany. Nazwa urządzenia, które chcesz zaktualizować.
encoded_device

bytes

Wymagany. Token internetowy JSON podpisany kluczem prywatnym CPI. Ładunek musi być kodowaniem JSON właściwości device. Pole user_id musi być ustawione.
installer_id

string

Wymagany. Unikalny identyfikator instalatora (identyfikator CPI) pochodzący z bazy danych Certyfikowanych instalatorów.

ValidateInstallerRequest

Prośba o ValidateInstaller.

Pola
installer_id

string

Wymagany. Unikalny identyfikator instalatora (identyfikator CPI) pochodzący z bazy danych Certyfikowanych instalatorów.
secret

string

Wymagany. Obiekt tajny zwracany przez GenerateSecret.
encoded_secret

string

Wymagany. Token internetowy JSON podpisany kluczem prywatnym CPI. Ładunek musi zawierać obiekt "secret", którego wartość jest sekretem.

ValidateInstallerResponse

Odpowiedź dotycząca: ValidateInstaller.