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 (string, אופציונלי): סדר התוצאות כפי שמפורט בכתובת https://google.aip.dev/132.

ערך מוחזר

השיטה מחזירה אובייקט ListResourceMaintenancesResponse, שמכיל:

  • ‫resource_maintenances: רשימה של פעולות תחזוקה של משאבים שתואמות לקריטריונים של הבקשה.
  • ‫next_page_token: אסימון שאפשר לשלוח כ-page_token בבקשה הבאה כדי לאחזר את דף התוצאות הבא.

הערות

  • כדי לקבל תצוגה גלובלית בכל האזורים, משתמשים ב-'-' כמיקום.

בדוגמה הבאה אפשר לראות איך משתמשים ב-curl כדי להפעיל את כלי ה-MCP‏ list_resource_maintenances.

בקשת 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

מיקומים שלא ניתן להגיע אליהם.

ResourceMaintenance

ייצוג 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

מזהה. השם של משאב 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)

זה שינוי אופציונלי. ההערות הן מיפוי לא מובנה של מפתח/ערך שמאוחסן עם משאב, ואפשר להגדיר אותן באמצעות כלים חיצוניים כדי לאחסן ולאחזר מטא-נתונים שרירותיים. אי אפשר להריץ עליהם שאילתות, וצריך לשמור אותם כשמשנים אובייקטים.

מידע נוסף: https://kubernetes.io/docs/user-guide/annotations

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
uid

string

פלט בלבד. המזהה הייחודי של המשאב. המזהה הייחודי הוא ייחודי בזמן ובמרחב של המשאב הזה במסגרת השירות. בדרך כלל הוא נוצר על ידי השרת אחרי יצירה מוצלחת של משאב, ואסור לשנות אותו. המזהה הייחודי משמש לזיהוי ייחודי של משאבים עם שימוש חוזר בשם המשאב. הערך צריך להיות UUID4.
etag

string

פלט בלבד. ערך אטום שמזהה באופן ייחודי גרסה או דור של משאב. אפשר להשתמש בו כדי לוודא שהלקוח והשרת מסכימים על הסדר של משאב שנכתב.

משאב

ייצוג JSON 
{
  "resourceName": string,
  "location": string,
  "type": string
}
שדות
resourceName

string

פלט בלבד. השם הוא ההפניה למשאב הצרכן שהושפע מהתחזוקה. הערכים הזמינים מפורטים כאן: 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)

מייצג את השניות של זמן UTC מאז ראשית זמן יוניקס (Unix epoch) ‏1970-01-01T00:00:00Z. הערך חייב להיות בין ‎-62135596800 ל-‎253402300799, כולל (שמתאים לטווח 0001-01-01T00:00:00Z עד 9999-12-31T23:59:59Z).
nanos

integer

שבריר לא שלילי של שנייה ברזולוציית ננו-שנייה. השדה הזה מייצג את החלק של משך הזמן בננו-שניות, ולא מהווה חלופה לשניות. ערכי שניות שליליים עם שברים עדיין צריכים לכלול ערכי ננו-שניות לא שליליים שסופרים קדימה בזמן. הערך חייב להיות בין 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

קישור למסמכי Service Producer בנושא בקרת תחזוקה. הערך מסופק רק אם isCustom הוא true.

LabelsEntry

ייצוג JSON 
{
  "key": string,
  "value": string
}
שדות
key

string
value

string

AnnotationsEntry

ייצוג JSON 
{
  "key": string,
  "value": string
}
שדות
key

string
value

string

MaintenanceCategory

קטגוריית התחזוקה.

טיפוסים בני מנייה (enum)
MAINTENANCE_CATEGORY_UNSPECIFIED הקטגוריה לא צוינה.
INFRASTRUCTURE אירועי תחזוקת תשתית הם מקרים שבהם Google Cloud מבצעת תחזוקה שוטפת בציוד הרשת, למשל Google Cloud Interconnect. בדרך כלל האירועים האלה מתוזמנים מראש, ואנחנו שולחים התראה כשזה אפשרי, כדי שהמשתמשים יוכלו להתכונן לאירוע תחזוקת התשתית ולמנוע השבתה. לא נקבע מרווח זמן בין אירועי תחזוקת התשתית, אבל בדרך כלל הם מתרחשים כמה פעמים בשנה.
SERVICE_UPDATE עדכונים שיכולים לכלול תיקוני באגים, שינויים או תכונות חדשות שתואמות לאחור לגרסאות קיימות (כולל תיקוני אבטחה). חלק מספקי השירות מאפשרים למשתמשים לשלוט בתזמון של אירועי התחזוקה האלה באמצעות חלונות תחזוקה או תכונות שמאפשרות לדחות את התחזוקה.

מדינה

המצב הוא המצב של תחזוקת משאב.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED מצב לא מוגדר.
SCHEDULED מתוזמן לחלון מסוים. במקרה של תחזוקה שגורמת לשיבושים, היא צריכה להתבצע בהתאם למדיניות התחזוקה, כלומר בחלונות הזמן הזמינים, ללא החרגות ובפרק הזמן שנקבע למתן התראה.
RUNNING התחזוקה נמשכת.
CANCELLED לא מתוכננת יותר, בדרך כלל כשכבר בוצעה תחזוקה אחרת (למשל, שדרוג לגרסה חדשה יותר) או שהמשתמש דילג על התחזוקה.
SUCCEEDED הפעולה הושלמה בהצלחה.

שליטה

מגדירה את סוג הבקרה הנתמך. הערה (כמו ביומנים).

טיפוסים בני מנייה (enum)
CONTROL_UNSPECIFIED סוג השליטה לא צוין.
APPLY החלת אמצעי הבקרה.
MANAGE_POLICY ניהול של אמצעי בקרה למדיניות.
RESCHEDULE אמצעי בקרה לשינוי המועד.

הערות על כלים

רמז הרסני: ❌ | רמז אידמפוטנטי: ✅ | רמז לקריאה בלבד: ✅ | רמז לעולם פתוח: ❌