Package spectrum.sas.portal.v1alpha1

Index

Kunden

Dienst zur Verwaltung von SAS-Kunden.

GetCustomer

rpc GetCustomer(GetCustomerRequest) returns (Customer)

Gibt ein angefordertes customer zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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
UpdateCustomer

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 von CBRS-Geräten (Citizens Broadband Radio Service).

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Erstellt einen neuen deployment

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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
CreateNode

rpc CreateNode(CreateNodeRequest) returns (Node)

Erstellt einen neuen node

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Löscht einen deployment.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Löscht einen device.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

Löscht einen node.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

Generiert ein Secret, das mit ValidateInstaller verwendet werden soll.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Gibt ein angefordertes 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
GetNode

rpc GetNode(GetNodeRequest) returns (Node)

Gibt ein angefordertes node zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Listen deployments.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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
ListNodes

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

Listen nodes.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

Verschiebt ein deployment unter ein anderes node oder customer.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

Verschiebt ein device unter ein anderes node oder customer.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc MoveNode(MoveNodeRequest) returns (Operation)

Verschiebt ein node unter ein anderes node oder customer.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc SignDevice(SignDeviceRequest) returns (Empty)

Signiert einen device.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

Aktualisiert eine vorhandene Bestellung (deployment)

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

Aktualisiert ein device.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc UpdateNode(UpdateNodeRequest) returns (Node)

Aktualisiert eine vorhandene Bestellung (node)

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

Aktualisiert eine signierte device.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

Validiert die Identität eines zertifizierten professionellen Installateurs (CPI).

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

PolicyService

Access Control Service für Spectrum Resource Manager.

GetPolicy

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
TestPermissions

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 die folgenden 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.

BillingMode

Abrechnungsmodus eines CBSD

Enums
BILLING_MODE_UNSPECIFIED Der Abrechnungsmodus wurde nicht angegeben.
MOBILE Der Preis richtet sich nach der Kategorie des CBSD: Kategorie A oder Kategorie B, registriert bei SAS.
FIXED_WIRELESS Der Preis richtet sich nach dem Typ des CBSD: Basisstation oder CPE.

ChannelType

Enums
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

CreateDeploymentRequest

Anfrage 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. Die Bereitstellung display_name muss festgelegt werden.

CreateDeviceRequest

Anfrage 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 werden. Das Feld user_id muss festgelegt werden.

CreateNodeRequest

Anfrage 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.

CreateSignedDeviceRequest

Anfrage für CreateSignedDevice.

Felder
parent

string

Erforderlich. Der Name der übergeordneten Ressource.

encoded_device

bytes

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

installer_id

string

Erforderlich. Eindeutige ID des Installateurs (CPI-ID) aus der Datenbank für zertifizierte professionelle 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

Nutzer-IDs, die von den Geräten dieses Kunden verwendet werden.

DeleteDeploymentRequest

Anfrage für DeleteDeployment.

Felder
name

string

Erforderlich. Der Name der deployment.

DeleteDeviceRequest

Anfrage für DeleteDevice.

Felder
name

string

Erforderlich. Der Name des Geräts.

DeleteNodeRequest

Anfrage für DeleteNode.

Felder
name

string

Erforderlich. Der Name der node.

Bereitstellung

Das Deployment.

Felder
name

string

Nur Ausgabe. Ressourcenname.

display_name

string

Der Anzeigename der Bereitstellung.

sas_user_ids[]

string

Die Nutzer-ID, die von den Geräten verwendet wird, die zu dieser Bereitstellung gehören. Jede Bereitstellung sollte mit einer eindeutigen Nutzer-ID verknüpft sein.

default_billing_mode

BillingMode

Standardabrechnungsmodus für die Bereitstellung und die zugehörigen Geräte.

allowed_billing_modes[]

BillingMode

Die zulässigen Abrechnungsmodi für diese Bereitstellung.

Gerät

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, wie es bei der SAS registriert ist.

state

State

Nur Ausgabe. Gerätestatus.

grants[]

DeviceGrant

Nur Ausgabe. Vom Gerät gehaltene Berechtigungen.

display_name

string

Anzeigename des Geräts.

device_metadata

DeviceMetadata

Geräteparameter, die sowohl vom SAS-Portal als auch von 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, ist aber noch nicht bei SAS registriert.
REGISTERED Das Gerät ist bei SAS registriert.
DEREGISTERED Die Registrierung des Geräts bei SAS wurde aufgehoben.

