Nutzung

Konfiguration, die die Nutzung eines Dienstes steuert.

JSON-Darstellung

{
  "requirements": [
    string
  ],
  "rules": [
    {
      object(UsageRule)
    }
  ],
  "producerNotificationChannel": string
}
Felder
requirements[]

string

Anforderungen, die erfüllt sein müssen, bevor ein Nutzerprojekt den Dienst verwenden kann. Alle Anforderungen haben das Format <Dienst.Name>/, zum Beispiel "serviceusage.googleapis.com/billing-enabled"

rules[]

object(UsageRule)

Eine Liste von Nutzungsregeln, die für einzelne API-Methoden gelten.

HINWEIS: Alle Dienstkonfigurationsregeln befolgen die Reihenfolge "last one wins" (der Letzte gewinnt).

producerNotificationChannel

string

Der vollständige Ressourcenname eines Kanals, der zum Senden von Benachrichtigungen an den Dienstersteller verwendet wird.

Google Service Management unterstützt Google Cloud Pub/Sub derzeit nur als Benachrichtigungskanal. Um Google Cloud Pub/Sub als Kanal zu verwenden, muss das als Name eines Cloud Pub/Sub-Themas verwendet werden. Der Name muss das Format für den Namen des Cloud Pub/Sub-Themas haben. Mehr Informationen unter: https://cloud.google.com/pubsub/docs/overview.

UsageRule (Nutzungsregel)

Konfigurationsregeln zur Nutzung des Dienstes.

HINWEIS: In Entwicklung.

Verwenden Sie diese Regel, um nicht registrierte Aufrufe für den Dienst zu konfigurieren. Nicht registrierte Aufrufe sind Aufrufe, die keine Nutzerprojekt-ID enthalten. (Beispielsweise Aufrufe, die keinen API-Schlüssel enthalten). Standardmäßig erlauben API-Methoden keine nicht registrierten Aufrufe. Jeder Methodenaufruf muss durch eine Nutzerprojekt-ID bestätigt werden. Verwenden Sie diese Regel, um nicht registrierte Aufrufe zuzulassen/nicht zuzulassen

Beispiel für eine API, die nicht registrierte Aufrufe für den gesamten Dienst zulassen möchte.

usage:
  rules:
  - selector: "*"
    allowUnregisteredCalls: true

Beispiel für eine Methode, die nicht registrierte Aufrufe zulassen möchte.

usage:
  rules:
  - selector: "google.example.library.v1.LibraryService.CreateBook"
    allowUnregisteredCalls: true
JSON-Darstellung

{
  "selector": string,
  "allowUnregisteredCalls": boolean,
  "skipServiceControl": boolean
}
Felder
selector

string

Wählt die Methoden aus, für die diese Regel gelten. Verwenden Sie '*', um alle Methoden in allen APIs anzugeben.

Details zur Syntax finden Sie unter selector.

allowUnregisteredCalls

boolean

Ist dies der Fall, erlaubt die ausgewählte Methode nicht registrierte Aufrufe, z. B. Aufrufe, die weder einen Nutzer noch eine Anwendung identifizieren.

skipServiceControl

boolean

Ist dies der Fall, sollte die ausgewählte Methode die Funktionen der Dienststeuerung und Steuerungsebene überspringen. Kontingent, Abrechnung etc. stehen dann nicht zur Verfügung. Dieses Flag wird von Google Cloud Endpoints verwendet, um Prüfungen für interne Methoden, z. B. Methoden für die Systemdiagnose von Diensten, zu umgehen.