Package spectrum.sas.portal.v1alpha1

Index

Kunden

Dienst zur Verwaltung von SAS-Kunden.

Kunde abrufen

rpc GetCustomer(GetCustomerRequest) returns (Customer)

Gibt einen angeforderten customer zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse)

Gibt eine Liste der angeforderten customers zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc UpdateCustomer(UpdateCustomerRequest) returns (Customer)

Aktualisiert eine vorhandene Bestellung (customer)

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

DeviceManager

Dienst zur Verwaltung der Citizens Broadband-Radiodienstgeräte.

Bereitstellung erstellen

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Erstellt einen neuen deployment

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/userinfo.email
Gerät erstellen

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Erstellt ein device unter einem node oder customer.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc CreateNode(CreateNodeRequest) returns (Node)

Erstellt einen neuen node

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/userinfo.email
Signiertes Gerät erstellen

rpc CreateSignedDevice(CreateSignedDeviceRequest) returns (Device)

Erstellt eine signierte device unter einem node oder customer.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/userinfo.email
Bereitstellung löschen

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

deployment wird gelöscht.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/userinfo.email
Gerät löschen

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

device wird gelöscht.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/userinfo.email
Knoten löschen

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

node wird gelöscht.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

Erstellt ein Secret für die Verwendung mit ValidateInstaller.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Gibt einen angeforderten deployment zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc GetDevice(GetDeviceRequest) returns (Device)

Ruft Details zu einem device ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc GetNode(GetNodeRequest) returns (Node)

Gibt einen angeforderten node zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Listet deployments auf.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/userinfo.email
Geräte auflisten

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Listet devices unter einem node oder customer auf.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

Listet nodes auf.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

Verschiebt eine deployment unter eine andere node oder customer.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/userinfo.email
Gerät verschieben

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

Verschiebt eine device unter eine andere node oder customer.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc MoveNode(MoveNodeRequest) returns (Operation)

Verschiebt eine node unter eine andere node oder customer.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/userinfo.email
Gerätesignatur

rpc SignDevice(SignDeviceRequest) returns (Empty)

Signiert ein device.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

Aktualisiert eine vorhandene Bestellung (deployment)

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/userinfo.email
Gerät aktualisieren

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

Aktualisiert ein device.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc UpdateNode(UpdateNodeRequest) returns (Node)

Aktualisiert eine vorhandene Bestellung (node)

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/userinfo.email
Signiertes Gerät aktualisieren

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

Aktualisiert ein signiertes device.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/userinfo.email
Installateur überprüfen

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

Hiermit wird die Identität eines zertifizierten professionellen Installateurs (CPI) bestätigt.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Richtliniendienst

Zugriffssteuerungsdienst für Spectrum Resource Manager.

Richtlinie abrufen

rpc GetPolicy(GetPolicyRequest) returns (Policy)

Ruft die Zugriffssteuerungsrichtlinie für eine Ressource ab. Gibt eine leere Richtlinie zurück, wenn die Ressource vorhanden und keine Richtlinie festgelegt ist.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc SetPolicy(SetPolicyRequest) returns (Policy)

Legt die Zugriffskontrollrichtlinie für die angegebene Ressource fest. Ersetzt jede vorhandene Richtlinie.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc TestPermissions(TestPermissionsRequest) returns (TestPermissionsResponse)

Gibt die Berechtigungen des Aufrufers für die angegebene Ressource zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Assignment

Ordnet members einer role zu.

Felder
role

string

Erforderlich. members zugewiesene Rolle.
members[]

string

Die Identitäten, denen die Rolle zugewiesen ist. Sie kann folgende Werte haben:

  • {user_email}: Eine E-Mail-Adresse, die für ein bestimmtes Google-Konto steht. Beispiel: alice@gmail.com

  • {group_email}: Eine E-Mail-Adresse, die für eine Google-Gruppe steht. Beispiel: viewers@gmail.com

Abrechnungsmodus

Abrechnungsmodus einer CBSD

Enums
BILLING_MODE_UNSPECIFIED Der Abrechnungsmodus wurde nicht angegeben.
MOBILE Der Preis basiert auf der CBSD-Kategorie: Kategorie A, Kategorie B bei SAS registriert.
FIXED_WIRELESS Der Preis richtet sich nach der Art der CBSD: Basisstation oder CPE.

