MCP Tools Reference: monitoring.googleapis.com

כלי: list_alerts

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

בדוגמת הקוד הבאה מוצג שימוש בפקודה curl כדי להפעיל את הכלי list_alerts MCP.

בקשת Curl
curl --location 'https://monitoring.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "list_alerts",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

סכימת הקלט

בקשת ListAlerts.

ListAlertsRequest

ייצוג JSON
{
  "parent": string,
  "filter": string,
  "orderBy": string,
  "pageSize": integer,
  "pageToken": string
}
שדות
parent

string

חובה. שם הפרויקט שרוצים להציג את ההתראות שלו.

filter

string

זה שינוי אופציונלי. התראה מוחזרת אם יש התאמה בשדות כלשהם ששייכים להתראה או לשדות המשנה שלה.

orderBy

string

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

  • open_time
  • close_time

לדוגמה, close_time desc, open_time תחזיר את ההתראות שנסגרו לאחרונה, ואם יש כמה התראות שנסגרו באותו זמן, הן יוחזרו לפי הסדר שבו הן מופיעות ברשימה, מההתראה הישנה ביותר להתראה החדשה ביותר.

אם השדה לא מוגדר, התוצאות ממוינות לפי open_time desc.

pageSize

integer

זה שינוי אופציונלי. המספר המקסימלי של תוצאות שיוחזרו בתשובה אחת. אם לא מגדירים מספר חיובי, יוחזרו לכל היותר 50 התראות. הערך המקסימלי הוא 1,000. ערכים גבוהים יותר יומרו ל-1,000.

pageToken

string

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

סכימת הפלט

התשובה ListAlerts.

ListAlertsResponse

