MCP Tools Reference: maintenance.googleapis.com

ツール: list_resource_maintenances

指定されたプロジェクトとロケーションのリソース メンテナンスを一覧表示します。

パラメータ

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

戻り値

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

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

注

  • すべてのリージョンを対象としたグローバル ビューのロケーションとして「-」を使用します。

次のサンプルは、curl を使用して list_resource_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": "list_resource_maintenances",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

入力スキーマ

ListResourceMaintenances メソッドのリクエスト構造。

ListResourceMaintenancesRequest

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

string

必須。リソース メンテナンスの親。
pageSize

integer

ページごとに送信するリソース メンテナンスの最大数。
pageToken

string

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

string

https://google.aip.dev/160 で指定されているとおりにリストをフィルタします。
orderBy

string

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

出力スキーマ

ListResourceMaintenances メソッドのレスポンス構造。

ListResourceMaintenancesResponse

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

object (ResourceMaintenance)

結果のリソース メンテナンス。
nextPageToken

string

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

string

到達できなかったロケーション。

リソースのメンテナンス

JSON 表現 
{
  "name": string,
  "resource": {
    object (Resource)
  },
  "maintenance": {
    object (Maintenance)
  },
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "maintenanceStartTime": string,
  "maintenanceEndTime": string,
  "maintenanceCancelTime": string,
  "maintenanceScheduledStartTime": string,
  "maintenanceScheduledEndTime": string,
  "userControllable": boolean,
  "controls": [
    {
      object (MaintenanceControl)
    }
  ],
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string
}
フィールド
name

string

ID。resource_maintenance リソースの名前。形式: "projects/{project}/locations/{location}/resourceMaintenance/{resource-maintenance-id}"
resource

object (Resource)

出力専用。リソース メンテナンスのリソース仕様。
maintenance

object (Maintenance)

出力専用。メンテナンスの詳細。
state

enum (State)

出力専用。リソース メンテナンスの状態。
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"。
maintenanceStartTime

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

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

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

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

boolean

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

object (MaintenanceControl)

出力専用。メンテナンスの制御。
labels

map (key: string, value: string)

省略可。リソースのラベル。分類に使用できます。Kubernetes リソースラベルに似ています。

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

map (key: string, value: string)

省略可。アノテーションは、任意のメタデータを保存して取得するため、外部ツールによって設定される可能性のあるリソースとともに保存される非構造化 Key-Value マップです。クエリは実行可能ではなく、オブジェクトを変更する際に保持する必要があります。

詳細: https://kubernetes.io/docs/user-guide/annotations

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

string

出力専用。リソースの固有識別子。UID は、サービスのスコープ内で、このリソースの時間と場所において一意性を持ちます。通常は、リソースの作成時にサーバーによって生成され、変更されることはありません。UID は、リソース名が再利用される場合でも一意にリソースを識別するために使用されます。UUID4 であることが必要です。
etag

string

出力専用。リソースのバージョンまたは世代を一意に識別する、不透明な値です。書き込まれるリソースの順序についてクライアントとサーバーの間で確実に同意するために使用できます。

リソース

JSON 表現 
{
  "resourceName": string,
  "location": string,
  "type": string
}
フィールド
resourceName

string

出力専用。name は、メンテナンスの影響を受けるコンシューマー リソースへの参照です。使用可能な値については、https://cloud.google.com/asset-inventory/docs/asset-names をご覧ください。
location

string

出力専用。リソースのロケーション。形式: us-central1
type

string

出力専用。リソースのタイプ。使用可能な値については、https://cloud.google.com/asset-inventory/docs/asset-types#supported_resource_types をご覧ください。なお、すべてのリソースタイプでメンテナンスが報告されるわけではありません。

メンテナンス

JSON 表現 
{
  "maintenanceName": string,
  "title": string,
  "description": string,
  "category": enum (MaintenanceCategory)
}
フィールド
maintenanceName

string

メンテナンスは、標準の命名スキーム "{maintenance-id}" に従った対応するメンテナンス リソースの名前です。
title

string

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

string

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

enum (MaintenanceCategory)

出力専用。メンテナンスのカテゴリ。

タイムスタンプ

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 の場合にのみ指定されます。

LabelsEntry

JSON 表現 
{
  "key": string,
  "value": string
}
フィールド
key

string
value

string

AnnotationsEntry

JSON 表現 
{
  "key": string,
  "value": string
}
フィールド
key

string
value

string

MaintenanceCategory

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

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

状態

State は、リソース メンテナンスの状態です。

列挙型
STATE_UNSPECIFIED 未指定の状態
SCHEDULED 特定の期間にスケジュール設定されている。中断を伴うメンテナンスでは、メンテナンス ポリシー（利用可能な時間枠、除外、通知期間など）が尊重される必要があります。
RUNNING メンテナンスが進行中です。
CANCELLED 計画されなくなった場合。通常は、他のメンテナンス（新しいバージョンへのアップグレードなど）がすでに完了しているか、ユーザーがメンテナンスをスキップした場合です。
SUCCEEDED 正常に完了しました。

管理

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

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

ツールのアノテーション

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