Kanaltyp

Enums
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

Bereitstellungsanfrage erstellen

Anforderung für CreateDeployment.

Felder
parent

string

Erforderlich. Der Name der übergeordneten Ressource, in der die Bereitstellung erstellt werden soll.
deployment

Deployment

Erforderlich. Die Bereitstellungsdetails. name muss leer sein. Sie wird vom Server generiert. Das Deployment display_name muss festgelegt werden.

CreateDeviceRequest

Anforderung für CreateDevice.

Felder
parent

string

Erforderlich. Der Name der übergeordneten Ressource.
device

Device

Die device-Registrierungsdetails. name muss leer sein. Sie wird vom Server generiert. Die device-Felder „fcc_id“ und „serial_number“ müssen festgelegt sein. Das Feld user_id muss festgelegt werden.

Knotenanfrage erstellen

Anforderung für CreateNode.

Felder
parent

string

Erforderlich. Der Name der übergeordneten Ressource, in der der Knoten erstellt werden soll.
node

Node

Die Knotendetails. name muss leer sein. Sie wird vom Server generiert. Der Knoten display_name muss festgelegt werden.

SignedDeviceRequest erstellen

Anforderung für CreateSignedDevice.

Felder
parent

string

Erforderlich. Der Name der übergeordneten Ressource.
encoded_device

bytes

Erforderlich. JSON Web Token mit einem privaten CPI-Schlüssel signiert. Nutzlast muss die JSON-Codierung des device sein. Das Feld user_id muss festgelegt werden.
installer_id

string

Erforderlich. Eindeutige Installations-ID (CPI-ID) aus der Datenbank der zertifizierten Installateure.

Kunde

Entität, die einen SAS-Kunden darstellt.

Felder
name

string

Nur Ausgabe. Ressourcenname des Kunden.
display_name

string

Erforderlich. Name der Organisation, die die Kundenentität darstellt.
sas_user_ids[]

string

Die von den Geräten dieses Kunden verwendeten Nutzer-IDs.

Anfrage zum Löschen der Bereitstellung

Anforderung für DeleteDeployment.

Felder
name

string

Erforderlich. Der Name der deployment.

DeleteDeviceRequest

Anforderung für DeleteDevice.

Felder
name

string

Erforderlich. Der Name des Geräts.

NodeRequest löschen

Anforderung für DeleteNode.

Felder
name

string

Erforderlich. Der Name der node.

Deployment

Das Deployment.

Felder
name

string

Nur Ausgabe. Ressourcenname.
display_name

string

Der angezeigte Name der Bereitstellung.
sas_user_ids[]

string

Nutzer-ID, die von den Geräten verwendet wird, die zu dieser Bereitstellung gehören. Jeder Bereitstellung sollte eine eindeutige Nutzer-ID zugeordnet werden.
default_billing_mode

BillingMode

Standard-Abrechnungsmodus für die Bereitstellung und die zugehörigen Geräte.
allowed_billing_modes[]

BillingMode

Die zulässigen Abrechnungsmodi unter dieser Bereitstellung.

Geräte

Felder
name

string

Nur Ausgabe. Der Name des Ressourcenpfads.
fcc_id

string

Die FCC-ID des Geräts.
serial_number

string

Eine Seriennummer, die dem Gerät vom Gerätehersteller zugewiesen wurde.
preloaded_config

DeviceConfig

Konfiguration des Geräts, wie über die SAS Portal API angegeben.
active_config

DeviceConfig

Nur Ausgabe. Aktuelle Konfiguration des Geräts, die beim SAS registriert ist.
state

State

Nur Ausgabe. Gerätestatus
grants[]

DeviceGrant

Nur Ausgabe. Zuschüsse des Geräts.
display_name

string

Angezeigter Name des Geräts.
device_metadata

DeviceMetadata

Geräteparameter, die sowohl von SAS Portal- als auch SAS-Registrierungsanfragen überschrieben werden können.

Status

Status des Geräts.