ייצוג JSON
{
  "alerts": [
    {
      object (Alert)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
שדות
alerts[]

object (Alert)

רשימת ההתראות.

nextPageToken

string

אם הערך לא ריק, יכול להיות שיש עוד תוצאות שתואמות לבקשה. משתמשים בערך בשדה page_token בבקשה הבאה כדי לאחזר את קבוצת התוצאות הבאה. האסימון מוצפן ויש ערובה שהוא יחזיר תוצאות נכונות רק למשך 72 שעות אחרי שהוא נוצר. אם השדה ריק, כל התוצאות הוחזרו.

totalSize

integer

המספר הכולל המשוער של תוצאות שתואמות לשאילתה הזו.

התראה

ייצוג JSON
{
  "name": string,
  "state": enum (State),
  "openTime": string,
  "closeTime": string,
  "resource": {
    object (MonitoredResource)
  },
  "metadata": {
    object (MonitoredResourceMetadata)
  },
  "metric": {
    object (Metric)
  },
  "log": {
    object (LogMetadata)
  },
  "policy": {
    object (PolicySnapshot)
  }
}
שדות
name

string

מזהה. שם ההתראה.

הפורמט הוא:

projects/[PROJECT_ID_OR_NUMBER]/alerts/[ALERT_ID]

‫[ALERT_ID] הוא מזהה ייחודי שהמערכת מקצה להתראה.

state

enum (State)

פלט בלבד. המצב הנוכחי של ההתראה.

openTime

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

closeTime

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

resource

object (MonitoredResource)

סוג המשאב במעקב ותוויות המשאב במעקב שנשמרו מהתנאי שיצר את האירוע.

metadata

object (MonitoredResourceMetadata)

המטא-נתונים של המשאב במעקב.

metric

object (Metric)

סוג המדד ותוויות המדד שנשמרו מהתנאי ליצירת האירוע.

log

object (LogMetadata)

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

policy

object (PolicySnapshot)

תמונת המצב של כללי המדיניות להתראות שגרמו להצגת ההתראה הזו.

חותמת הזמן

ייצוג 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, כולל.

MonitoredResource

ייצוג JSON
{
  "type": string,
  "labels": {
    string: string,
    ...
  }
}
שדות
type

string

חובה. סוג המשאב במעקב. השדה הזה חייב להיות זהה לשדה type של אובייקט MonitoredResourceDescriptor. לדוגמה, הסוג של מכונה וירטואלית ב-Compute Engine הוא gce_instance. רשימה של סוגים זמינה במאמרים סוגי משאבים של Monitoring וסוגי משאבים של Logging.

labels

map (key: string, value: string)

חובה. ערכים לכל התוויות שמופיעות בתיאור המשאב במעקב המשויך. לדוגמה, מכונות וירטואליות של Compute Engine משתמשות בתוויות "project_id", "instance_id" ו-"zone".

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

LabelsEntry

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

string

value

string

MonitoredResourceMetadata

ייצוג JSON
{
  "systemLabels": {
    object
  },
  "userLabels": {
    string: string,
    ...
  }
}
שדות
systemLabels

object (Struct format)

פלט בלבד. ערכים של תוויות מטא-נתונים מוגדרות מראש של המערכת. תוויות מערכת הן סוג של מטא-נתונים שמופקים על ידי Google, כולל machine_image,‏ vpc,‏ subnet_id,‏ security_group,‏ name וכו'. הערכים של תוויות המערכת יכולים להיות רק מחרוזות, ערכים בוליאניים או רשימה של מחרוזות. לדוגמה:

{ "name": "my-test-instance",
  "security_group": ["a", "b", "c"],
  "spot_instance": false }
userLabels

map (key: string, value: string)

פלט בלבד. מיפוי של תוויות מטא-נתונים שהוגדרו על ידי המשתמש.

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

Struct

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

map (key: string, value: value (Value format))

מפה לא מסודרת של ערכים עם הקלדה דינמית.

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

FieldsEntry

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

string

value

value (Value format)

ערך

ייצוג JSON
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
שדות
שדה איחוד kind. סוג הערך. הערך kind יכול להיות רק אחד מהבאים:
nullValue

null

מייצג JSON null.

numberValue

number

מייצג מספר JSON. הערך לא יכול להיות NaN, Infinity או -Infinity, כי אין תמיכה בערכים האלה ב-JSON. בנוסף, אי אפשר לייצג ערכים גדולים של Int64, כי פורמט JSON בדרך כלל לא תומך בהם בסוג המספר שלו.

stringValue

string

מייצג מחרוזת JSON.

boolValue

boolean

מייצג ערך בוליאני ב-JSON (הליטרלים true או false ב-JSON).

structValue

object (Struct format)

מייצג אובייקט JSON.

listValue

array (ListValue format)

מייצג מערך JSON.

ListValue

ייצוג JSON
{
  "values": [
    value
  ]
}
שדות
values[]

value (Value format)

שדה חוזר של ערכים עם הקלדה דינמית.

UserLabelsEntry

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

string

value

string

מדד

ייצוג JSON
{
  "type": string,
  "labels": {
    string: string,
    ...
  }
}
שדות
type

string

סוג מדד קיים, ראו google.api.MetricDescriptor. לדוגמה, custom.googleapis.com/invoice/paid/amount.

labels

map (key: string, value: string)

קבוצת ערכי התוויות שמזהים באופן ייחודי את המדד הזה. צריך להקצות ערכים לכל התוויות שמופיעות ב-MetricDescriptor.

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

LabelsEntry

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

string

value

string

LogMetadata

ייצוג JSON
{
  "extractedLabels": {
    string: string,
    ...
  }
}
שדות
extractedLabels

map (key: string, value: string)

התוויות שחולצו מהיומן.

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

ExtractedLabelsEntry

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

string

value

string

PolicySnapshot

ייצוג JSON
{
  "name": string,
  "displayName": string,
  "severity": enum (Severity),
  "userLabels": {
    string: string,
    ...
  }
}
שדות
name

string

השם של משאב מדיניות ההתראות. בפורמט 'projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]'.

displayName

string

השם המוצג של מדיניות ההתראות.

severity

enum (Severity)

רמת החומרה של מדיניות ההתראות.

userLabels

map (key: string, value: string)

תוויות המשתמשים של מדיניות ההתראות.

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

UserLabelsEntry

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

string

value

string

מדינה

רשימה של מצבים אפשריים להתראה.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED מצב ההתראה לא צוין.
OPEN ההתראה פתוחה.
CLOSED ההתראה נסגרת.

NullValue

מייצג JSON null.

‫NullValue הוא ערך שמירה, שמשתמש בערך מספרי עם ערך אחד בלבד כדי לייצג את ערך ה-null עבור איחוד הסוגים Value.

שדה מסוג NullValue עם ערך כלשהו שאינו 0 נחשב לא תקין. רוב כלי הסריאליזציה של ProtoJSON יפלטו Value עם null_value שמוגדר כ-null JSON בלי קשר לערך המספרי, ולכן יבצעו המרה הלוך ושוב לערך 0.

טיפוסים בני מנייה (enum)
NULL_VALUE ערך null.

חוּמרה

רשימה של רמות חומרה אפשריות למדיניות התראות.

טיפוסים בני מנייה (enum)
SEVERITY_UNSPECIFIED לא צוינה רמת חומרה. זה ערך ברירת המחדל.
CRITICAL זו רמת החומרה הגבוהה ביותר. משתמשים באפשרות הזו אם הבעיה עלולה לגרום לנזק משמעותי או להשבתה.
ERROR זו רמת החומרה הבינונית. משתמשים בזה אם הבעיה עלולה לגרום לנזק קל או להשבתה.
WARNING זו רמת החומרה הכי נמוכה. משתמשים באפשרות הזו אם הבעיה לא גורמת לנזק או להשבתה, אבל עלולה להוביל לבעיה בעתיד.

הערות על כלים

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