REST Resource: projects.locations.investigations

リソース: Investigation

Gemini Cloud Assist Troubleshooting の調査の内容を保持します。

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)
    },
    ...
  }
}
フィールド
name

string

ID。調査の名前。形式: projects/{projectNumber}/locations/{locationId}/investigations/{investigationId}
createTime

string (Timestamp format)

出力専用。調査が作成された時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。調査が最後に更新された日時。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
labels

map (key: string, value: string)

省略可。調査のユーザー定義ラベル。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
revision

string

出力専用。調査の現在のリビジョンのリソース名。形式は projects/{projectNumber}/locations/{locationId}/investigations/{investigationId}/revisions/{revision_id} です。
revisionIndex

integer

出力専用。調査の現在のリビジョンのインデックス。
revisionPredecessor

string

省略可。このリビジョンの直前のリビジョンの名前。
annotations

object (InvestigationAnnotations)

省略可。調査に関する追加のアノテーション。
executionState

enum (InvestigationExecutionState)

出力専用。調査の実行状態。
error

object (Status)

出力専用。調査の実行が失敗した場合のエラー。このフィールドは、executionState が INVESTIGATION_EXECUTION_STATE_FAILED の場合にのみ設定されます。
operation

string

出力専用。調査で最後に実行された Run オペレーションのリソース名。形式は projects/{projectNumber}/locations/{locationId}/operations/{operation_id} です。
title

string

省略可。人が読める形式の、調査の表示タイトル。
observations

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

省略可。調査の内容を構成するプロジェクトの状態に関する観察結果。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }。
observerStatuses

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

省略可。調査を実行するために呼び出されたオブザーバーのステータス。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }。

InvestigationAnnotations

Investigation に関する追加のアノテーション。

JSON 表現 
{
  "supportCase": string,
  "revisionLastRunInterval": {
    object (Interval)
  },
  "pagePath": string,
  "extrasMap": {
    string: string,
    ...
  }
}
フィールド
supportCase

string

省略可。調査に関連付けられたサポートケース ID。
revisionLastRunInterval

object (Interval)

出力専用。調査が最後に実行された期間。
pagePath

string

省略可。この調査が作成されたウェブページのパス。
extrasMap

map (key: string, value: string)

省略可。クライアントが指定した追加のアノテーション。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }。

間隔

時間間隔を表します。開始日時を示す Timestamp（この日時を含む）と終了日時を示す Timestamp（この日時を含まない）としてエンコードされます。

開始日時は終了日時以前にする必要があります。開始日時と終了日時が同じ場合、時間間隔は空になります（どの時間とも一致しません）。開始日時と終了日時が両方とも指定されていない場合、その時間間隔はすべての時間と一致します。

JSON 表現 
{
  "startTime": string,
  "endTime": string
}
フィールド
startTime

string (Timestamp format)

省略可。時間間隔の開始日時（この日時を含む）。

指定した場合、開始日時と同じかそれ以降の Timestamp がこの時間間隔に一致します。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
endTime

string (Timestamp format)

省略可。時間間隔の終了日時（この日時を含まない）。

指定した場合、終了時刻より前の Timestamp がこの時間間隔に一致します。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

InvestigationExecutionState

調査の実行状態。

列挙型
INVESTIGATION_EXECUTION_STATE_UNSPECIFIED デフォルト値。この値は使用されません。
INVESTIGATION_EXECUTION_STATE_RUNNING 調査が実行中です。
INVESTIGATION_EXECUTION_STATE_MODIFIED 調査は最後に更新されてからまだ実行されていません。
INVESTIGATION_EXECUTION_STATE_FAILED 調査の実行は完了しましたが、失敗しました。
INVESTIGATION_EXECUTION_STATE_COMPLETED すべての実行タスクが完了し、調査は解決しました。

観察

観察は、調査対象のシステムの状態に関する単一の事実と、その関連性のランキングを表します。

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
}
フィールド
id

string

出力専用。この観察を一意に識別します。これは常に、親調査におけるこの観察のマップキーと等しくなります。
timeIntervals[]

object (Interval)

省略可。このモニタリング データがいつ発生したかを示します。
title

string

省略可。人が読める形式の、モニタリングの表示タイトル。
observationType

enum (ObservationType)

必須。モニタリングのタイプ。
observerType

enum (ObserverType)

必須。このオブザベーションを生成したオブザーバーのタイプ。
text

string

省略可。観察を説明する自然言語またはマークダウン テキスト。
data