Enums
DEVICE_STATE_UNSPECIFIED Nicht angegebener Zustand.
RESERVED Das Gerät wurde im SAS-Portal erstellt, aber noch nicht bei SAS registriert.
REGISTERED Gerät ist bei SAS registriert.
DEREGISTERED Registrierung des Geräts bei SAS aufgehoben.

AirAir-Schnittstelle

Informationen zur Benutzeroberfläche des Geräts.

Felder
radio_technology

RadioTechnology

Bedingt. Dieses Feld gibt die Funkzugriffstechnologie an, die für die CBSD verwendet wird.
supported_spec

string

Optional. Dieses Feld bezieht sich auf radioTechnology und enthält die Spezifikation der Benutzeroberfläche, die der CBSD zum Zeitpunkt der Registrierung entspricht.

Radiotechnologie

Die genehmigten Arten des Radiozugriffs.

Enums
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

DeviceCategory

FCC-Kategorie des Geräts gemäß Definition in Teil 96.

Enums
DEVICE_CATEGORY_UNSPECIFIED Nicht angegebene Gerätekategorie.
DEVICE_CATEGORY_A Kategorie A.
DEVICE_CATEGORY_B Kategorie B.

DeviceConfig

Informationen zur Gerätekonfiguration.

Felder
category

DeviceCategory

FCC-Kategorie des Geräts.
model

DeviceModel

Informationen zu diesem Gerätemodell.
air_interface

DeviceAirInterface

Informationen zur Benutzeroberfläche dieses Geräts.
installation_params

InstallationParams

Installationsparameter für das Gerät.
measurement_capabilities[]

MeasurementCapability

Die Funktionen für Messungsberichte des Geräts.
user_id

StringValue

Die ID eines Gerätenutzers.
call_sign

string

Das Rufzeichen des Geräteoperators.
state

State

Status der Konfiguration.
is_signed

BoolValue

Nur Ausgabe. Gibt an, ob die Konfiguration von einem CPI signiert wurde.
update_time

Timestamp

Nur Ausgabe. Der Zeitpunkt, zu dem die Gerätekonfiguration zuletzt bearbeitet wurde.

Status

Status der Gerätekonfiguration. Während der CBSD-Registrierung können nur Konfigurationen mit dem Status DEVICE_CONFIG_STATE_FINAL verwendet werden.

Enums
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

Geräteerteilung

Geräteerteilung. Es handelt sich dabei um eine vom Spectrum Access System erteilte Autorisierung, dass ein Gerät nach einem erfolgreichen Herzschlag an bestimmte Geräte übertragen werden darf.

Felder
max_eirp

DoubleValue

Maximale äquivalente isotrope Strahlungsleistung (EIRP), die durch die Förderung zugelassen wird. Der maximale EIRP-Wert wird in Einheiten von DBM/MHz angegeben. Der Wert von maxEirp steht für den durchschnittlichen (RMS) EIRP-Wert, der gemäß dem Verfahren in FCC-Teil 96.41(e)(3) gemessen wird.
frequency_range

FrequencyRange

Der Bereich der Übertragungshäufigkeit.
state

GrantState

Status der Gewährung.
channel_type

ChannelType

Typ des verwendeten Kanals.
move_list[]

DpaMoveList

Die DPA-Verschiebungslisten, in denen diese Förderung erscheint
expire_time

Timestamp

Die Ablaufzeit der Gewährung.
suspension_reason[]

string

Wenn die Förderung ausgesetzt wurde, sind die Gründe für die Sperrung angegeben.
grant_id

string

Berechtigungs-ID

Gerätemetadaten

Gerätedaten, die sowohl vom SAS-Portal als auch von Registrierungsanfragen überschrieben werden können.

Gerätemodell

Informationen zum Modell des Geräts.

Felder
vendor

string

Der Name des Geräteherstellers.
name

string

Der Name des Gerätemodells.
software_version

string

Die Softwareversion des Geräts.
hardware_version

string

Die Hardwareversion des Geräts.
firmware_version

string

Die Firmwareversion des Geräts.

DPA-Verschiebungsliste

Ein Eintrag in einer Verschiebeliste einer Datenschutzaufsichtsbehörde

