REST Resource: projects.locations.investigations

Ressource: Prüfung

Enthält den Inhalt einer Gemini Cloud Assist-Fehlerbehebungsprüfung.

JSON-Darstellung 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "revision": string,
  "revisionIndex": integer,
  "revisionPredecessor": string,
  "annotations": {
    object (InvestigationAnnotations)
  },
  "executionState": enum (InvestigationExecutionState),
  "error": {
    object (Status)
  },
  "operation": string,
  "title": string,
  "observations": {
    string: {
      object (Observation)
    },
    ...
  },
  "observerStatuses": {
    string: {
      object (ObserverStatus)
    },
    ...
  }
}
Felder
name

string

ID. Name der Prüfung im Format: projects/{projectNumber}/locations/{locationId}/investigations/{investigationId}
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu der die Prüfung erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu der die Prüfung zuletzt aktualisiert wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Optional. Benutzerdefinierte Labels für die Prüfung.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
revision

string

Nur Ausgabe. Der Ressourcenname der aktuellen Version der Prüfung im Format: projects/{projectNumber}/locations/{locationId}/investigations/{investigationId}/revisions/{revision_id}
revisionIndex

integer

Nur Ausgabe. Index der aktuellen Version der Prüfung.
revisionPredecessor

string

Optional. Der Name der Version, die der Vorgänger dieser Version war.
annotations

object (InvestigationAnnotations)

Optional. Zusätzliche Annotationen zur Prüfung.
executionState

enum (InvestigationExecutionState)

Nur Ausgabe. Der Status der Ausführung der Prüfung.
error

object (Status)

Nur Ausgabe. Der Fehler, wenn die Ausführung der Prüfung fehlgeschlagen ist. Dieses Feld wird nur festgelegt, wenn executionState INVESTIGATION_EXECUTION_STATE_FAILED ist.
operation

string

Nur Ausgabe. Der Ressourcenname des zuletzt für die Prüfung ausgeführten Vorgangs „Run“ im Format: projects/{projectNumber}/locations/{locationId}/operations/{operation_id}
title

string

Optional. Angezeigter Titel für die Prüfung in einem menschenlesbaren Format.
observations

map (key: string, value: object (Observation))

Optional. Beobachtungen zum Projektstatus, die den Inhalt der Prüfung ausmachen.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
observerStatuses

map (key: string, value: object (ObserverStatus))

Optional. Status von Beobachtern, die aufgerufen wurden, um die Prüfung ausführen zu können.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

InvestigationAnnotations

Zusätzliche Annotationen zu einer Prüfung.

JSON-Darstellung 
{
  "supportCase": string,
  "revisionLastRunInterval": {
    object (Interval)
  },
  "pagePath": string,
  "extrasMap": {
    string: string,
    ...
  }
}
Felder
supportCase

string

Optional. Eine Supportanfrage-ID, die mit der Prüfung verknüpft ist.
revisionLastRunInterval

object (Interval)

Nur Ausgabe. Das Intervall, in dem die Prüfung zuletzt ausgeführt wurde.
pagePath

string

Optional. Der Pfad einer Webseite, aus der diese Prüfung erstellt wurde.
extrasMap

map (key: string, value: string)

Optional. Zusätzliche kundenspezifische Annotationen.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Intervall

Stellt ein Zeitintervall dar, das als Zeitstempelstart (einschließlich) und Zeitstempelende (ausschließlich) codiert ist.

Der Start muss kleiner oder gleich dem Ende sein. Wenn der Start dem Ende entspricht, ist das Intervall leer (die Zeit ist null). Wenn sowohl der Start als auch das Ende nicht angegeben sind, entspricht das Intervall einer beliebigen Zeit.

JSON-Darstellung 
{
  "startTime": string,
  "endTime": string
}
Felder
startTime

string (Timestamp format)

Optional. Eingeschlossener Start des Intervalls.

Wenn angegeben, muss ein Zeitstempel, der diesem Intervall entspricht, gleich dem Start sein oder darauf folgen.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Optional. Ausgeschlossenes Ende des Intervalls.

Wenn angegeben, muss ein Zeitstempel, der diesem Intervall entspricht, vor dem Ende liegen.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

InvestigationExecutionState

Der Status der Ausführung einer Prüfung.