object (Struct format)

省略可。観察の構造化表現。特定のスキーマに準拠する必要はありません。また、準拠することも保証されません。
dataUrls

map (key: string, value: string)

省略可。この観察結果を裏付ける証拠を示す URL。人が読める形式の説明と URL を対応付けるマップ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }。
knowledgeUrls

map (key: string, value: string)

省略可。このモニタリングに関連する参照知識を指す URL。人が読める形式の説明と URL を対応付けるマップ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }。
baseObservations[]

string

省略可。この観察の基となる他の観察の ID。たとえば、仮説の観察では、その仮説を裏付ける観察を記録します。
relevantResources[]

string

省略可。この観察に関連する Google Cloud リソース。完全修飾されたリソース URI を指定する必要があります。例: "//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance"
recommendation

string

省略可。根本原因を修復するか、問題をさらに調査するための推奨アクションを記述した自然言語またはマークダウン テキスト。
systemRelevanceScore

number

省略可。オブザーバーがこの観察をどの程度関連性があると認識しているか。これは、仮説の生成でモニタリング結果をランク付けするために使用されます。システムは [-1, 1] の範囲で観測値を出力します。-1 は完全に無関係、0 は中立、1 は関連性に対する完全な信頼を意味します。
relevanceOverride

enum (UserRelevance)

省略可。ユーザーによる関連性の判断。
observationCompletionState

enum (ObservationCompletionState)

省略可。観察が完全に形成されていて、結論を導き出すために使用できるかどうかを表します。
observedNormalOperation

boolean

省略可。false または未指定の場合、この観察から問題または根本原因に関する情報が得られます。true の場合、このモニタリングはシステムが正常に動作していることを示します。このような負の結果は診断結果として有用な場合があり、このフィールドは関連性スコアと相関関係がありません。

ObservationType

観察を構成するデータの種類を表します。これは生成元とは無関係です。たとえばログは、ユーザーによって明示的に提供されることも、AI によって抽出されることも、ランブックによって検出されることもあります。

列挙型
OBSERVATION_TYPE_UNSPECIFIED デフォルト値。
OBSERVATION_TYPE_CLOUD_LOG この観察のテキストはログエントリです。
OBSERVATION_TYPE_CLOUD_METRIC この観察の内容は、指標または指標のグループです。
OBSERVATION_TYPE_CAIS_CONFIG 構成
OBSERVATION_TYPE_CAIS_CONFIG_DIFF 構成の変更
OBSERVATION_TYPE_CLOUD_ALERT アラート
OBSERVATION_TYPE_CICD_EVENT 継続的インテグレーション システムからのイベント（プローバーの失敗など）。
OBSERVATION_TYPE_TEXT_DESCRIPTION 自由形式のテキスト入力（最初のユーザー入力など）。マークダウンを使用できます。
OBSERVATION_TYPE_HYPOTHESIS これはシステムによって導き出された（仮の）結論を表すためのものです。これらは後続のリビジョンへの入力になる可能性があります。この場合、推奨事項は使用されますが、修復は使用されません。
OBSERVATION_TYPE_STRUCTURED_INPUT 構造化された入力（フォームに入力されたランブック パラメータなど）
OBSERVATION_TYPE_COMPOSITE ランブックの出力など、複数の種類の証拠を含む観察に使用されます。
OBSERVATION_TYPE_OTHER 他に適用可能なタイプがない場合、ランブックの出力は「その他」にすることができます。
OBSERVATION_TYPE_LOG_THEME ログで検出されたテーマ。
OBSERVATION_TYPE_CONFIG_ANALYSIS LLM によって分析された構成を含むシグナル出力。
OBSERVATION_TYPE_OUTAGE PSH からの停止を含むシグナル出力。
OBSERVATION_TYPE_KNOWLEDGE 特定のユーザーの問題に関する知識を提供するテキスト。たとえば、エラーカタログの手順 / 外部リンク、RAG など。

ObserverType

どのようにしてデータが調査に取り込まれたかを表します。

列挙型
OBSERVER_TYPE_UNSPECIFIED デフォルト値。使用されていません。
OBSERVER_TYPE_DIAGNOSTICS 診断は、（たとえばランブックを介して）根本原因という明確な概念を持ちます。
OBSERVER_TYPE_SIGNALS シグナルは、明確な根本原因を持たない処理向けです。
OBSERVER_TYPE_DETERMINISTIC_CODE これはオンプレミスのみに依存するコードのために用意されています。特に、エラーカタログのルックアップ用です。
OBSERVER_TYPE_AI これは、前提として挙げられた観察のみに基づいて行われる AI 推論のためのものです。
OBSERVER_TYPE_USER ユーザー入力の観察（明確化に対する回答を含む）。ユーザーが指定したすべての観測値はこの型に強制変換されます。
OBSERVER_TYPE_ALERT アラートからのモニタリング データ。