Felder
dpa_id

StringValue

Die ID des Zusatzes zur Datenverarbeitung.
frequency_range

FrequencyRange

Der Häufigkeitsbereich, auf den sich die Liste zum Verschieben auswirkt.

Frequenzbereich

Häufigkeitsbereich von low_frequency bis high_frequency.

Felder
low_frequency_mhz

DoubleValue

Die niedrigste Frequenz des Frequenzbereichs in MHz.
high_frequency_mhz

DoubleValue

Die höchste Frequenz des Frequenzbereichs in MHz.

Generieren von Secret-Anfrage

Anforderung für GenerateSecret.

GenerateSecretResponse

Antwort für GenerateSecret.

Felder
secret

string

Das Secret, das vom String generiert und von ValidateInstaller verwendet wird.

GetCustomerRequest

Anforderung für GetCustomer .

Felder
name

string

Erforderlich. Der Name der customer.

Anfrage der Bereitstellung

Anforderung für GetDeployment.

Felder
name

string

Erforderlich. Der Name der deployment.

GetDeviceRequest

Anforderung für GetDevice.

Felder
name

string

Erforderlich. Der Name des Geräts.

GetNodeRequest

Anforderung für GetNode.

Felder
name

string

Erforderlich. Der Name der node.

GetPolicyRequest

Anfragenachricht für die Methode GetPolicy.

Felder
resource

string

Erforderlich. Die Ressource, für die die Richtlinie angefordert wird.

Ad Grants-Status

Der Status der Gewährung.

Enums
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED Die Gewährung wurde gewährt, aber das Gerät läuft nicht mit einem Herzschlag darauf.
GRANT_STATE_TERMINATED Die Gewährung wurde vom SAS beendet.
GRANT_STATE_SUSPENDED Die Gewährung wurde vom SAS ausgesetzt.
GRANT_STATE_AUTHORIZED Das Gerät überträgt gerade.
GRANT_STATE_EXPIRED Die Förderung ist abgelaufen.

Höhentyp

Gibt an, wie die Höhe gemessen wird.

Enums
HEIGHT_TYPE_UNSPECIFIED Unbekannter Höhentyp.
HEIGHT_TYPE_AGL Die AGL-Höhe wird relativ zur Bodenhöhe gemessen.
HEIGHT_TYPE_AMSL Die AMSL-Höhe wird relativ zum mittleren Meeresspiegel gemessen.

Installationsparameter

Informationen zu den Installationsparametern des Geräts.

Felder
latitude

DoubleValue

Breitengrad der Position der Geräteantenne in Grad bezogen auf das WGS 84-Bezugssystem. Der zulässige Bereich liegt zwischen -90,000000 und +90,000000. Positive Werte repräsentieren die Breitengrade nördlich des Äquators, negative Werte südlich des Äquators.
longitude

DoubleValue

Längengrad der Geräteantenne in Grad, bezogen auf das WGS 84-Bezugssystem. Der zulässige Bereich liegt zwischen -180.000000 und +180.000000. Positive Werte stellen die Längengrade östlich des Nullmeridians dar, negative Werte westlich des Nullmeridians.
height

DoubleValue

Höhe der Geräteantenne in Metern. Wenn der Wert des Parameters heightType "AGL" ist, sollte die Antennenhöhe relativ zum Bodenniveau angegeben werden. Wenn der Wert des Parameters heightType "AMSL" ist, wird er in Bezug auf das WGS84-Datum angegeben.
height_type

HeightType

Gibt an, wie die Höhe gemessen wird.
horizontal_accuracy

DoubleValue

Eine positive Zahl in Metern, die die Genauigkeit der horizontalen Position der Geräteantenne angibt. Dieser optionale Parameter sollte nur vorhanden sein, wenn sein Wert unter der FCC-Anforderung von 50 Metern liegt.
vertical_accuracy

DoubleValue

Eine positive Zahl in Metern, die die Genauigkeit der vertikalen Position der Geräteantenne angibt. Dieser optionale Parameter sollte nur vorhanden sein, wenn sein Wert unter der FCC-Anforderung von 3 Metern liegt.
indoor_deployment

BoolValue