DeviceAirInterface

Informationen zur Luftschnittstelle des Geräts.

Felder
radio_technology

RadioTechnology

Bedingt. In diesem Feld wird die Funkzugangstechnologie angegeben, die für das CBSD verwendet wird.

supported_spec

string

Optional. Dieses Feld bezieht sich auf radioTechnology und enthält die Spezifikation der Luftschnittstelle, die das CBSD zum Zeitpunkt der Registrierung erfüllt.

RadioTechnology

Die genehmigten Arten von Funkzugangstechnologie.

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äß Part 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 Luftschnittstelle dieses Geräts.

installation_params

InstallationParams

Installationsparameter für das Gerät.

measurement_capabilities[]

MeasurementCapability

Funktionen des Geräts für die Analyseberichterstellung.

user_id

StringValue

Die Kennung eines Gerätenutzers.

call_sign

string

Das Rufzeichen des Gerätebedieners.

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 der letzten Bearbeitung der Gerätekonfiguration.

Status

Status der Gerätekonfiguration. Nur Konfigurationen im Status DEVICE_CONFIG_STATE_FINAL können bei der CBSD-Registrierung verwendet werden.

Enums
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

DeviceGrant

Geräteberechtigung. Es handelt sich um eine Autorisierung, die vom Spectrum Access System für ein Gerät bereitgestellt wird, um nach einem erfolgreichen Heartbeat des Geräts mit den angegebenen Betriebsparametern zu senden.

Felder
max_eirp

DoubleValue

Die maximal zulässige äquivalente isotrope Strahlungsleistung (EIRP) gemäß der Genehmigung. Die maximale EIRP wird in dBm/MHz angegeben. Der Wert von maxEirp steht für die durchschnittliche (RMS) EIRP, die mit dem in FCC-Teil 96.41(e)(3) definierten Verfahren gemessen würde.

frequency_range

FrequencyRange

Der Übertragungsfrequenzbereich.

state

GrantState

Status der Gewährung.

channel_type

ChannelType

Verwendeter Channneltyp.

move_list[]

DpaMoveList

Die DPA-Umzugslisten, auf denen diese Einwilligung erscheint.

expire_time

Timestamp

Die Ablaufzeit der Erteilung.

suspension_reason[]

string

Wenn die Genehmigung ausgesetzt wird, die Gründe für die Aussetzung.

grant_id

string

Erteilungs-ID

DeviceMetadata

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

DeviceModel

Informationen zum Modell des Geräts.

Felder
vendor

string

Der Name des Geräteanbieters.

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.

DpaMoveList

Ein Eintrag in der Verschiebungsliste einer DPA.

Felder
dpa_id

StringValue

Die ID der DPA.

frequency_range

FrequencyRange

Der Frequenzbereich, auf den sich die Bewegungsliste bezieht.

FrequencyRange

Frequenzbereich 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.

GenerateSecretRequest

Anfrage für GenerateSecret.

GenerateSecretResponse

Antwort für GenerateSecret.

Felder
secret

string

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

GetCustomerRequest

Anfrage für GetCustomer .

Felder
name

string

Erforderlich. Der Name der customer.

GetDeploymentRequest

Anfrage für GetDeployment.

Felder
name

string

Erforderlich. Der Name der deployment.

GetDeviceRequest

Anfrage für GetDevice.

Felder
name

string

Erforderlich. Der Name des Geräts.

GetNodeRequest

Anfrage 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.

GrantState

Der Status der Genehmigung.

Enums
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED Die Berechtigung wurde erteilt, aber das Gerät sendet keine Heartbeats.
GRANT_STATE_TERMINATED Die Gewährung wurde von der SAS beendet.
GRANT_STATE_SUSPENDED Die Gewährung wurde vom SAS ausgesetzt.
GRANT_STATE_AUTHORIZED Das Gerät überträgt gerade Daten.
GRANT_STATE_EXPIRED Die Erteilung ist abgelaufen.

HeightType

Gibt an, wie die Höhe gemessen wird.

Enums
HEIGHT_TYPE_UNSPECIFIED Nicht angegebener Höhentyp.
HEIGHT_TYPE_AGL Die Höhe über dem Boden wird relativ zum Boden gemessen.
HEIGHT_TYPE_AMSL Die Höhe über dem mittleren Meeresspiegel wird relativ zum mittleren Meeresspiegel gemessen.

InstallationParams

Informationen zu den Geräteinstallationsparametern.

Felder
latitude

