REST Resource: projects.locations.investigations

Recurso: Investigation

Contiene el contenido de una investigación de solución de problemas de Gemini Cloud Assist.

Representación JSON 
{
  "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)
    },
    ...
  }
}
Campos
name

string

Identificador. Nombre de la investigación, con el formato projects/{projectNumber}/locations/{locationId}/investigations/{investigationId}
createTime

string (Timestamp format)

Solo de salida. Hora en la que se creó la investigación.

Usa RFC 3339, donde la salida generada siempre se normalizará con Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo de salida. Hora a la que se actualizó la investigación por última vez.

Usa RFC 3339, donde la salida generada siempre se normalizará con Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Opcional. Etiquetas definidas por el usuario para la investigación.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }
revision

string

Solo de salida. Nombre de recurso de la revisión actual de la investigación, con el formato projects/{projectNumber}/locations/{locationId}/investigations/{investigationId}/revisions/{revision_id}
revisionIndex

integer

Solo de salida. Índice de la revisión actual de la investigación.
revisionPredecessor

string

Opcional. Nombre de la revisión que precedió a esta.
annotations

object (InvestigationAnnotations)

Opcional. Anotaciones adicionales sobre la investigación.
executionState

enum (InvestigationExecutionState)

Solo de salida. Estado de ejecución de la investigación.
error

object (Status)

Solo de salida. Error si no se ha podido ejecutar la investigación. Este campo solo se definirá si executionState es INVESTIGATION_EXECUTION_STATE_FAILED.
operation

string

Solo de salida. Nombre de recurso de la operación de ejecución más reciente realizada en la investigación, con el formato projects/{projectNumber}/locations/{locationId}/operations/{operation_id}
title

string

Opcional. Título visible de la investigación legible por humanos.
observations

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

Opcional. Observaciones sobre el estado del proyecto que componen el contenido de la investigación.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }
observerStatuses

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

Opcional. Estados de los observadores que se han invocado para llevar a cabo la investigación.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }

InvestigationAnnotations

Anotaciones adicionales en una investigación.

Representación JSON 
{
  "supportCase": string,
  "revisionLastRunInterval": {
    object (Interval)
  },
  "pagePath": string,
  "extrasMap": {
    string: string,
    ...
  }
}
Campos
supportCase

string

Opcional. Un ID de caso de asistencia asociado a la investigación.
revisionLastRunInterval

object (Interval)

Solo de salida. Intervalo durante el que se ejecutó la investigación por última vez.
pagePath

string

Opcional. La ruta de una página web desde la que se creó esta investigación.
extrasMap

map (key: string, value: string)

Opcional. Anotaciones adicionales especificadas por el cliente.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }

Intervalo

Representa un intervalo de tiempo codificado como una marca de tiempo de inicio (inclusiva) y una marca de tiempo de finalización (exclusiva).

El inicio debe ser inferior o igual al final. Si el inicio es igual al final, el intervalo está vacío (no coincide con ningún momento). Si no se especifica ni el inicio ni el final, el intervalo coincide con cualquier momento.

Representación JSON 
{
  "startTime": string,
  "endTime": string
}
Campos
startTime

string (Timestamp format)

Opcional. Inicio inclusivo del intervalo.

Si se especifica, la marca de tiempo que coincida con este intervalo debe ser igual o posterior a la hora de inicio.

Usa RFC 3339, donde la salida generada siempre se normalizará con Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Opcional. Fin exclusivo del intervalo.

Si se especifica, la marca de tiempo que coincida con este intervalo deberá ser anterior a la hora de finalización.

Usa RFC 3339, donde la salida generada siempre se normalizará con Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

InvestigationExecutionState

El estado de ejecución de una investigación.

Enumeraciones
INVESTIGATION_EXECUTION_STATE_UNSPECIFIED Valor predeterminado. Este valor no se usa.
INVESTIGATION_EXECUTION_STATE_RUNNING Se está llevando a cabo la investigación.
INVESTIGATION_EXECUTION_STATE_MODIFIED La investigación aún no se ha llevado a cabo desde la última actualización.
INVESTIGATION_EXECUTION_STATE_FAILED La ejecución de la investigación se ha completado, pero ha fallado.
INVESTIGATION_EXECUTION_STATE_COMPLETED Se han completado todas las tareas de ejecución y la investigación está en reposo.

Observación

Una observación representa un hecho sobre el estado del sistema que se está investigando, junto con una clasificación de su relevancia.

Representación JSON 
{
  "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
}
Campos
id

string

Solo de salida. Identifica de forma única esta observación. Siempre es igual a la clave de mapa de esta observación en la investigación principal.
timeIntervals[]

object (Interval)

Opcional. Cuándo se produjo esta observación.
title

string

Opcional. Título visible de la observación legible por humanos.
observationType