Gibt an, ob die Antenne im Gerät ist oder nicht. true: drinnen. false: draußen.
antenna_azimuth

Int32Value

Richtung der horizontalen Horizontalen der Antenne in Grad bezogen auf den geografischen Norden Der Wert dieses Parameters ist eine Ganzzahl mit einem Wert zwischen 0 und 359. Ein Wert von 0 Grad bedeutet Norden. 90 Grad bedeutet Osten. Dieser Parameter ist für Geräte der Kategorie A optional und für Geräte der Kategorie B bedingt.
antenna_downtilt

Int32Value

Die Neigung der Antenne in Grad und eine Ganzzahl zwischen -90 und +90 ist. Ein negativer Wert bedeutet, dass die Antenne nach oben geneigt ist (über horizontal). Dieser Parameter ist für Geräte der Kategorie A optional und für Geräte der Kategorie B bedingt.
antenna_gain

Int32Value

Spitzen Antennengewinn in dBi Dieser Parameter ist eine Ganzzahl mit einem Wert zwischen -127 und +128 (dBi).
eirp_capability

Int32Value

Dieser Parameter ist das maximale Geräte-EIRP in Einheiten von dB/10 MHz und ist eine Ganzzahl mit einem Wert zwischen -127 und +47 (dBm/10 MHz). Falls nicht enthalten, interpretiert SAS sie als den maximal zulässigen EIRP-Wert in Einheiten von DBM/10 MHz für die Gerätekategorie.
antenna_beamwidth

Int32Value

3 dB Antennenstrahlbreite der Antenne in der horizontalen Ebene in Grad. Dieser Parameter ist eine vorzeichenlose Ganzzahl mit einem Wert zwischen 0 und 360 Grad (jeweils einschließlich). Er ist für Geräte der Kategorie A optional und für Geräte der Kategorie B bedingt.
antenna_model

string

Wenn eine externe Antenne verwendet wird, ist das Antennenmodell optional in diesem Feld enthalten. Der String hat eine maximale Länge von 128 Oktetten.
cpe_cbsd_indication

BoolValue

Falls vorhanden, gibt dieser Parameter an, ob die CBSD eine CPE-CBSD ist oder nicht.

ListCustomersRequest

Anforderung für ListCustomers.

Felder
page_size

int32

Die maximale Anzahl von customers, die in der Antwort zurückgegeben werden sollen.
page_token

string

Ein Paginierungstoken, das von einem vorherigen Aufruf an ListCustomers zurückgegeben wurde und angibt, von wo aus der Eintrag fortgesetzt werden soll.

ListCustomersResponse

Antwort für ListCustomers.

Felder
customers[]

Customer

Die Liste von customers, die der Anfrage entsprechen.
next_page_token

string

Ein Paginierungstoken, das von einem vorherigen Aufruf von ListCustomers zurückgegeben wurde und angibt, von wo aus der Eintrag fortgesetzt werden soll. Wenn das Feld fehlt oder leer ist, sind keine Kunden mehr vorhanden.

Anfrage zu Deployments auflisten

Anforderung für ListDeployments.

Felder
parent

string

Erforderlich. Der Name der übergeordneten Ressource, z. B. „"nodes/1", customer/1/nodes/2“.
page_size

int32

Die maximale Anzahl von Bereitstellungen, die in der Antwort zurückgegeben werden sollen.
page_token

string

Ein Paginierungstoken, das von einem vorherigen Aufruf an ListDeployments zurückgegeben wurde und angibt, von wo aus der Eintrag fortgesetzt werden soll.
filter

string

Der Filterausdruck. Der Filter muss folgendes Format haben: "DIRECT_CHILDREN" oder Format: "direct_children" Beim Filter wird die Groß- und Kleinschreibung nicht berücksichtigt. Wenn das Feld leer ist, werden keine Deployments gefiltert.

ListDeploymentsResponse

Antwort für ListDeployments.

Felder
deployments[]

Deployment

Die deployments, die der Anfrage entsprechen.
next_page_token

string

Ein Paginierungstoken, das von einem vorherigen Aufruf von ListDeployments zurückgegeben wurde und angibt, von wo aus der Eintrag fortgesetzt werden soll. Wenn das Feld fehlt oder leer ist, sind keine Bereitstellungen mehr vorhanden.