DoubleValue

Breitengrad des Antennenstandorts des Geräts in Grad relativ zum WGS84-Datum. Der zulässige Bereich liegt zwischen -90,000000 und +90,000000. Positive Werte stehen für Breitengrade nördlich des Äquators, negative Werte für Breitengrade südlich des Äquators.

longitude

DoubleValue

Längengrad des Antennenstandorts des Geräts in Grad relativ zum WGS84-Datum. Der zulässige Bereich liegt zwischen -180,000000 und +180,000000. Positive Werte stellen Längengrade östlich des Nullmeridians dar, negative Werte westlich des Nullmeridians.

height

DoubleValue

Höhe der Geräteantenne in Metern. Wenn der Parameterwert heightType „AGL“ ist, sollte die Antennenhöhe relativ zum Boden angegeben werden. Wenn der Parameterwert 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 sich die Geräteantenne in Innenräumen befindet. true: indoor. false: outdoor.

antenna_azimuth

Int32Value

Die Ausrichtung der horizontalen Ebene der Antenne in Grad in Bezug auf den geografischen Norden. Der Wert dieses Parameters ist eine Ganzzahl zwischen 0 und 359 (einschließlich). Ein Wert von 0 Grad bedeutet geografischer Norden, ein Wert von 90 Grad Osten. Dieser Parameter ist für Geräte der Kategorie A optional und für Geräte der Kategorie B bedingt.

antenna_downtilt

Int32Value

Antennenneigung in Grad. Es handelt sich um eine Ganzzahl mit einem Wert zwischen -90 und +90 (jeweils einschließlich). Ein negativer Wert bedeutet, dass die Antenne nach oben geneigt ist (über der Horizontalen). Dieser Parameter ist für Geräte der Kategorie A optional und für Geräte der Kategorie B bedingt.

antenna_gain

Int32Value

Maximale Antennenverstärkung in dBi. Dieser Parameter ist eine Ganzzahl mit einem Wert zwischen -127 und +128 dBi (einschließlich).

eirp_capability

Int32Value

Dieser Parameter ist die maximale EIRP des Geräts in dBm/10 MHz und eine Ganzzahl mit einem Wert zwischen -127 und +47 dBm/10 MHz (einschließlich). Wenn nicht angegeben, interpretiert SAS dies als maximal zulässige EIRP in Einheiten von dBm/10 MHz für die Geräteklasse.

antenna_beamwidth

Int32Value