Enums
INVESTIGATION_EXECUTION_STATE_UNSPECIFIED Standardwert. Dieser Wert wird nicht verwendet.
INVESTIGATION_EXECUTION_STATE_RUNNING Die Prüfung wird ausgeführt.
INVESTIGATION_EXECUTION_STATE_MODIFIED Die Prüfung wurde seit der letzten Aktualisierung noch nicht ausgeführt.
INVESTIGATION_EXECUTION_STATE_FAILED Die Ausführung der Prüfung wurde abgeschlossen, ist aber fehlgeschlagen.
INVESTIGATION_EXECUTION_STATE_COMPLETED Alle Ausführungsaufgaben wurden abgeschlossen, und die Prüfung befindet sich im Ruhezustand.

Beobachtung

Eine Beobachtung stellt einen einzelnen Fakt zum Zustand des geprüften Systems dar, zusammen mit einer Rangfolge seiner Relevanz.

JSON-Darstellung 
{
  "id": string,
  "timeIntervals": [
    {
      object (Interval)
    }
  ],
  "title": string,
  "observationType": enum (ObservationType),
  "observerType": enum (ObserverType),
  "text": string,
  "data": {
    object
  },
  "dataUrls": {
    string: string,
    ...
  },
  "knowledgeUrls": {
    string: string,
    ...
  },
  "baseObservations": [
    string
  ],
  "relevantResources": [
    string
  ],
  "recommendation": string,
  "systemRelevanceScore": number,
  "relevanceOverride": enum (UserRelevance),
  "observationCompletionState": enum (ObservationCompletionState),
  "observedNormalOperation": boolean
}
Felder
id

string

Nur Ausgabe. Eindeutige Kennung für diese Beobachtung. Dieser Wert entspricht immer dem Zuordnungsschlüssel dieser Beobachtung in der übergeordneten Prüfung.
timeIntervals[]

object (Interval)

Optional. Zeitpunkt der Beobachtung.
title

string

Optional. Angezeigter Titel für die Beobachtung in einem menschenlesbaren Format.
observationType

enum (ObservationType)

Erforderlich. Der Typ der Beobachtung.
observerType

enum (ObserverType)

Erforderlich. Der Typ des Beobachters, der diese Beobachtung erstellt hat.
text

string

Optional. Text in natürlicher Sprache oder Markdown-Text, in dem die Beobachtung erläutert wird.
data

object (Struct format)

Optional. Eine strukturierte Darstellung der Beobachtung. Dies ist nicht erforderlich, und es wird nicht gewährleistet, dass es einem bestimmten Schema entspricht.
dataUrls

map (key: string, value: string)

Optional. URLs, die auf Beweise für diese Beobachtung verweisen. Ordnet eine menschenlesbare Beschreibung einer URL zu.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
knowledgeUrls

map (key: string, value: string)

Optional. URLs, die auf Referenzwissen zu dieser Beobachtung verweisen. Ordnet eine menschenlesbare Beschreibung einer URL zu.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
baseObservations[]

string

Optional. Die IDs anderer Beobachtungen, auf denen diese Beobachtung basiert. Bei einer Hypothesenbeobachtung werden beispielsweise die Beobachtungen erfasst, die diese Hypothese stützen.
relevantResources[]

string

Optional. Die für die Beobachtung relevanten Google Cloud-Ressourcen. Dies sollten vollständig qualifizierte Ressourcen-URIs sein, z. B.: "//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance"
recommendation

string

Optional. Text in natürlicher Sprache oder Markdown-Text, der eine empfohlene Maßnahme zur Behebung der Ursache oder zur weiteren Untersuchung des Problems beschreibt.
systemRelevanceScore

number

Optional. Wie relevant der Beobachter diese Beobachtung einschätzt. Damit werden Beobachtungen beim Generieren von Hypothesen eingestuft. Das System gibt Beobachtungen im Bereich [-1, 1] aus, wobei -1 für „völlig irrelevant“, 0 für „neutral“ und 1 für „gesichert relevant“ steht.
relevanceOverride

enum (UserRelevance)

Optional. Die Relevanzbewertung des Nutzers.
observationCompletionState

enum (ObservationCompletionState)

Optional. Gibt an, ob die Beobachtung vollständig ist und verwendet werden kann, um Schlussfolgerungen zu ziehen.
observedNormalOperation

boolean

Optional. Bei „false“ oder „unspecified“ enthält diese Beobachtung Informationen zu einem Problem oder einer Ursache. Wenn „true“, weist diese Beobachtung darauf hin, dass ein System normal funktioniert hat. Solche negativen Ergebnisse können nützliche diagnostische Erkenntnisse liefern. Dieses Feld hat keine Korrelation mit dem Relevanzwert.

