MCP Tools Reference: maintenance.googleapis.com

ツール: summarize_maintenances

集計された統計情報を提供することで、指定されたプロジェクトとロケーションのメンテナンスを要約します。

パラメータ

  • parent（文字列、必須）: リソース メンテナンスの親。形式は projects/{project}/locations/{location} です。
  • page_size（整数、省略可）: ページごとに送信するリソース メンテナンスの最大数。
  • page_token（文字列、省略可）: 前回の SummarizeMaintenances 呼び出しから受け取ったページトークン。
  • filter（文字列、省略可）: https://google.aip.dev/160 で指定されているとおりにリストをフィルタします。
  • order_by（文字列、省略可）: https://google.aip.dev/132 で指定されているとおりに結果を並べ替えます。

戻り値

このメソッドは、次の情報を含む SummarizeMaintenancesResponse オブジェクトを返します。

  • maintenances: メンテナンスの概要のリスト。
  • next_page_token: 結果の次のページを取得するために、後続のリクエストで page_token として送信できるトークン。

注

  • すべてのリージョンのグローバルな概要の場所として「-」を使用します。

次のサンプルは、curl を使用して summarize_maintenances MCP ツールを呼び出す方法を示しています。

Curl リクエスト 
                  
curl --location 'https://maintenance.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "summarize_maintenances",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

入力スキーマ

SummarizeMaintenances カスタム メソッドのリクエスト メッセージ。

SummarizeMaintenancesRequest

JSON 表現 
{
  "parent": string,
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "orderBy": string
}
フィールド
parent

string

