Table of Contents
获取
描述
integer/array mediatype.get(对象参数)
该方法允许根据给定的参数检索媒体类型。
此方法对任何类型的用户（自 Zabbix 7.0.6 版起对 User 类型用户）可用。 在用户角色设置中可以撤销调用该方法的权限。 请参阅 用户角色 以获取更多信息。
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
当请求与用户相关的媒体类型信息时，Admin 类型用户（自 Zabbix 7.0.4 起）和 User 类型用户（自 Zabbix 7.0.9 起）只能检索有关他们自己的用户数据。 有关示例，请参阅 作为 Admin 检索媒体类型。
| 参数 | 类型 | 描述 |
|---|---|---|
| mediatypeids | ID/数组 | 仅返回具有给定 ID 的媒体类型。 |
| mediaids | ID/数组 | 仅返回由给定 媒体 使用的媒体类型。 |
| userids | ID/数组 | 仅返回由给定用户使用的媒体类型。 |
| selectActions | 查询 | 返回一个包含使用媒体类型的动作的 actions 属性。 |
| selectMessageTemplates | 查询 | 返回一个包含媒体类型消息的 message_templates 属性的数组。参数行为: - 支持 用于 Super admin 类型用户（自 Zabbix 7.0.4 起） |
| selectUsers | 查询 | 返回一个包含使用媒体类型的用户的 users 属性。请参阅 user.get 以了解基于用户类型的限制。 |
| sortfield | 字符串/数组 | 根据给定属性对结果进行排序。 可能的值： mediatypeid。 |
| filter | 对象 | 仅返回与给定过滤器完全匹配的结果。 接受一个对象，其中键是属性名称，值是单个值或与之匹配的值数组。 不支持 text 数据类型的属性。可能的 Media type object 属性对于 Admin 类型用户（自 Zabbix 7.0.4 起）和 User 类型用户（自 Zabbix 7.0.6 起）： mediatypeid，name，type，status，maxattempts。 |
| output | 查询 | Media type object 属性将被返回。 Admin 类型用户（自 Zabbix 7.0.4 起）和 User 类型用户（自 Zabbix 7.0.6 起）只能检索以下属性： mediatypeid，name，type，status，maxattempts，description。有关示例，请参阅 作为 Admin 检索媒体类型。默认： extend。 |
| search | 对象 | 返回与给定模式匹配的结果（不区分大小写）。 接受一个对象，其中键是属性名称，值是用于搜索的字符串。如果没有给出其他选项，这将执行一个 LIKE "%…%" 搜索。仅支持 string 和 text 数据类型的属性。可能的 Media type object 属性对于 Admin 类型用户（自 Zabbix 7.0.4 起）和 User 类型用户（自 Zabbix 7.0.6 起）： name，description。 |
| countOutput | 布尔值 | 这些参数在 参考说明 中描述。 |
| editable | 布尔值 | |
| excludeSearch | 布尔值 | |
| limit | 整数 | |
| preservekeys | 布尔值 | |
| searchByAny | 布尔值 | |
| searchWildcardsEnabled | 布尔值 | |
| sortorder | 字符串/数组 | |
| startSearch | 布尔值 |
返回值
(整型/数组) 返回其中之一：
- 一个对象数组；
- 如果使用
countOutput参数，返回被检索对象的数量。
示例
获取媒体类型
检索所有配置的媒体类型。以下示例返回两种媒体类型：
- 邮件媒体类型；
- SMS媒体类型。
请求:
{
"jsonrpc": "2.0",
"method": "mediatype.get",
"params": {
"output": "extend",
"selectMessageTemplates": "extend"
},
"id": 1
}响应:
{
"jsonrpc": "2.0",
"result": [
{
"mediatypeid": "1",
"type": "0",
"name": "Email",
"smtp_server": "mail.example.com",
"smtp_helo": "example.com",
"smtp_email": "[email protected]",
"exec_path": "",
"gsm_modem": "",
"username": "",
"passwd": "",
"status": "0",
"smtp_port": "25",
"smtp_security": "0",
"smtp_verify_peer": "0",
"smtp_verify_host": "0",
"smtp_authentication": "0",
"maxsessions": "1",
"maxattempts": "3",
"attempt_interval": "10s",
"message_format": "0",
"script": "",
"timeout": "30s",
"process_tags": "0",
"show_event_menu": "1",
"event_menu_url": "",
"event_menu_name": "",
"description": "",
"provider": "0",
"message_templates": [
{
"eventsource": "0",
"recovery": "0",
"subject": "Problem: {EVENT.NAME}",
"message": "Problem started at {EVENT.TIME} on {EVENT.DATE}\r\nProblem name: {EVENT.NAME}\r\nHost: {HOST.NAME}\r\nSeverity: {EVENT.SEVERITY}\r\nOperational data: {EVENT.OPDATA}\r\nOriginal problem ID: {EVENT.ID}\r\n{TRIGGER.URL}"
},
{
"eventsource": "0",
"recovery": "1",
"subject": "Resolved: {EVENT.NAME}",
"message": "Problem has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}\r\nProblem name: {EVENT.NAME}\r\nHost: {HOST.NAME}\r\nSeverity: {EVENT.SEVERITY}\r\n\r\nOriginal problem ID: {EVENT.ID}\r\n{TRIGGER.URL}"
},
{
"eventsource": "0",
"recovery": "2",
"subject": "Updated problem: {EVENT.NAME}",
"message": "{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.\r\n{EVENT.UPDATE.MESSAGE}\r\n\r\nCurrent problem status is {EVENT.STATUS}, acknowledged: {EVENT.ACK.STATUS}."
},
{
"eventsource": "1",
"recovery": "0",
"subject": "Discovery: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}",
"message": "Discovery rule: {DISCOVERY.RULE.NAME}\r\n\r\nDevice IP: {DISCOVERY.DEVICE.IPADDRESS}\r\nDevice DNS: {DISCOVERY.DEVICE.DNS}\r\nDevice status: {DISCOVERY.DEVICE.STATUS}\r\nDevice uptime: {DISCOVERY.DEVICE.UPTIME}\r\n\r\nDevice service name: {DISCOVERY.SERVICE.NAME}\r\nDevice service port: {DISCOVERY.SERVICE.PORT}\r\nDevice service status: {DISCOVERY.SERVICE.STATUS}\r\nDevice service uptime: {DISCOVERY.SERVICE.UPTIME}"
},
{
"eventsource": "2",
"recovery": "0",
"subject": "Autoregistration: {HOST.HOST}",
"message": "Host name: {HOST.HOST}\r\nHost IP: {HOST.IP}\r\nAgent port: {HOST.PORT}"
}
],
"parameters": []
},
{
"mediatypeid": "3",
"type": "2",
"name": "SMS",
"smtp_server": "",
"smtp_helo": "",
"smtp_email": "",
"exec_path": "",
"gsm_modem": "/dev/ttyS0",
"username": "",
"passwd": "",
"status": "0",
"smtp_port": "25",
"smtp_security": "0",
"smtp_verify_peer": "0",
"smtp_verify_host": "0",
"smtp_authentication": "0",
"maxsessions": "1",
"maxattempts": "3",
"attempt_interval": "10s",
"message_format": "1",
"script": "",
"timeout": "30s",
"process_tags": "0",
"show_event_menu": "1",
"event_menu_url": "",
"event_menu_name": "",
"description": "",
"provider": "0",
"message_templates": [
{
"eventsource": "0",
"recovery": "0",
"subject": "",
"message": "{EVENT.SEVERITY}: {EVENT.NAME}\r\nHost: {HOST.NAME}\r\n{EVENT.DATE} {EVENT.TIME}"
},
{
"eventsource": "0",
"recovery": "1",
"subject": "",
"message": "RESOLVED: {EVENT.NAME}\r\nHost: {HOST.NAME}\r\n{EVENT.DATE} {EVENT.TIME}"
},
{
"eventsource": "0",
"recovery": "2",
"subject": "",
"message": "{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}"
},
{
"eventsource": "1",
"recovery": "0",
"subject": "",
"message": "Discovery: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}"
},
{
"eventsource": "2",
"recovery": "0",
"subject": "",
"message": "Autoregistration: {HOST.HOST}\r\nHost IP: {HOST.IP}\r\nAgent port: {HOST.PORT}"
}
],
"parameters": []
}
],
"id": 1
}作为管理员检索媒体类型
作为管理员类型的用户，检索所有已启用的媒体类型，以及使用这些媒体类型的用户。 以下示例返回两种媒体类型：
- 自Zabbix 7.0.4版本起，仅管理员类型用户自己的用户使用的电子邮件媒体类型，带有一个用户；
- 没有用户使用的SMS媒体类型。
请求：
{
"jsonrpc": "2.0",
"method": "mediatype.get",
"params": {
"output": "extend",
"filter": {
"status": 0
},
"selectUsers": "extend"
},
"id": 1
}响应：
{
"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",
"provisioned": "0"
}
]
},
{
"mediatypeid": "3",
"type": "2",
"name": "SMS",
"status": "0",
"description": "",
"maxattempts": "3",
"users": []
}
],
"id": 1
}检索脚本和 webhook 媒介类型
以下示例返回三种媒介类型：
- 带参数的脚本媒介类型;
- 不带参数的脚本媒介类型;
- 带参数的 Webhook 媒介类型。
请求：
{
"jsonrpc": "2.0",
"method": "mediatype.get",
"params": {
"output": ["mediatypeid", "name", "parameters"],
"filter": {
"type": [1, 4]
}
},
"id": 1
}响应：
{
"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
}参见
来源
ui/include/classes/api/services/CMediaType.php 中的 CMediaType::get()。