ObservationType

Dies stellt die Arten der Daten dar, aus denen eine Beobachtung besteht. Das ist unabhängig von der Herkunft: Ein Log kann explizit vom Nutzer bereitgestellt, über KI extrahiert oder von einem Runbook erkannt worden sein.

Enums
OBSERVATION_TYPE_UNSPECIFIED Standardwert.
OBSERVATION_TYPE_CLOUD_LOG Der Text dieser Beobachtung ist ein Logeintrag.
OBSERVATION_TYPE_CLOUD_METRIC Der Inhalt dieser Beobachtung ist ein Messwert oder eine Gruppe von Messwerten.
OBSERVATION_TYPE_CAIS_CONFIG Eine Konfiguration
OBSERVATION_TYPE_CAIS_CONFIG_DIFF Eine Konfigurationsänderung
OBSERVATION_TYPE_CLOUD_ALERT Eine Benachrichtigung
OBSERVATION_TYPE_CICD_EVENT Ein Ereignis aus einem Continuous Integration-System, z. B. Prober-Fehler.
OBSERVATION_TYPE_TEXT_DESCRIPTION Freie Texteingabe, z. B. die ursprüngliche Nutzereingabe. Kann Markdown sein.
OBSERVATION_TYPE_HYPOTHESIS Dies gilt für [vorläufige] Schlussfolgerungen, die vom System gezogen werden. Sie können als Eingaben für eine nachfolgende Version dienen. In diesem Fall werden die Empfehlungen verwendet, nicht aber die Abhilfemaßnahmen.
OBSERVATION_TYPE_STRUCTURED_INPUT Strukturierte Eingabe, z. B. Runbook-Parameter in einem Formular
OBSERVATION_TYPE_COMPOSITE Wird für eine Beobachtung verwendet, die mehr als eine Art von Beweisen enthält, z. B. eine Runbook-Ausgabe.
OBSERVATION_TYPE_OTHER Die Runbook-Ausgabe kann „other“ sein, wenn keiner der anderen Typen zutrifft.
OBSERVATION_TYPE_LOG_THEME Ein in den Logs entdecktes Thema.
OBSERVATION_TYPE_CONFIG_ANALYSIS Signalausgabe, die eine von einem LLM analysierte Konfiguration enthält.
OBSERVATION_TYPE_OUTAGE Signalausgabe, die einen Ausfall von PSH enthält.
OBSERVATION_TYPE_KNOWLEDGE Text, der Informationen zum Problem eines bestimmten Nutzers enthält. Beispiele: Fehlerkatalog Anleitungen/externe Links, Retrieval-Augmented Generation (RAG) usw.

ObserverType

Hier wird angegeben, wie die Daten in die Prüfung gelangt sind.

Enums
OBSERVER_TYPE_UNSPECIFIED Standardwert. Nicht in Verwendung.
OBSERVER_TYPE_DIAGNOSTICS DiagnoseTools haben eine explizite Vorstellung von Ursachen, z. B. über Runbooks.
OBSERVER_TYPE_SIGNALS „Signals“ ist für die Verarbeitung ohne explizite Ursachen vorgesehen.
OBSERVER_TYPE_DETERMINISTIC_CODE Dies gilt für Code, der nur auf Prämissen beruht. Insbesondere Fehlerkatalog-Lookups.
OBSERVER_TYPE_AI Dies gilt für KI-Schlussfolgerungen, die nur auf Beobachtungen beruhen, die als Prämissen aufgeführt sind.
OBSERVER_TYPE_USER Beobachtung der Nutzereingabe, einschließlich Antworten auf Klarstellungen. Alle vom Nutzer angegebenen Beobachtungen werden implizit in diesen Typ umgewandelt.
OBSERVER_TYPE_ALERT Eine Beobachtung aus einer Benachrichtigung.

UserRelevance

Dies entspricht der von einem Nutzer geäußerten Relevanzbewertung einer Beobachtung.

Enums
USER_RELEVANCE_UNSPECIFIED Der Nutzer hat diese Beobachtung nicht als relevant oder irrelevant markiert.
USER_RELEVANCE_PROMOTED Der Nutzer hat diese Beobachtung als relevant markiert.
USER_RELEVANCE_REJECTED Der Nutzer hat diese Beobachtung als irrelevant markiert.

ObservationCompletionState

Gibt an, ob die Beobachtung vollständig und abgeschlossen ist.

