MCP Tools Reference: maintenance.googleapis.com

Outil : list_resource_maintenances

Liste les maintenances de ressources pour un projet et un emplacement donnés.

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 ListResourceMaintenances 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 ListResourceMaintenancesResponse, qui contient les éléments suivants :

  • resource_maintenances : liste des maintenances de ressources correspondant aux critères de la requête.
  • 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 une vue globale de toutes les régions.

L'exemple suivant montre comment utiliser curl pour appeler l'outil MCP list_resource_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": "list_resource_maintenances",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Schéma d'entrée

Structure de la requête pour la méthode ListResourceMaintenances.

ListResourceMaintenancesRequest

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

string

Obligatoire. Parent de la maintenance de la ressource.
pageSize

integer

Nombre maximal de maintenances de ressources à envoyer par page.
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.
orderBy

string

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

Schéma de sortie

Structure de réponse pour la méthode ListResourceMaintenances.

ListResourceMaintenancesResponse

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

object (ResourceMaintenance)

Les maintenances de ressources résultantes.
nextPageToken

string

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

string

Emplacements inaccessibles.

Maintenance de la ressource

Représentation 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
}
Champs
name

string

Identifiant. Nom de la ressource resource_maintenance. Format : "projects/{project}/locations/{location}/resourceMaintenance/{resource-maintenance-id}"
resource

object (Resource)

Uniquement en sortie. Spécification de ressource de la maintenance de la ressource.
maintenance

object (Maintenance)

Uniquement en sortie. Détails de la maintenance.
state

enum (State)

Uniquement en sortie. État de la maintenance de la ressource.
createTime

string (Timestamp format)

Uniquement en sortie. Heure de création de la maintenance de la ressource.

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".
updateTime

string (Timestamp format)

Uniquement en sortie. Heure de mise à jour de la maintenance de la ressource.

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. Heure à laquelle la maintenance de la ressource a commencé.

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. Heure à laquelle la maintenance de la ressource est terminé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".
maintenanceCancelTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la maintenance de la ressource a été annulé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".
maintenanceScheduledStartTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la maintenance de la ressource était censée commencer.

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 à laquelle la maintenance de la ressource devait se terminer.

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 qu'elle ne soit planifiée 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ôles de la maintenance.
labels

map (key: string, value: string)

Facultatif. Étiquettes de la ressource, qui peuvent être utilisées pour la catégorisation. Elles sont semblables aux étiquettes de ressources Kubernetes.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
annotations

map (key: string, value: string)

Facultatif. Les annotations sont un mappage clé-valeur non structuré stocké avec une ressource. Elles peuvent être définies par des outils externes pour stocker et récupérer des métadonnées arbitraires. Elles ne peuvent pas faire l'objet de requêtes et doivent être conservées lors de la modification d'objets.

Pour en savoir plus, consultez https://kubernetes.io/docs/user-guide/annotations.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
uid

string

Uniquement en sortie. Identifiant unique de la ressource. L'UID est unique dans le temps et l'espace pour cette ressource dans le cadre du service. Il est habituellement généré par le serveur lors de la création réussie d'une ressource et ne doit pas être modifié. L'UID permet d'identifier de manière unique les ressources avec réutilisation du nom. Il doit être un UUID4.
etag

string

Uniquement en sortie. Valeur opaque qui identifie de manière unique la version ou la génération d'une ressource. Cet identifiant permet de confirmer que le client et le serveur sont d'accord sur l'ordre d'écriture d'une ressource.

Ressource

Représentation JSON 
{
  "resourceName": string,
  "location": string,
  "type": string
}
Champs
resourceName

string

Uniquement en sortie. "Name" fait référence à la ressource consommateur concernée par la maintenance. Les valeurs disponibles sont disponibles sur cette page : https://cloud.google.com/asset-inventory/docs/asset-names.
location

string

Uniquement en sortie. Emplacement de la ressource. Format : us-central1
type

string

Uniquement en sortie. Type de ressource. Les valeurs disponibles sont disponibles ici : https://cloud.google.com/asset-inventory/docs/asset-types#supported_resource_types. Veuillez noter que les opérations de maintenance ne seront pas signalées pour tous les types de ressources.

Maintenance

Représentation JSON 
{
  "maintenanceName": string,
  "title": string,
  "description": string,
  "category": enum (MaintenanceCategory)
}
Champs
maintenanceName

string

"maintenance" est le nom de la ressource de maintenance correspondante, qui suit le schéma de dénomination standard : "{maintenance-id}".
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 la maintenance.

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.

LabelsEntry

Représentation JSON 
{
  "key": string,
  "value": string
}
Champs
key

string
value

string

AnnotationsEntry

Représentation JSON 
{
  "key": string,
  "value": string
}
Champs
key

string
value

string

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.

État

"State" correspond à l'état d'une maintenance de ressource.

Enums
STATE_UNSPECIFIED État non spécifié.
SCHEDULED Planifiée pour une période spécifique. Pour la maintenance avec interruption, il doit respecter les règles de maintenance, c'est-à-dire ses intervalles disponibles, ses exclusions et sa période de notification.
RUNNING Une opération de maintenance est en cours.
CANCELLED Plus prévu, généralement lorsqu'une autre maintenance (par exemple, une mise à niveau vers une version plus récente) a déjà eu lieu ou que l'utilisateur a ignoré la maintenance.
SUCCEEDED Opération réussie.

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 : ❌