REST Resource: projects.locations.investigations

Recurso: investigação

Contém o conteúdo de uma investigação de resolução de problemas do Gemini Cloud Assist.

Representação 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. Nome da investigação, no formato: projects/{projectNumber}/locations/{locationId}/investigations/{investigationId}
createTime

string (Timestamp format)

Apenas saída. A hora em que a investigação foi criada.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Apenas saída. A hora em que a investigação foi atualizada pela última vez.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Opcional. Etiquetas definidas pelo utilizador para a investigação.

Um objeto que contém uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
revision

string

Apenas saída. Nome do recurso da revisão atual da investigação, no formato: projects/{projectNumber}/locations/{locationId}/investigations/{investigationId}/revisions/{revision_id}
revisionIndex

integer

Apenas saída. Índice da revisão atual da investigação.
revisionPredecessor

string

Opcional. O nome da revisão que foi a predecessora desta revisão.
annotations

object (InvestigationAnnotations)

Opcional. Anotações adicionais sobre a investigação.
executionState

enum (InvestigationExecutionState)

Apenas saída. O estado de execução da investigação.
error

object (Status)

Apenas saída. O erro se a execução da investigação falhou. Este campo só é definido se executionState for INVESTIGATION_EXECUTION_STATE_FAILED.
operation

string

Apenas saída. O nome do recurso da operação de execução realizada mais recentemente na investigação, no formato: projects/{projectNumber}/locations/{locationId}/operations/{operation_id}
title

string

Opcional. Título de apresentação legível da investigação.
observations

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

Opcional. Observações sobre o estado do projeto que compreendem os conteúdos da investigação.

Um objeto que contém uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
observerStatuses

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

Opcional. Estados dos observadores que foram invocados para executar a investigação.

Um objeto que contém uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

InvestigationAnnotations

Anotações adicionais numa investigação.

Representação JSON 
{
  "supportCase": string,
  "revisionLastRunInterval": {
    object (Interval)
  },
  "pagePath": string,
  "extrasMap": {
    string: string,
    ...
  }
}
Campos
supportCase

string

Opcional. Um ID do registo de apoio técnico associado à investigação.
revisionLastRunInterval

object (Interval)

Apenas saída. O intervalo durante o qual a investigação foi executada pela última vez.
pagePath

string

Opcional. O caminho de uma página Web a partir da qual esta investigação foi criada.
extrasMap

map (key: string, value: string)

Opcional. Anotações adicionais especificadas pelo cliente.

Um objeto que contém uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Intervalo

Representa um intervalo de tempo, codificado como uma indicação de tempo de início (inclusive) e uma indicação de tempo de fim (exclusiva).

O início tem de ser inferior ou igual ao fim. Quando o início é igual ao fim, o intervalo está vazio (não corresponde a nenhuma hora). Quando o início e o fim não estão especificados, o intervalo corresponde a qualquer hora.

Representação JSON 
{
  "startTime": string,
  "endTime": string
}
Campos
startTime

string (Timestamp format)

Opcional. Início inclusivo do intervalo.

Se especificado, uma data/hora que corresponda a este intervalo tem de ser igual ou posterior ao início.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Opcional. Fim exclusivo do intervalo.

Se especificado, uma data/hora com correspondência neste intervalo tem de ser anterior ao fim.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

InvestigationExecutionState

O estado de execução de uma investigação.

Enumerações
INVESTIGATION_EXECUTION_STATE_UNSPECIFIED Valor predefinido. Este valor não é usado.
INVESTIGATION_EXECUTION_STATE_RUNNING A investigação está a ser executada.
INVESTIGATION_EXECUTION_STATE_MODIFIED A investigação ainda não foi executada desde a última atualização.
INVESTIGATION_EXECUTION_STATE_FAILED A execução da investigação foi concluída, mas falhou.
INVESTIGATION_EXECUTION_STATE_COMPLETED Todas as tarefas de execução foram concluídas e a investigação está inativa.

Observação

Uma observação representa um único facto sobre o estado do sistema sob investigação, juntamente com uma classificação da respetiva relevância.

Representação 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

Apenas saída. Identifica esta observação de forma exclusiva. Este valor é sempre igual à chave do mapa desta observação na investigação principal.
timeIntervals[]

object (Interval)

Opcional. Quando ocorreu esta observação.
title

string

Opcional. Título de apresentação legível para a observação.
observationType

enum (ObservationType)

Obrigatório. O tipo de observação.
observerType

enum (ObserverType)

Obrigatório. O tipo de observador que produziu esta observação.
text

string

Opcional. Texto em linguagem natural ou markdown que explica a observação.
data