Enums
OBSERVATION_COMPLETION_STATE_UNSPECIFIED Standardwert. Wird als ABGESCHLOSSEN behandelt.
OBSERVATION_COMPLETION_STATE_COMPLETE Diese Beobachtung ist vollständig.
OBSERVATION_COMPLETION_STATE_INCOMPLETE Für diese Beobachtung fehlen einige Informationen oder sie muss von einem anderen Beobachter weiterverarbeitet werden. Diese Art von Beobachtung wird bei zukünftigen Prüfungsläufen möglicherweise verworfen.

ObserverStatus

Ein ObserverStatus stellt den Status eines Beobachters zu einem bestimmten Zeitpunkt während der Ausführung einer Prüfung dar.

JSON-Darstellung 
{
  "observer": string,
  "observerExecutionState": enum (ObserverExecution),
  "observerDisplayName": string,
  "updateTime": string,
  "startTime": string,
  "updateComment": string,
  "observerErrors": [
    {
      object (Status)
    }
  ]
}
Felder
observer

string

Nur Ausgabe. Eindeutige Kennung dieses Beobachters. Dieser Wert entspricht immer dem Zuordnungsschlüssel dieses Beobachters in der übergeordneten Prüfung.
observerExecutionState

enum (ObserverExecution)

Optional. Der aktuelle Status der Ausführung des Beobachters.
observerDisplayName

string

Erforderlich. Menschenlesbarer Anzeigename des Beobachters.
updateTime

string (Timestamp format)

Optional. Der Zeitpunkt, zu dem der Beobachter die Prüfung zuletzt aktualisiert hat. Wenn observerExecutionState COMPLETE oder FAILED ist, ist dies der Zeitpunkt, zu dem der Beobachter seine Beobachtung beendet hat.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
startTime

string (Timestamp format)

Optional. Der Zeitpunkt, zu dem der Beobachter mit der Beobachtung begonnen hat.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
updateComment

string

Optional. Eine Statusaktualisierung durch den Beobachter.
observerErrors[]

object (Status)

Optional. Ein Fehler, der einen Beobachter daran gehindert hat, eine bestimmte Beobachtung zu machen.

ObserverExecution

Der Status des Beobachters.

Enums
OBSERVER_EXECUTION_UNSPECIFIED Der Status des Beobachters ist nicht angegeben.
OBSERVER_EXECUTION_NOT_STARTED Die Prüfung hat noch nicht begonnen.
OBSERVER_EXECUTION_RUNNING Die Prüfung läuft, und dieser Beobachter kann ausgeführt werden oder wird ausgeführt.
OBSERVER_EXECUTION_COMPLETE Der Beobachter wurde ohne internen Fehler beendet.
OBSERVER_EXECUTION_FAILED Der Versuch, den Beobachter auszuführen, wurde aufgrund eines Fehlers abgebrochen. Dies bezieht sich auf eine bestimmte Komponente und kann gegebenenfalls in der Benutzeroberfläche gerendert werden, wenn die Beobachtung mit einer sehr niedrigen Priorität angezeigt wird.
OBSERVER_EXECUTION_BLOCKED Der Beobachter ist blockiert und wartet auf eine Eingabe.
OBSERVER_EXECUTION_INVESTIGATION_BLOCKED Der Beobachter meldet einen Fehler, der die Prüfung blockiert oder erheblich beeinträchtigt, z. B. CAIS oder Logging deaktiviert. Sollte gut sichtbar auf der Benutzeroberfläche gerendert werden.
OBSERVER_EXECUTION_INVESTIGATION_DEGRADED Der Beobachter meldet einen Fehler, der die Prüfung beeinträchtigt. Möglicherweise muss der Nutzer den Fehler eskalieren oder die Prüfung nach Behebung der Ursache noch einmal ausführen.

Methoden

create

 Erstellt eine neue Prüfung in einem bestimmten Projekt.

delete

 Löscht eine einzelne Prüfung.

get

 Ruft Details zu einer einzelnen Prüfung ab.

getIamPolicy

 Ruft die Zugriffssteuerungsrichtlinie für eine Ressource ab.

list

 Listet Prüfungen in einem bestimmten Projekt und an einem bestimmten Standort auf.

patch

 Aktualisiert die Parameter einer einzelnen Prüfung.

setIamPolicy

 Legt die Zugriffssteuerungsrichtlinie für die angegebene Ressource fest.

testIamPermissions

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