REST-Ressource: services

Ressource: Dienst

Ein Dienst, der dem Nutzer zur Verfügung steht.

JSON-Darstellung

{
  "name": string,
  "parent": string,
  "config": {
    object(ServiceConfig)
  },
  "state": enum(State)
}
Felder
name

string

Der Ressourcenname des Nutzers und des Dienstes

Ein gültiger Name wäre: - projects/123/services/serviceusage.googleapis.com.

parent

string

Der Ressourcenname des Nutzers

Ein gültiger Name wäre: - projects/123.

config

object(ServiceConfig)

Die Dienstkonfiguration des verfügbaren Dienstes: Einige Felder können als Antwort auf die Methode services.list aus der Konfiguration herausgefiltert werden. Diese Felder sind nur als Antworten auf die Methode services.get vorhanden.

state

enum(State)

Unabhängig davon, ob der Dienst für den Nutzer aktiviert wurde oder nicht.

ServiceConfig (Dienstkonfiguration)

Die Konfiguration des Dienstes

JSON-Darstellung

{
  "name": string,
  "title": string,
  "apis": [
    {
      object(Api)
    }
  ],
  "documentation": {
    object(Documentation)
  },
  "quota": {
    object(Quota)
  },
  "authentication": {
    object(Authentication)
  },
  "usage": {
    object(Usage)
  },
  "endpoints": [
    {
      object(Endpoint)
    }
  ]
}
Felder
name

string

Die DNS-Adresse, unter der dieser Dienst verfügbar ist.

Eine Beispiel-DNS-Adresse wäre: calendar.googleapis.com.

title

string

Der Produkttitel für diesen Dienst

apis[]

object(Api)

Eine Liste der von diesem Dienst exportierten API-Schnittstellen: Enthält nur die Namen, Versionen und Methodennamen der Schnittstellen.

documentation

object(Documentation)

Zusätzliche API-Dokumentation: Enthält nur die Zusammenfassung und die Dokumentations-URL.

quota

object(Quota)

Kontingentkonfiguration

authentication

object(Authentication)

Authentifizierungskonfiguration: Enthält nur die OAuth-Regeln.

usage

object(Usage)

Konfiguration, die die Nutzung dieses Dienstes steuert.

endpoints[]

object(Endpoint)

Konfiguration für Netzwerkendpunkte. Enthält nur die Namen und Aliasse der Endpunkte.

State (Status)

Gibt an, ob ein Dienst für die Verwendung durch einen Nutzer aktiviert wurde.

Enums
STATE_UNSPECIFIED Der Standardwert, der angibt, dass der aktivierte Status des Dienstes nicht bestimmt oder nicht aussagekräftig ist. Abgesehen von den Projekten (z. B. Ordner und Organisationen) befinden sich alle Nutzer derzeit immer in diesem Status.
DISABLED Der Dienst kann von diesem Nutzer nicht verwendet werden. Er wurde entweder explizit deaktiviert oder nie aktiviert.
ENABLED Der Dienst wurde explizit für die Verwendung durch diesen Nutzer aktiviert.

Methoden

batchEnable

Aktiviert mehrere Dienste in einem Projekt.

disable

Deaktiviert einen Dienst, damit er nicht mehr für ein Projekt verwendet werden kann.

enable

Aktiviert einen Dienst, damit er mit einem Projekt verwendet werden kann.

get

Gibt die Dienstkonfiguration und den aktivierten Status für einen bestimmten Dienst zurück.

list

Listet alle Dienste auf, die für das angegebene Projekt und den aktuellen Status dieser Dienste in Bezug auf das Projekt verfügbar sind.