MCP Tools Reference: maintenance.googleapis.com

Outil : summarize_maintenances

Résume les opérations de maintenance pour un projet et un emplacement donnés en fournissant des statistiques agrégées.

Paramètres

  • parent (chaîne, obligatoire) : parent de la maintenance de la ressource, au format projects/{project}/locations/{location}.
  • page_size (entier, facultatif) : nombre maximal de maintenances de ressources à envoyer par page.
  • page_token (chaîne, facultatif) : jeton de page reçu d'un appel SummarizeMaintenances précédent.
  • filter (chaîne, facultatif) : filtrez la liste comme indiqué dans https://google.aip.dev/160.
  • order_by (string, Optional) : ordonne les résultats comme indiqué dans https://google.aip.dev/132.

Valeur renvoyée

La méthode renvoie un objet SummarizeMaintenancesResponse, qui contient les éléments suivants :

  • maintenances : liste des récapitulatifs de maintenance.
  • next_page_token : jeton pouvant être envoyé en tant que page_token dans une requête ultérieure pour récupérer la page de résultats suivante.

Remarques

  • Utilisez "-" comme emplacement pour obtenir un récapitulatif global pour toutes les régions.

L'exemple suivant montre comment utiliser curl pour appeler l'outil MCP summarize_maintenances.

Requête 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
}'
                

Schéma d'entrée

Message de requête pour la méthode personnalisée SummarizeMaintenances.

SummarizeMaintenancesRequest

Représentation JSON
{
  "parent": string,
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "orderBy": string
}
Champs
parent

string