Die 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 (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, kann das Antennenmodell optional in diesem Feld angegeben werden. Der String darf maximal 128 Oktette lang sein.

cpe_cbsd_indication

BoolValue

Falls vorhanden, gibt dieser Parameter an, ob es sich bei der CBSD um eine CPE-CBSD handelt.

ListCustomersRequest

Anfrage 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 der customers, die der Anfrage entsprechen.

next_page_token

string

Ein Paginierungstoken, das von einem vorherigen Aufruf an ListCustomers zurückgegeben wurde und angibt, von wo aus die Auflistung fortgesetzt werden soll. Wenn das Feld fehlt oder leer ist, bedeutet das, dass es keine weiteren Kunden gibt.

ListDeploymentsRequest

Anfrage für ListDeployments.

Felder
parent

string

Erforderlich. Der Name der übergeordneten Ressource, z. B. „nodes/1“ oder „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 sollte das folgende Format haben: „DIRECT_CHILDREN“ oder „direct_children“. Der Filter berücksichtigt keine Groß-/Kleinschreibung. Wenn das Feld leer ist, werden keine Bereitstellungen gefiltert.

ListDeploymentsResponse

Antwort für ListDeployments.

Felder
deployments[]

Deployment

Die deployments, die mit der Anfrage übereinstimmen.

next_page_token

string

Ein Paginierungstoken, das von einem vorherigen Aufruf an ListDeployments zurückgegeben wurde und angibt, von wo aus die Auflistung fortgesetzt werden soll. Wenn das Feld fehlt oder leer ist, bedeutet das, dass keine weiteren Bereitstellungen vorhanden sind.

ListDevicesRequest

Anfrage für ListDevices.

Felder
parent

string

Erforderlich. Der Name der übergeordneten Ressource.

page_size

int32

Die maximale Anzahl der Geräte, die in der Antwort zurückgegeben werden sollen. Wenn leer oder null, 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 muss eines der folgenden Formate haben: „sn=123454“ oder „display_name=MyDevice“. „sn“ entspricht der Seriennummer des Geräts. Der Filter berücksichtigt keine Groß-/Kleinschreibung.

ListDevicesResponse

Antwort für ListDevices.

Felder
devices[]

Device

Die devices, die mit der Anfrage übereinstimmen.

next_page_token

string

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

ListNodesRequest

Anfrage für ListNodes.

Felder
parent

string

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

page_size

int32

Die maximale Anzahl der 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 sollte das folgende Format haben: „DIRECT_CHILDREN“ oder „direct_children“. Der Filter berücksichtigt keine Groß-/Kleinschreibung. Wenn das Feld leer ist, werden keine Knoten gefiltert.

ListNodesResponse

Antwort für ListNodes.

Felder
nodes[]

Node

Die nodes, die mit der Anfrage übereinstimmen.

next_page_token

string

Ein Paginierungstoken, das von einem vorherigen Aufruf an ListNodes zurückgegeben wurde und angibt, von wo aus die Auflistung fortgesetzt werden soll. Wenn das Feld fehlt oder leer ist, bedeutet das, dass keine weiteren Knoten vorhanden sind.

MeasurementCapability

Analysefähigkeit des Geräts. Die Werte werden durch WINNF-SSC-0002 definiert.

Enums
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

MoveDeploymentRequest

Anfrage 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 das Deployment neu zugeordnet werden soll.

MoveDeviceRequest

Anfrage für MoveDevice.

Felder
name

string

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

destination

string

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

MoveNodeRequest

Anfrage 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 zugeordnet werden soll.

Knoten

Der Knoten.

Felder
name

string

Nur Ausgabe. Ressourcenname.

display_name

string

Der Anzeigename des Knotens.

sas_user_ids[]

string

Von den Geräten dieses Knotens verwendete Nutzer-IDs.

Richtlinie

Definiert eine Richtlinie für die Zugriffssteuerung für die Ressourcen.

Felder
assignments[]

Assignment

Liste mit assignments Optionen

etag

bytes

Das ETag 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 im Read-Modify-Write-Zyklus verwenden, um Richtlinienaktualisierungen vorzunehmen und Race-Bedingungen zu vermeiden: Ein ETag wird in der Antwort auf GetPolicy zurückgegeben. Systeme müssen dieses ETag in die Anfrage an SetPolicy einfügen, damit ihre Änderung auf dieselbe Version der Richtlinie angewendet wird.

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

SetPolicyRequest

Anfragenachricht für die Methode SetPolicy.

Felder
resource

string

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

policy

Policy

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

SignDeviceRequest

Anfrage für SignDevice.

Felder
device

Device

Erforderlich. Die zu signierende device. Die device-Felder name, fcc_id und serial_number müssen festgelegt werden. 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 erteilt wurden.

UpdateCustomerRequest

Anfrage für UpdateCustomer.

Felder
customer

Customer

Erforderlich. Die neuen Werte für customer. Der Kunde muss name und display_name festgelegt haben.

update_mask

FieldMask

Die zu aktualisierenden Felder.

UpdateDeploymentRequest

Anfrage für UpdateDeployment.

Felder
deployment

Deployment

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

update_mask

FieldMask

Die zu aktualisierenden Felder.

UpdateDeviceRequest

Anfrage für UpdateDevice.

Felder
device

Device

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

update_mask

FieldMask

Die zu aktualisierenden Felder.

UpdateNodeRequest

Anfrage für UpdateNode.

Felder
node

Node

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

update_mask

FieldMask

Die zu aktualisierenden Felder.

UpdateSignedDeviceRequest

Anfrage 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 wurde. Die Nutzlast muss die JSON-Codierung von device sein. Das Feld user_id muss festgelegt werden.

installer_id

string

Erforderlich. Eindeutige ID des Installateurs (CPI-ID) aus der Datenbank für zertifizierte professionelle Installateure.

ValidateInstallerRequest

Anfrage für ValidateInstaller.

Felder
installer_id

string

Erforderlich. Eindeutige ID des Installateurs (CPI-ID) aus der Datenbank für zertifizierte professionelle Installateure.

secret

string

Erforderlich. Secret, das von GenerateSecret zurückgegeben wird.

encoded_secret

string

Erforderlich. JSON Web Token, das mit einem privaten CPI-Schlüssel signiert wurde. Die Nutzlast muss einen „secret“-Anspruch enthalten, dessen Wert das Secret ist.

ValidateInstallerResponse

Antwort für ValidateInstaller.