object (Struct format)

Opcional. Uma representação estruturada da observação. Isto não é obrigatório nem é garantido que esteja em conformidade com um esquema específico.
dataUrls

map (key: string, value: string)

Opcional. URLs que apontam para provas que apoiam esta observação. Mapeia uma descrição legível para um URL.

Um objeto que contém uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
knowledgeUrls

map (key: string, value: string)

Opcional. URLs que apontam para conhecimentos de referência relacionados com esta observação. Mapeia uma descrição legível para um URL.

Um objeto que contém uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
baseObservations[]

string

Opcional. Os IDs de outras observações nas quais esta observação se baseia. Por exemplo, uma observação de hipótese regista as observações que suportam essa hipótese.
relevantResources[]

string

Opcional. Os recursos do Google Cloud relevantes para a observação. Estes devem ser URIs de recursos totalmente qualificados, por exemplo: "//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance"
recommendation

string

Opcional. Linguagem natural ou texto de marcação que descreve uma ação recomendada para corrigir a causa principal ou investigar mais aprofundadamente o problema.
systemRelevanceScore

number

Opcional. A relevância que o observador atribui a esta observação. Isto é usado para classificar as observações na geração de hipóteses. O sistema produz observações no intervalo [-1, 1], em que -1 significa completamente irrelevante, 0 significa neutro e 1 significa confiança total na sua relevância.
relevanceOverride

enum (UserRelevance)

Opcional. O julgamento de relevância do utilizador.
observationCompletionState

enum (ObservationCompletionState)

Opcional. Representa se a observação está totalmente formada e pode ser usada para tirar conclusões.
observedNormalOperation

boolean

Opcional. Se for falso ou não especificado, esta observação dá informações sobre um problema ou uma causa principal. Se for verdadeiro, esta observação indica que foi observado que um sistema está a funcionar normalmente. Estes resultados negativos podem ser conclusões de diagnóstico úteis e este campo não tem correlação com a classificação de relevância.

ObservationType

Isto representa o tipo de dados que constituem uma observação. Isto é independente da proveniência: um registo pode ser fornecido explicitamente pelo utilizador, extraído através de IA ou detetado por um manual de procedimentos.

Enumerações
OBSERVATION_TYPE_UNSPECIFIED Valor predefinido.
OBSERVATION_TYPE_CLOUD_LOG O texto desta observação é uma entrada de registo.
OBSERVATION_TYPE_CLOUD_METRIC O conteúdo desta observação é uma métrica ou um grupo de métricas.
OBSERVATION_TYPE_CAIS_CONFIG Uma configuração
OBSERVATION_TYPE_CAIS_CONFIG_DIFF Uma alteração da configuração
OBSERVATION_TYPE_CLOUD_ALERT Um alerta
OBSERVATION_TYPE_CICD_EVENT Um evento de um sistema de integração contínua, por exemplo, uma falha de sonda.
OBSERVATION_TYPE_TEXT_DESCRIPTION Entrada de texto livre, como a entrada inicial do utilizador. Pode ser markdown.
OBSERVATION_TYPE_HYPOTHESIS Isto destina-se a conclusões [provisórias] tiradas pelo sistema. Estas podem tornar-se entradas para uma revisão subsequente. Neste caso, as recomendações são usadas, mas não a correção.
OBSERVATION_TYPE_STRUCTURED_INPUT Entrada estruturada, por exemplo, parâmetros do manual de procedimentos introduzidos num formulário
OBSERVATION_TYPE_COMPOSITE Usado para uma observação que inclui mais do que um tipo de prova, como o resultado de um manual de procedimentos.
OBSERVATION_TYPE_OTHER O resultado do runbook pode ser "outro" se nenhum dos outros tipos se aplicar.
OBSERVATION_TYPE_LOG_THEME Um tema descoberto nos registos.
OBSERVATION_TYPE_CONFIG_ANALYSIS Resultados de sinais que incluem uma configuração analisada pelo MDI/CE.
OBSERVATION_TYPE_OUTAGE Resultados de sinais que incluem uma indisponibilidade do PSH.
OBSERVATION_TYPE_KNOWLEDGE Texto que fornece conhecimentos sobre o problema de um utilizador específico. Por exemplo, instruções/links externos do catálogo de erros, RAG, etc.

ObserverType

Isto representa a forma como os dados foram incluídos na investigação.