ListDevicesRequest

Anforderung für ListDevices.

Felder
parent

string

Erforderlich. Der Name der übergeordneten Ressource.
page_size

int32

Die maximale Anzahl von Geräten, die in der Antwort zurückgegeben werden sollen. Wenn sie leer oder null ist, werden alle Geräte aufgeführt. Muss im Bereich [0, 1000] liegen.
page_token

string

Ein Paginierungstoken, das von einem vorherigen Aufruf an ListDevices zurückgegeben wurde und angibt, von wo aus der Eintrag fortgesetzt werden soll.
filter

string

Der Filterausdruck. Der Filter sollte eines der folgenden Formate haben: "sn=123454" oder "display_name=MyDevice&quot. sn entspricht der Seriennummer des Geräts. Beim Filter wird die Groß- und Kleinschreibung nicht berücksichtigt.

ListDevicesResponse

Antwort für ListDevices.

Felder
devices[]

Device

Die devices, die der Anfrage entsprechen.
next_page_token

string

Ein Paginierungstoken, das von einem vorherigen Aufruf von ListDevices zurückgegeben wurde und angibt, von wo aus der Eintrag fortgesetzt werden soll. Wenn das Feld fehlt oder leer ist, sind keine Geräte mehr vorhanden.

ListNodesRequest

Anforderung für ListNodes.

Felder
parent

string

Erforderlich. Der Name der übergeordneten Ressource, z. B. "nodes/1".
page_size

int32

Die maximale Anzahl von Knoten, die in der Antwort zurückgegeben werden sollen.
page_token

string

Ein Paginierungstoken, das von einem vorherigen Aufruf an ListNodes zurückgegeben wurde und angibt, von wo aus der Eintrag fortgesetzt werden soll.
filter

string

Der Filterausdruck. Der Filter muss folgendes Format haben: "DIRECT_CHILDREN" oder Format: "direct_children" Beim Filter wird die Groß- und Kleinschreibung nicht berücksichtigt. Wenn das Feld leer ist, werden keine Knoten gefiltert.

ListNodesResponse

Antwort für ListNodes.

Felder
nodes[]

Node

Die nodes, die der Anfrage entsprechen.
next_page_token

string

Ein Paginierungstoken, das von einem vorherigen Aufruf von ListNodes zurückgegeben wurde und angibt, von wo aus der Eintrag fortgesetzt werden soll. Wenn das Feld fehlt oder leer ist, sind keine Knoten mehr vorhanden.

Messfunktion

Geräteanalysefunktion. Die Werte werden durch WINNF-SSC-0002 definiert.

Enums
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

Anfrage zur Datenverschiebung

Anforderung für MoveDeployment.

Felder
name

string

Erforderlich. Der Name des zu verschiebenden deployment.
destination

string

Erforderlich. Der Name der neuen übergeordneten Ressource node oder customer, unter der die Bereitstellung neu implementiert werden soll.

Geräteanfrage verschieben

Anforderung für MoveDevice.

Felder
name

string

Erforderlich. Der Name des zu verschiebenden Geräts.
destination

string

Erforderlich. Der Name der neuen übergeordneten Ressource node oder customer, unter der das Gerät neu erstellt werden soll.

Anfrage von MoveNodeRequest

Anforderung für MoveNode.

Felder
name

string

Erforderlich. Der Name des zu verschiebenden node.
destination

string

Erforderlich. Der Name der neuen übergeordneten Ressource node oder customer, unter der der Knoten neu implementiert werden soll.

Knoten

Der Knoten.

Felder
name

string

Nur Ausgabe. Ressourcenname.
display_name

string

Der angezeigte Name des Knotens.
sas_user_ids[]

string

Nutzer-IDs, die von den Geräten verwendet werden, die zu diesem Knoten gehören.

Richtlinie anwenden

Definiert eine Zugriffssteuerungsrichtlinie für die Ressourcen.

Felder
assignments[]

Assignment

Liste mit assignments
etag

bytes