UserRelevance

観察に対してユーザーが下した関連性の判断を表します。

列挙型
USER_RELEVANCE_UNSPECIFIED ユーザーがこの観察を関連性ありまたは関連性なしとしてマークしていません。
USER_RELEVANCE_PROMOTED ユーザーがこの観察を関連性ありとマークしました。
USER_RELEVANCE_REJECTED ユーザーがこの観察を関連性なしとマークしました。

ObservationCompletionState

観察が完全に形成されていて、完了しているかどうかを表します。

列挙型
OBSERVATION_COMPLETION_STATE_UNSPECIFIED デフォルト値。完了として扱われます。
OBSERVATION_COMPLETION_STATE_COMPLETE この観察は完全に形成されています。
OBSERVATION_COMPLETION_STATE_INCOMPLETE この観察は情報が不足しているか、別のオブザーバーによるさらなる処理を必要としています。このタイプのオブザベーションは、今後の調査の実行で破棄される可能性があります。

ObserverStatus

ObserverStatus は、調査実行中の特定の時点におけるオブザーバーのステータスを表します。

JSON 表現 
{
  "observer": string,
  "observerExecutionState": enum (ObserverExecution),
  "observerDisplayName": string,
  "updateTime": string,
  "startTime": string,
  "updateComment": string,
  "observerErrors": [
    {
      object (Status)
    }
  ]
}
フィールド
observer

string

出力専用。このオブザーバーを一意に識別します。これは常に、親調査内のこのオブザーバーのマップキーと等しくなります。
observerExecutionState

enum (ObserverExecution)

省略可。オブザーバーの現在の実行状態。
observerDisplayName

string

必須。オブザーバーの表示名（人が読める形式）。
updateTime

string (Timestamp format)

省略可。オブザーバーが最後に調査を更新した日時。observerExecutionState が COMPLETE または FAILED の場合、これはオブザーバーがモニタリングを終了した時間です。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
startTime

string (Timestamp format)

省略可。オブザーバーがモニタリングを開始した時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateComment

string

省略可。オブザーバーからのステータスの更新。
observerErrors[]

object (Status)

省略可。オブザーバーによる特定の観察の作成を妨げたエラー。

ObserverExecution

オブザーバーの状態。

列挙型
OBSERVER_EXECUTION_UNSPECIFIED オブザーバーの状態は指定されていません。
OBSERVER_EXECUTION_NOT_STARTED 調査はまだ開始されていません。
OBSERVER_EXECUTION_RUNNING 調査が実行中で、このオブザーバーが実行可能であるか現在実行中です。
OBSERVER_EXECUTION_COMPLETE オブザーバーが内部エラーなしで終了しました。
OBSERVER_EXECUTION_FAILED オブザーバーが実行を試みましたが、エラーにより失敗しました。これは特定のコンポーネントに固有のものであり、その観察が UI に表示される場合、非常に優先度の低い情報として扱われることがあります。
OBSERVER_EXECUTION_BLOCKED オブザーバーは入力待ちでブロックされています。
OBSERVER_EXECUTION_INVESTIGATION_BLOCKED オブザーバーが、調査を妨げるエラー、または調査に重大な影響を与えるエラー（CAIS やロギングの無効化など）を報告しました。UI に目立つようにレンダリングする必要があります。
OBSERVER_EXECUTION_INVESTIGATION_DEGRADED オブザーバーが、調査の質を低下させるエラーを報告しました。ユーザーはエスカレーションするか、原因を緩和してから調査を再実行しなければならない場合があります。

メソッド

create

 指定されたプロジェクトに新しい Investigation を作成します。

delete

 単一の Investigation を削除します。

get

 単一の Investigation の詳細を取得します。

getIamPolicy

 リソースのアクセス制御ポリシーを取得します。

list

 指定されたプロジェクトとロケーションにある Investigations のリストを取得します。

patch

 単一の Investigation のパラメータを更新します。

setIamPolicy

 指定したリソースにアクセス制御ポリシーを設定します。

testIamPermissions

 指定したリソースに対して呼び出し元が持っている権限を返します。