必須。リソース メンテナンスの親。例: projects/123/locations/*
pageSize

integer

ページごとに送信するリソース メンテナンスの最大数。デフォルトのページサイズは 20 で、最大値は 1,000 です。
pageToken

string

ページトークン: 前のレスポンスの next_page_token が指定されている場合、このリクエストは次のページを送信します。
filter

string

https://google.aip.dev/160 で指定されているとおりにリストをフィルタします。サポートされているフィールドは次のとおりです。- maintenance.maintenanceName 例: - maintenance.maintenanceName="eb3b709c-9ca1-5472-9fb6-800a3849eda1"
orderBy

string

https://google.aip.dev/132 で指定されているとおりに結果を並べ替えます。

出力スキーマ

SummarizeMaintenances カスタム メソッドのリクエスト メッセージ。

SummarizeMaintenancesResponse

JSON 表現 
{
  "maintenances": [
    {
      object (MaintenanceSummary)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
フィールド
maintenances[]

object (MaintenanceSummary)

結果の要約。
nextPageToken

string

存在する場合、次のページトークンを後続の SummarizeMaintenances 呼び出しに指定して、次のページを一覧表示できます。空の場合、これ以上のページはありません。
unreachable[]

string

順序なしリスト。到達できなかったロケーション。

MaintenanceSummary

JSON 表現 
{
  "maintenanceName": string,
  "title": string,
  "description": string,
  "category": enum (MaintenanceCategory),
  "maintenanceScheduledStartTime": string,
  "maintenanceScheduledEndTime": string,
  "maintenanceStartTime": string,
  "maintenanceEndTime": string,
  "userControllable": boolean,
  "controls": [
    {
      object (MaintenanceControl)
    }
  ],
  "stats": [
    {
      object (Stats)
    }
  ]
}
フィールド
maintenanceName

string

出力専用。メンテナンスの名前。
title

string

出力専用。メンテナンスのタイトル。
description

string

出力専用。メンテナンスの説明。
category

enum (MaintenanceCategory)

出力専用。メンテナンス イベントのカテゴリ。
maintenanceScheduledStartTime

string (Timestamp format)

出力専用。メンテナンスの予定開始時間。メンテナンスは maintenanceScheduledStartTime 以降に開始され、maintenanceScheduledEndTime までに完了するよう最善を尽くします。

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"。
maintenanceScheduledEndTime

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"。
maintenanceStartTime

string (Timestamp format)

出力専用。メンテナンスが実際に開始された日付。状態が RUNNING に変更された後にのみ存在するフィールド。

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"。
maintenanceEndTime

string (Timestamp format)

出力専用。メンテナンスが正常に完了した実際の日付。状態が SUCCEEDED に変更された後にのみ存在するフィールド。

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"。
userControllable

boolean

出力専用。ユーザーがメンテナンスを制御できるかどうかを示します。メンテナンス ポリシーでメンテナンスがスケジュールされる前にプロアクティブに制御できるか、スケジュールされた後にリアクティブに制御できるか（controls フィールドを参照）。
controls[]

object (MaintenanceControl)

出力専用。そのメンテナンスで使用可能な制御（メンテナンスが適用されるすべてのリソースで使用できるとは限りません）。
stats[]

object (Stats)

出力専用。Stats は、統計情報を集計するために使用される ResourceMaintenance のフィールドです。

タイムスタンプ

JSON 表現 
{
  "seconds": string,
  "nanos": integer
}
フィールド
seconds

string (int64 format)

UNIX エポック 1970-01-01T00:00:00Z からの UTC 時刻の秒数を表します。-62135596800～253402300799 の範囲（両端を含む）にする必要があります（これは 0001-01-01T00:00:00Z～9999-12-31T23:59:59Z に対応します）。
nanos

integer

ナノ秒分解能による、秒の負ではない小数以下部分。このフィールドは、秒の代替ではなく、期間のナノ秒部分です。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない nanos 値を持つ必要があります。0～999,999,999 にする必要があります（両端を含む）。

MaintenanceControl

JSON 表現 
{
  "control": enum (Control),
  "isCustom": boolean,
  "documentation": string
}
フィールド
control

enum (Control)

リソース メンテナンスの制御。
isCustom

boolean

コントロールが Service Producer API でのみ使用可能かどうか（Unified Maintenance を介しては使用できないかどうか）を示します。
documentation

string

メンテナンス制御に関するサービス プロデューサーのドキュメントへのリンク。isCustom が true の場合にのみ指定されます。

統計情報

JSON 表現 
{
  "groupBy": string,
  "aggregates": [
    {
      object (Aggregate)
    }
  ]
}
フィールド
groupBy

string

groupBy は集計のタイプを指定します。たとえば、group_by は "state" になります。
aggregates[]

object (Aggregate)

Aggregates は <group, count> ペアのリストです。たとえば、group_by が "state" の場合、集計リストのタプルは「SCHEDULED」: 11 になります。

集計

JSON 表現 
{
  "group": string,
  "count": string
}
フィールド
group

string

count が表す group_by の特定の値が何であるかを指定します。たとえば、group_by が "state" の場合、対応するグループは "SCHEDULED" になります。
count

string (int64 format)

グループの数。

MaintenanceCategory

メンテナンスのカテゴリ。

列挙型
MAINTENANCE_CATEGORY_UNSPECIFIED カテゴリが指定されていません。
INFRASTRUCTURE インフラストラクチャ メンテナンス イベントとは、Google Cloud がネットワーク機器（Google Cloud Interconnect など）の定期的なメンテナンスを実施することです。通常、このイベントは事前にスケジュール設定されます。可能な限り通知が提供されるため、ユーザーはインフラストラクチャ メンテナンス イベントに対応した計画を立て、ダウンタイムを回避できます。インフラストラクチャ メンテナンス イベントの間隔は決まっていませんが、通常は年に数回実行されます。
SERVICE_UPDATE 既存のバージョンと下位互換性のあるバグの修正、変更、新機能（パッチを含む）を含むことができるアップデート。一部の SP では、メンテナンスの時間枠やメンテナンス拒否機能を使用して、ユーザーがこれらのメンテナンス イベントのスケジュールを制御できます。

管理

サポートされている制御のタイプを設定します。コメント（ログなど）。

列挙型
CONTROL_UNSPECIFIED 未指定のコントロール。
APPLY コントロールを適用します。
MANAGE_POLICY ポリシー制御を管理します。
RESCHEDULE スケジュール変更コントロール。

ツールのアノテーション

破壊的ヒント: ❌ | べき等ヒント: ✅ | 読み取り専用ヒント: ✅ | オープン ワールド ヒント: ❌