Documentation
Table of Contents
mediatype.get
תיאור
integer/array mediatype.get(object parameters)
השיטה מאפשרת לשלוף סוגי מדיה לפי הנתון פרמטרים.
שיטה זו זמינה למשתמשים מכל סוג. הרשאות כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה משתמש תפקידים למידע נוסף.
פרמטרים
(object) פרמטרים המגדירים את הפלט הרצוי.
השיטה תומכת בפרמטרים הבאים.
| פרמטר | סוג | תיאור |
|---|---|---|
| mediatypeids | string/array | החזר רק סוגי מדיה עם המזהים הנתונים. |
| mediaids | string/array | החזר רק סוגי מדיה המשמשים את המדיה הנתונה. |
| userids | string/array | החזר רק סוגי מדיה המשמשים את המשתמשים הנתונים. |
| selectMessageTemplates | query | החזר מאפיין message_templates עם מערך של הודעות מסוג מדיה. |
| selectUsers | query | החזר מאפיין משתמשים עם המשתמשים שמשתמשים בסוג המדיה. |
| sortfield | string/array | מיין את התוצאה לפי המאפיינים הנתונים. ערכים אפשריים הם: mediatypeid. |
| countOutput | boolean | הפרמטרים הללו, המשותפים לכל שיטות ה-'get', מתוארים בפירוט בפירוש ההתייחסות. |
| עריכה | בוליאנית | |
| excludeSearch | בולאני | |
| filter | object | |
| limit | מספר שלם | |
| פלט | שאילתה | |
| preservekeys | בולאני | |
| חיפוש | אובייקט | |
| searchByAny | boolean | |
| searchWildcardsEnabled | בוליאני | |
| sortorder | מחרוזת/מערך | |
| startSearch | boolean |
החזר ערכים
(מספר שלם/מערך) מחזיר אחד:
- מערך של חפצים;
- ספירת האובייקטים שאוחזרו, אם יש לפרמטר
countOutputנעשה שימוש.
דוגמאות
החזר ערכים
(מספר שלם/מערך) מחזיר אחד:
- מערך של חפצים;
- ספירת האובייקטים שאוחזרו, אם יש לפרמטר
countOutputנעשה שימוש.
Retrieving media types as Admin
As an Admin type user, retrieve all media types that are enabled, with users that use these media types. The following example returns two media types:
- email media type with one user (since Zabbix 6.4.19, only Admin type user's own user);
- SMS media type with no users.
{
"jsonrpc": "2.0",
"method": "mediatype.get",
"params": {
"output": "extend",
"filter": {
"status": 0
},
"selectUsers": "extend"
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"mediatypeid": "1",
"type": "0",
"name": "Email",
"status": "0",
"description": "",
"maxattempts": "3",
"users": [
{
"userid": "3",
"username": "database-admin",
"name": "John",
"surname": "Doe",
"url": "",
"autologin": "0",
"autologout": "0",
"lang": "default",
"refresh": "30s",
"theme": "default",
"attempt_failed": "0",
"attempt_ip": "",
"attempt_clock": "0",
"rows_per_page": "50",
"timezone": "default",
"roleid": "2",
"userdirectoryid": "0",
"ts_provisioned": "0"
}
]
},
{
"mediatypeid": "3",
"type": "2",
"name": "SMS",
"status": "0",
"description": "",
"maxattempts": "3",
"users": []
}
],
"id": 1
}Retrieve script and webhook media types
The following example returns three media types:
- script media type with parameters;
- script media type without parameters;
- webhook media type with parameters.
{
"jsonrpc": "2.0",
"method": "mediatype.get",
"params": {
"output": ["mediatypeid", "name", "parameters"],
"filter": {
"type": [1, 4]
}
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"mediatypeid": "10",
"name": "Script with parameters",
"parameters": [
{
"sortorder": "0",
"value": "{ALERT.SENDTO}"
},
{
"sortorder": "1",
"value": "{EVENT.NAME}"
},
{
"sortorder": "2",
"value": "{ALERT.MESSAGE}"
},
{
"sortorder": "3",
"value": "Zabbix alert"
}
]
},
{
"mediatypeid": "13",
"name": "Script without parameters",
"parameters": []
},
{
"mediatypeid": "11",
"name": "Webhook",
"parameters": [
{
"name": "alert_message",
"value": "{ALERT.MESSAGE}"
},
{
"name": "event_update_message",
"value": "{EVENT.UPDATE.MESSAGE}"
},
{
"name": "host_name",
"value": "{HOST.NAME}"
},
{
"name": "trigger_description",
"value": "{TRIGGER.DESCRIPTION}"
},
{
"name": "trigger_id",
"value": "{TRIGGER.ID}"
},
{
"name": "alert_source",
"value": "Zabbix"
}
]
}
],
"id": 1
}מידע נוסף
מקור
CMediaType::get() בתוך ui/include/classes/api/services/CMediaType.php.