Enumerações
OBSERVER_TYPE_UNSPECIFIED Valor predefinido. Não usado.
OBSERVER_TYPE_DIAGNOSTICS Os diagnósticos têm uma noção explícita das causas principais, por exemplo, através de manuais de procedimentos.
OBSERVER_TYPE_SIGNALS Os sinais destinam-se ao processamento que não tem causas principais explícitas.
OBSERVER_TYPE_DETERMINISTIC_CODE Isto destina-se a código que depende apenas das instalações. Em particular, as pesquisas de catálogos de erros.
OBSERVER_TYPE_AI Isto destina-se a inferências de IA que dependem apenas de observações listadas como premissas.
OBSERVER_TYPE_USER Observação de entradas do utilizador, incluindo respostas a esclarecimentos. Todas as observações especificadas pelo utilizador vão ser convertidas neste tipo.
OBSERVER_TYPE_ALERT Uma observação de um alerta.

UserRelevance

Isto representa o julgamento de relevância expresso por um utilizador de uma observação.

Enumerações
USER_RELEVANCE_UNSPECIFIED O utilizador não marcou esta observação como relevante ou irrelevante.
USER_RELEVANCE_PROMOTED O utilizador marcou esta observação como relevante.
USER_RELEVANCE_REJECTED O utilizador marcou esta observação como irrelevante.

ObservationCompletionState

Determina se a observação está totalmente formada e completa.

Enumerações
OBSERVATION_COMPLETION_STATE_UNSPECIFIED Valor predefinido. É tratado como CONCLUÍDO.
OBSERVATION_COMPLETION_STATE_COMPLETE Esta observação está totalmente formada.
OBSERVATION_COMPLETION_STATE_INCOMPLETE Esta observação tem algumas informações em falta ou precisa de processamento adicional por parte de outro observador. Este tipo de observação pode ser rejeitado em execuções de investigação futuras.

ObserverStatus

Um ObserverStatus representa o estado de um observador num ponto específico durante a execução de uma investigação.

Representação JSON 
{
  "observer": string,
  "observerExecutionState": enum (ObserverExecution),
  "observerDisplayName": string,
  "updateTime": string,
  "startTime": string,
  "updateComment": string,
  "observerErrors": [
    {
      object (Status)
    }
  ]
}
Campos
observer

string

Apenas saída. Identifica este observador de forma exclusiva. Este valor é sempre igual à chave do mapa deste observador na investigação principal.
observerExecutionState

enum (ObserverExecution)

Opcional. O estado de execução atual do observador.
observerDisplayName

string

Obrigatório. Nome a apresentar legível para o observador.
updateTime

string (Timestamp format)

Opcional. A hora em que o observador atualizou a investigação pela última vez. Se o observerExecutionState estiver COMPLETO ou FALHOU, esta é a hora em que o observador terminou a observação.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
startTime

string (Timestamp format)

Opcional. A hora em que o observador iniciou a observação.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateComment

string

Opcional. Uma atualização do estado do observador.
observerErrors[]

object (Status)

Opcional. Um erro que impediu um observador de fazer uma observação específica.

ObserverExecution

O estado do observador.

Enumerações
OBSERVER_EXECUTION_UNSPECIFIED O estado do observador não está especificado.
OBSERVER_EXECUTION_NOT_STARTED A investigação ainda não começou.
OBSERVER_EXECUTION_RUNNING A investigação está em execução e este observador é executável ou está em execução.
OBSERVER_EXECUTION_COMPLETE O observador terminou sem um erro interno.
OBSERVER_EXECUTION_FAILED O observador tentou ser executado, mas falhou devido a um erro. Isto é específico de um componente e pode ser renderizado na IU se a observação for apresentada como de prioridade muito baixa.
OBSERVER_EXECUTION_BLOCKED O observador está bloqueado até receber uma entrada.
OBSERVER_EXECUTION_INVESTIGATION_BLOCKED O observador comunica um erro que bloqueia ou afeta gravemente a investigação, por exemplo, o CAIS ou o registo desativado. Devem ser renderizados de forma proeminente na IU.
OBSERVER_EXECUTION_INVESTIGATION_DEGRADED O observador comunica um erro que degrada a investigação, podendo exigir que o utilizador encaminhe ou volte a executar a investigação após mitigar a causa.

Métodos

create

 Cria uma nova investigação num determinado projeto.

delete

 Elimina uma única investigação.

get

 Obtém detalhes de uma única investigação.

getIamPolicy

 Obtém a política de controlo de acesso para um recurso.

list

 Apresenta as investigações num determinado projeto e localização.

patch

 Atualiza os parâmetros de uma única investigação.

setIamPolicy

 Define a política de controlo de acesso no recurso especificado.

testIamPermissions

 Devolve as autorizações que um autor da chamada tem no recurso especificado.