enum (ObservationType)

Obligatorio. El tipo de observación.
observerType

enum (ObserverType)

Obligatorio. El tipo de observador que ha generado esta observación.
text

string

Opcional. Texto en lenguaje natural o Markdown que explica la observación.
data

object (Struct format)

Opcional. Representación estructurada de la observación. No es obligatorio ni se garantiza que se ajuste a ningún esquema concreto.
dataUrls

map (key: string, value: string)

Opcional. URLs que apuntan a pruebas que respaldan esta observación. Asigna una descripción legible por humanos a una URL.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }
knowledgeUrls

map (key: string, value: string)

Opcional. URLs que apuntan a conocimientos de referencia relacionados con esta observación. Asigna una descripción legible por humanos a una URL.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }
baseObservations[]

string

Opcional. Los IDs de otras observaciones en las que se basa esta observación. Por ejemplo, una observación de una hipótesis registrará las observaciones que respalden esa hipótesis.
relevantResources[]

string

Opcional. Los recursos de Google Cloud relevantes para la observación. Deben ser URIs de recursos cualificados, como los siguientes: "//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance"
recommendation

string

Opcional. Texto en lenguaje natural o en formato Markdown que describe una acción recomendada para solucionar la causa principal o investigar más a fondo el problema.
systemRelevanceScore

number

Opcional. El grado de relevancia que el observador percibe de esta observación. Se usa para clasificar las observaciones al generar hipótesis. El sistema genera observaciones en el intervalo [-1, 1], donde -1 significa que no es relevante, 0 significa que es neutral y 1 significa que tiene total confianza en su relevancia.
relevanceOverride

enum (UserRelevance)

Opcional. La valoración de relevancia del usuario.
observationCompletionState

enum (ObservationCompletionState)

Opcional. Representa si la observación está completa y se puede usar para extraer conclusiones.
observedNormalOperation

boolean

Opcional. Si es falso o no se especifica, esta observación proporciona información sobre un problema o una causa principal. Si es true, esta observación indica que se ha observado que un sistema funciona con normalidad. Estos resultados negativos pueden ser útiles para el diagnóstico y este campo no tiene ninguna correlación con la puntuación de relevancia.

ObservationType

Representa el tipo de datos que constituyen una observación. Esto es independiente de la procedencia: un registro puede proporcionarlo explícitamente el usuario, extraerse mediante IA o detectarse mediante un runbook.

Enumeraciones
OBSERVATION_TYPE_UNSPECIFIED Valor predeterminado.
OBSERVATION_TYPE_CLOUD_LOG El texto de esta observación es una entrada de registro.
OBSERVATION_TYPE_CLOUD_METRIC El contenido de esta observación es una métrica o un grupo de métricas.
OBSERVATION_TYPE_CAIS_CONFIG Una configuración
OBSERVATION_TYPE_CAIS_CONFIG_DIFF Cambio de configuración
OBSERVATION_TYPE_CLOUD_ALERT Una alerta
OBSERVATION_TYPE_CICD_EVENT Un evento de un sistema de integración continua, como un error de comprobación.
OBSERVATION_TYPE_TEXT_DESCRIPTION Entrada de texto libre, como la entrada inicial del usuario. Puede ser Markdown.
OBSERVATION_TYPE_HYPOTHESIS Se trata de conclusiones [provisionales] extraídas por el sistema. Estos pueden convertirse en entradas para una revisión posterior. En este caso, se usarán las recomendaciones, pero no la corrección.
OBSERVATION_TYPE_STRUCTURED_INPUT Entrada estructurada, por ejemplo, parámetros de runbook introducidos en un formulario
OBSERVATION_TYPE_COMPOSITE Se usa en las observaciones que incluyen más de un tipo de prueba, como la salida de un runbook.
OBSERVATION_TYPE_OTHER El resultado del runbook puede ser "otro" si no se aplica ninguno de los otros tipos.
OBSERVATION_TYPE_LOG_THEME Un tema descubierto en los registros.
OBSERVATION_TYPE_CONFIG_ANALYSIS Señales de salida que incluyen una configuración analizada por un LLM.
OBSERVATION_TYPE_OUTAGE Salida de señales que incluye una interrupción de PSH.
OBSERVATION_TYPE_KNOWLEDGE Texto que proporciona información sobre el problema de un usuario concreto. Por ejemplo, instrucciones del catálogo de errores o enlaces externos, RAG, etc.

ObserverType

Representa cómo se han introducido los datos en la investigación.