Obligatoire. Parent de la maintenance de la ressource. Par exemple, projects/123/locations/*

pageSize

integer

Nombre maximal de maintenances de ressources à envoyer par page. La taille de page par défaut est de 20 et la taille maximale est de 1 000.

pageToken

string

Jeton de page : si le next_page_token d'une réponse précédente est fourni, cette requête enverra la page suivante.

filter

string

Filtrez la liste comme indiqué dans https://google.aip.dev/160. Voici quelques exemples de champs acceptés : - maintenance.maintenanceName Exemples : - maintenance.maintenanceName="eb3b709c-9ca1-5472-9fb6-800a3849eda1"

orderBy

string

Ordonne les résultats comme indiqué dans https://google.aip.dev/132.

Schéma de sortie

Message de requête pour la méthode personnalisée SummarizeMaintenances.

SummarizeMaintenancesResponse

Représentation JSON
{
  "maintenances": [
    {
      object (MaintenanceSummary)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Champs
maintenances[]

object (MaintenanceSummary)

Résumés obtenus

nextPageToken

string

Si le jeton de page suivante est présent, il peut être fourni à un appel SummarizeMaintenances ultérieur pour lister la page suivante. Si ce champ est vide, cela signifie qu'il n'y a plus de pages.

unreachable[]

string

Liste non triée. Emplacements inaccessibles.

MaintenanceSummary

Représentation 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)
    }
  ]
}
Champs
maintenanceName

string

Uniquement en sortie. Nom de la maintenance.

title

string

Uniquement en sortie. Titre de la maintenance.

description

string

Uniquement en sortie. Description de la maintenance.

category

enum (MaintenanceCategory)

Uniquement en sortie. Catégorie de l'événement de maintenance.

maintenanceScheduledStartTime

string (Timestamp format)

Uniquement en sortie. Heure de début planifiée de la maintenance. La maintenance commencera à maintenanceScheduledStartTime ou plus tard, et nous ferons tout notre possible pour qu'elle se termine avant maintenanceScheduledEndTime.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

maintenanceScheduledEndTime

string (Timestamp format)

Uniquement en sortie. Heure de fin estimée (au mieux, sans garantie) de la maintenance planifiée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

maintenanceStartTime

string (Timestamp format)

Uniquement en sortie. Date réelle à laquelle la maintenance a commencé. Champ présent uniquement une fois que l'état est passé à RUNNING.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

maintenanceEndTime

string (Timestamp format)

Uniquement en sortie. Date à laquelle la maintenance a été effectuée. Champ présent uniquement une fois que l'état est passé à SUCCEEDED.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

userControllable

boolean

Uniquement en sortie. Indique si l'utilisateur a un certain contrôle sur cette maintenance, soit de manière proactive avant la planification de la maintenance avec une stratégie de maintenance, soit avec des contrôles réactifs après sa planification (voir le champ "controls").

controls[]

object (MaintenanceControl)

Uniquement en sortie. Contrôle disponible pour cette maintenance (il est possible qu'il ne soit pas disponible pour toutes les ressources auxquelles la maintenance est appliquée).

stats[]

object (Stats)

Uniquement en sortie. "Stats" est un champ de ResourceMaintenance utilisé pour agréger les statistiques.

Horodatage

Représentation JSON
{
  "seconds": string,
  "nanos": integer
}
Champs
seconds

string (int64 format)

Représente les secondes de l'heure UTC à partir de l'epoch Unix 1970-01-01T00:00:00Z. La valeur doit être comprise entre -62135596800 et 253402300799 inclus (ce qui correspond à 0001-01-01T00:00:00Z et 9999-12-31T23:59:59Z).

nanos

integer

Fractions de secondes non négatives avec une précision de l'ordre de la nanoseconde. Ce champ correspond à la partie en nanosecondes de la durée, et non à une alternative aux secondes. Les valeurs de secondes négatives avec des fractions doivent toujours comporter des valeurs de nanosecondes non négatives comptabilisées dans le temps. La valeur doit être comprise entre 0 et 999 999 999 inclus.

MaintenanceControl

Représentation JSON
{
  "control": enum (Control),
  "isCustom": boolean,
  "documentation": string
}
Champs
control

enum (Control)

Le contrôle de la maintenance des ressources.

isCustom

boolean

Indique si le contrôle n'est disponible que dans l'API Service Producer (et non via Unified Maintenance).

documentation

string

Lien vers la documentation Service Producer sur le contrôle de la maintenance. Fourni uniquement lorsque isCustom est défini sur true.

Statistiques

Représentation JSON
{
  "groupBy": string,
  "aggregates": [
    {
      object (Aggregate)
    }
  ]
}
Champs
groupBy

string

groupBy spécifie le type d'agrégat. Par exemple, un group_by peut être "state".

aggregates[]

object (Aggregate)

"Aggregates" est une liste de paires <group, count>. Par exemple, si group_by est "state", un tuple possible dans la liste des agrégats peut être "SCHEDULED" : 11.

Aggregate

Représentation JSON
{
  "group": string,
  "count": string
}
Champs
group

string

Spécifie la valeur spécifique de group_by que le nombre représente. Par exemple, si group_by est "state", le groupe correspondant peut être "SCHEDULED".

count

string (int64 format)

Nombre d'éléments dans le groupe.

MaintenanceCategory

Catégorie de la maintenance.

Enums
MAINTENANCE_CATEGORY_UNSPECIFIED Catégorie non spécifiée.
INFRASTRUCTURE Les événements de maintenance d'infrastructure correspondent à des périodes pendant lesquelles Google Cloud effectue une maintenance régulière sur l'équipement réseau, par exemple Google Cloud Interconnect. Ces événements sont généralement programmés à l'avance et nous vous envoyons une notification, lorsque cela est possible, afin que vous puissiez planifier l'événement de maintenance d'infrastructure et éviter les temps d'arrêt. Les événements de maintenance de l'infrastructure n'ont pas d'intervalle défini entre eux, mais se produisent généralement plusieurs fois par an.
SERVICE_UPDATE Mises à jour pouvant inclure des corrections de bugs, des modifications ou de nouvelles fonctionnalités rétrocompatibles avec les versions existantes (y compris les correctifs). Certains fournisseurs de services permettent aux utilisateurs de contrôler la planification de ces événements de maintenance à l'aide d'intervalles de maintenance et/ou de fonctionnalités de refus de la maintenance.

Contrôle

Définit le type de contrôle pris en charge. comment (comme dans les journaux).

Enums
CONTROL_UNSPECIFIED Commande non spécifiée.
APPLY Appliquez le contrôle.
MANAGE_POLICY Gérer le contrôle des règles
RESCHEDULE Reprogrammer le contrôle.

Annotations d'outils

Indication destructive : ❌ | Indication d'idempotence : ✅ | Indication de lecture seule : ✅ | Indication de monde ouvert : ❌