Das Tag wird für eine optimistische Gleichzeitigkeitserkennung verwendet, mit der verhindert werden kann, dass sich gleichzeitige Aktualisierungen einer Richtlinie gegenseitig überschreiben. Es wird dringend empfohlen, dass Systeme das etag-Element im Lese-Bearbeitungs-Zyklus zum Lesen und Bearbeiten von Richtlinien verwenden, um Richtlinienaktualisierungen zu vermeiden: In der Antwort auf GetPolicy wird ein etag-Element zurückgegeben. Es wird erwartet, dass Systeme dieses etag-Element in die Anfrage an SetPolicy aufnehmen, damit ihre Änderung auf dieselbe Version der Richtlinie angewendet wird.

Wenn im Aufruf von GetPolicy kein ETag enthalten ist, wird die vorhandene Richtlinie blind überschrieben.

Anforderungsrichtlinie

Anfragenachricht für die Methode SetPolicy.

Felder
resource

string

Erforderlich. Die Ressource, für die die Richtlinie angegeben wird. Diese Richtlinie ersetzt alle vorhandenen Richtlinien.
policy

Policy

Erforderlich. Die Richtlinie, die auf resource angewendet werden soll.

Geräteanfrage signieren

Anforderung für SignDevice.

Felder
device

Device

Erforderlich. Der zu unterzeichnende device. Die device-Felder „name“, „fcc_id“ und „serial_number“ müssen festgelegt sein. Das Feld user_id muss festgelegt werden.

TestPermissionsRequest

Anfragenachricht für die Methode TestPermissions.

Felder
resource

string

Erforderlich. Die Ressource, für die die Berechtigungen angefordert werden.
permissions[]

string

Die Berechtigungen, die für die resource geprüft werden sollen.

TestPermissionsResponse

Antwortnachricht für die Methode TestPermissions.

Felder
permissions[]

string

Eine Reihe von Berechtigungen, die dem Aufrufer erlaubt sind.

UpdateCustomerRequest

Anforderung für UpdateCustomer.

Felder
customer

Customer

Erforderlich. Die neuen Werte für customer. Für den Kunden müssen name und display_name festgelegt sein.
update_mask

FieldMask

Zu aktualisierende Felder.

Anfrage zur Aktualisierungsbereitstellung

Anforderung für UpdateDeployment.

Felder
deployment

Deployment

Erforderlich. Die neuen Werte für deployment. name und display_name müssen festgelegt werden.
update_mask

FieldMask

Zu aktualisierende Felder.

UpdateDeviceRequest

Anforderung für UpdateDevice.

Felder
device

Device

Erforderlich. Das zu aktualisierende device. Die device-Felder „name“, „fcc_id“ und „serial_number“ müssen festgelegt sein. Das Feld user_id muss festgelegt werden.
update_mask

FieldMask

Zu aktualisierende Felder.

UpdateNodeRequest

Anforderung für UpdateNode.

Felder
node

Node

Erforderlich. Die neuen Werte für node. name und display_name müssen festgelegt werden.
update_mask

FieldMask

Zu aktualisierende Felder.

SignedDeviceRequest aktualisieren

Anforderung für UpdateSignedDevice.

Felder
name

string

Erforderlich. Der Name des Geräts, das aktualisiert werden soll.
encoded_device

bytes

Erforderlich. Das JSON Web Token, das mit einem privaten CPI-Schlüssel signiert wird. Nutzlast muss die JSON-Codierung des device sein. Das Feld user_id muss festgelegt werden.
installer_id

string

Erforderlich. Eindeutige Installations-ID (CPI-ID) aus der Datenbank der zertifizierten Installateure.

InstallerRequest validieren

Anforderung für ValidateInstaller.

Felder
installer_id

string

Erforderlich. Eindeutige Installations-ID (CPI-ID) aus der Datenbank der zertifizierten Installateure.
secret

string

Erforderlich. Secret wurde von GenerateSecret zurückgegeben.
encoded_secret

string

Erforderlich. JSON Web Token mit einem privaten CPI-Schlüssel signiert. Die Nutzlast muss die Anforderung "secret" enthalten, deren Wert das Secret ist.

ValidateInstallerResponse

Antwort für ValidateInstaller.