Enumeraciones
OBSERVER_TYPE_UNSPECIFIED Valor predeterminado. Sin usar.
OBSERVER_TYPE_DIAGNOSTICS Los diagnósticos tienen una noción explícita de las causas principales, por ejemplo, a través de los runbooks.
OBSERVER_TYPE_SIGNALS Signals se usa para procesar datos que no tienen causas raíz explícitas.
OBSERVER_TYPE_DETERMINISTIC_CODE Esto es para código que solo depende de las instalaciones. En concreto, las búsquedas en el catálogo de errores.
OBSERVER_TYPE_AI Se trata de inferencias de IA que dependen únicamente de las observaciones que se enumeran como premisas.
OBSERVER_TYPE_USER Observación de las entradas de los usuarios, incluidas las respuestas a las aclaraciones. Todas las observaciones especificadas por el usuario se convertirán a este tipo.
OBSERVER_TYPE_ALERT Una observación de una alerta.

UserRelevance

Representa el juicio de relevancia expresado por un usuario sobre una observación.

Enumeraciones
USER_RELEVANCE_UNSPECIFIED El usuario no ha marcado esta observación como relevante o irrelevante.
USER_RELEVANCE_PROMOTED El usuario ha marcado esta observación como relevante.
USER_RELEVANCE_REJECTED El usuario ha marcado esta observación como irrelevante.

ObservationCompletionState

Determina si la observación está totalmente formada y completa.

Enumeraciones
OBSERVATION_COMPLETION_STATE_UNSPECIFIED Valor predeterminado. Se tratará como COMPLETADA.
OBSERVATION_COMPLETION_STATE_COMPLETE Esta observación está totalmente formada.
OBSERVATION_COMPLETION_STATE_INCOMPLETE Falta información en esta observación o necesita que otro observador la procese. Este tipo de observación puede descartarse en futuras ejecuciones de investigación.

ObserverStatus

ObserverStatus representa el estado de un observador en un momento concreto durante la ejecución de una investigación.

Representación JSON 
{
  "observer": string,
  "observerExecutionState": enum (ObserverExecution),
  "observerDisplayName": string,
  "updateTime": string,
  "startTime": string,
  "updateComment": string,
  "observerErrors": [
    {
      object (Status)
    }
  ]
}
Campos
observer

string

Solo de salida. Identifica de forma única a este observador. Siempre es igual a la clave de mapa de este observador en la investigación principal.
observerExecutionState

enum (ObserverExecution)

Opcional. El estado de ejecución actual del observador.
observerDisplayName

string

Obligatorio. Nombre visible del observador legible por humanos.
updateTime

string (Timestamp format)

Opcional. Hora a la que el observador actualizó la investigación por última vez. Si el estado observerExecutionState es COMPLETE o FAILED, esta es la hora en la que el observador ha finalizado la observación.

Usa RFC 3339, donde la salida generada siempre se normalizará con Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
startTime

string (Timestamp format)

Opcional. La hora a la que el observador ha empezado a observar.

Usa RFC 3339, donde la salida generada siempre se normalizará con Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateComment

string

Opcional. Una actualización del estado del observador.
observerErrors[]

object (Status)

Opcional. Error que ha impedido que un observador haga una observación concreta.

ObserverExecution

El estado del observador.

Enumeraciones
OBSERVER_EXECUTION_UNSPECIFIED El estado del observador no está especificado.
OBSERVER_EXECUTION_NOT_STARTED La investigación aún no ha empezado.
OBSERVER_EXECUTION_RUNNING La investigación se está ejecutando y este observador se puede ejecutar o se está ejecutando.
OBSERVER_EXECUTION_COMPLETE El observador ha finalizado sin errores internos.
OBSERVER_EXECUTION_FAILED El observador ha intentado ejecutarse, pero no lo ha conseguido debido a un error. Es específico de un componente y puede renderizarse en la interfaz de usuario si se muestra la observación, con una prioridad muy baja.
OBSERVER_EXECUTION_BLOCKED El observador está bloqueado a la espera de una entrada.
OBSERVER_EXECUTION_INVESTIGATION_BLOCKED El observador informa de un error que bloquea o afecta gravemente a la investigación (por ejemplo, CAIS o registro inhabilitado). Debe mostrarse de forma destacada en la interfaz de usuario.
OBSERVER_EXECUTION_INVESTIGATION_DEGRADED El observador informa de un error que dificulta la investigación, por lo que es posible que el usuario tenga que derivar el problema o volver a ejecutar la investigación después de mitigar la causa.

Métodos

create

 Crea una investigación en un proyecto determinado.

delete

 Elimina una sola investigación.

get

 Obtiene los detalles de una sola investigación.

getIamPolicy

 Obtiene la política de control de acceso de un recurso.

list

 Muestra las investigaciones de un proyecto y una ubicación determinados.

patch

 Actualiza los parámetros de una sola investigación.

setIamPolicy

 Aplica la política de control de acceso del recurso especificado.

testIamPermissions

 Devuelve los permisos que tiene una sobre el recurso especificado.