[comment]: # ({141d16ad-923acd1d})
# 6 媒介类型

[comment]: # ({/141d16ad-923acd1d})

[comment]: # ({c9522a12-e0b517c9})
#### 概述

媒介类型是与所有相关对象和对象关系一起[导出](/manual/xml_export_import)的。

[comment]: # ({/c9522a12-e0b517c9})

[comment]: # ({9c206628-7e0a36b8})
#### 导出时

导出媒体类型，请执行以下操作:

-   前往: *Administration* → *Media types*
-   标记要导出的媒介类型的复选框
-   点击列表下面的*导出*

![](../../../assets/en/manual/xml_export_import/export_mediatypes.png)

根据选择的格式，媒体类型被导出到一个默认名称的本地文件:

-   *zabbix\_export\_mediatypes.yaml* - 以YAML文件格式进行导出(导出的默认选项)
-   *zabbix\_export\_mediatypes.xml* - 以XML文件格式进行导出
-   *zabbix\_export\_mediatypes.json* - 以JSON文件格式进行导出

[comment]: # ({/9c206628-7e0a36b8})

[comment]: # ({fdf43bcc-7f828bf2})
#### 导入

要导入媒体类型，请执行以下操作：

1. 前往 *告警* → *媒体类型*。
2. 单击右上角的 *导入*。
3. 选择导入文件。
4. 在导入规则中勾选所需选项。
5. 单击配置表单右下角的 *导入*。

![](../../../assets/en/manual/xml_export_import/import_media.png){width="600"}

导入规则：

|规则|说明|
|----|-----------|
|*更新现有项*|将使用导入文件中的数据更新现有元素。否则，将不会更新这些元素。|
|*创建新项*|将使用导入文件中的数据创建新元素。否则，将不会创建这些元素。|

前端将显示导入成功或失败的消息。

[comment]: # ({/fdf43bcc-7f828bf2})

[comment]: # ({0e03cb7e-480f411a})
#### 导出格式

导出为 YAML：

```yaml
zabbix_export:
  version: '7.4'
  media_types:
    - name: Pushover
      type: WEBHOOK
      parameters:
        - name: endpoint
          value: 'https://api.pushover.net/1/messages.json'
        - name: eventid
          value: '{EVENT.ID}'
        - name: event_nseverity
          value: '{EVENT.NSEVERITY}'
        - name: event_source
          value: '{EVENT.SOURCE}'
        - name: event_value
          value: '{EVENT.VALUE}'
        - name: expire
          value: '1200'
        - name: message
          value: '{ALERT.MESSAGE}'
        - name: priority_average
          value: '0'
        - name: priority_default
          value: '0'
        - name: priority_disaster
          value: '0'
        - name: priority_high
          value: '0'
        - name: priority_information
          value: '0'
        - name: priority_not_classified
          value: '0'
        - name: priority_warning
          value: '0'
        - name: retry
          value: '60'
        - name: title
          value: '{ALERT.SUBJECT}'
        - name: token
          value: '<PUSHOVER TOKEN HERE>'
        - name: triggerid
          value: '{TRIGGER.ID}'
        - name: url
          value: '{$ZABBIX.URL}'
        - name: url_title
          value: Zabbix
        - name: user
          value: '{ALERT.SENDTO}'
      status: DISABLED
      max_sessions: '0'
      script: |
        try {
            var params = JSON.parse(value),
                request = new HttpRequest(),
                data,
                response,
                severities = [
                    {name: 'not_classified', color: '#97AAB3'},
                    {name: 'information', color: '#7499FF'},
                    {name: 'warning', color: '#FFC859'},
                    {name: 'average', color: '#FFA059'},
                    {name: 'high', color: '#E97659'},
                    {name: 'disaster', color: '#E45959'},
                    {name: 'resolved', color: '#009900'},
                    {name: 'default', color: '#000000'}
                ],
                priority;
        
            if (typeof params.HTTPProxy === 'string' && params.HTTPProxy.trim() !== '') {
                request.setProxy(params.HTTPProxy);
            }
    
            if ([0, 1, 2, 3].indexOf(parseInt(params.event_source)) === -1) {
                throw '传入的 "event_source" 参数不正确: "' + params.event_source + '"。\n必须为 0-3。';
            }
       
            if (params.event_value !== '0' && params.event_value !== '1'
                && (params.event_source === '0' || params.event_source === '3')) {
                throw '传入的 "event_value" 参数不正确: ' + params.event_value + '\n必须为 0 或 1。';
            }
      
            if ([0, 1, 2, 3, 4, 5].indexOf(parseInt(params.event_nseverity)) === -1) {
                params.event_nseverity = '7';
            }
      
            if (params.event_value === '0') {
                params.event_nseverity = '6';
            }
     
            priority = params['priority_' + severities[params.event_nseverity].name] || params.priority_default;
      
            if (isNaN(priority) || priority < -2 || priority > 2) {
                throw '"priority" 应为 -2..2';
            }
      
            if (params.event_source === '0' && isNaN(params.triggerid)) {
                throw '字段 "triggerid" 不是数字';
            }
      
            if (isNaN(params.eventid)) {
                throw '字段 "eventid" 不是数字';
            }
      
            if (typeof params.message !== 'string' || params.message.trim() === '') {
                throw '字段 "message" 不能为空';
            }
        
            data = {
                token: params.token,
                user: params.user,
                title: params.title,
                message: params.message,
                url: (params.event_source === '0') 
                    ? params.url + '/tr_events.php?triggerid=' + params.triggerid + '&eventid=' + params.eventid
                    : params.url,
                url_title: params.url_title,
                priority: priority
            };
        
            if (priority == 2) {
                if (isNaN(params.retry) || params.retry < 30) {
                    throw '当 "priority" 设置为 2 时，字段 "retry" 应为一个值至少为 30 的数字';
                }
       
                if (isNaN(params.expire) || params.expire > 10800) {
                    throw '当 "priority" 设置为 2 时，字段 "expire" 应为一个值最多为 10800 的数字';
                }
        
                data.retry = params.retry;
                data.expire = params.expire;
            }
       
            data = JSON.stringify(data);
            Zabbix.log(4, '[ Pushover Webhook ] Sending request: ' + params.endpoint + '\n' + data);
    
            request.addHeader('Content-Type: application/json');
            response = request.post(params.endpoint, data);
       
            Zabbix.log(4, '[ Pushover Webhook ] Received response with status code ' + request.getStatus() + '\n' + response);
       
            if (response !== null) {
                try {
                    response = JSON.parse(response);
                }
                catch (error) {
                    Zabbix.log(4, '[ Pushover Webhook ] Failed to parse response received from Pushover');
                    response = null;
                }
            }
       
            if (request.getStatus() != 200 || response === null || typeof response !== 'object' || response.status !== 1) {
                if (response !== null && typeof response === 'object' && typeof response.errors === 'object'
                        && typeof response.errors[0] === 'string') {
                    throw response.errors[0];
                }
                else {
                    throw 'Unknown error. Check debug log for more information.';
                }
            }
        
            return 'OK';
        }
        catch (error) {
            Zabbix.log(4, '[ Pushover Webhook ] Pushover notification failed: ' + error);
            throw 'Pushover notification failed: ' + error;
        }
      description: |
        请参考此处的设置指南：https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/media/pushover?at=refs%2Fheads%2Frelease%2F7.4
        
        将 token 参数设置为您的 Pushover 应用密钥。
        将 Pushover 媒体分配给 Zabbix 用户时，请在“发送到”字段中添加用户密钥。
      message_templates:
        - event_source: TRIGGERS
          operation_mode: PROBLEM
          subject: '问题：{EVENT.NAME}'
          message: |
            问题开始于 {EVENT.TIME}，日期 {EVENT.DATE}
            问题名称：{EVENT.NAME}
            主机：{HOST.NAME}
            严重性：{EVENT.SEVERITY}
            运行数据：{EVENT.OPDATA}
            原始问题 ID：{EVENT.ID}
            {TRIGGER.URL}
        - event_source: TRIGGERS
          operation_mode: RECOVERY
          subject: '在 {EVENT.DURATION} 内已解决：{EVENT.NAME}'
          message: |
            问题已于 {EVENT.RECOVERY.TIME}，日期 {EVENT.RECOVERY.DATE} 解决
            问题名称：{EVENT.NAME}
            问题持续时间：{EVENT.DURATION}
            主机：{HOST.NAME}
            严重性：{EVENT.SEVERITY}
            原始问题 ID：{EVENT.ID}
            {TRIGGER.URL}
        - event_source: TRIGGERS
          operation_mode: UPDATE
          subject: '已更新的问题，持续 {EVENT.AGE}：{EVENT.NAME}'
          message: |
            {USER.FULLNAME} 于 {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME} {EVENT.UPDATE.ACTION} 了问题。
            {EVENT.UPDATE.MESSAGE}
          
            当前问题状态为 {EVENT.STATUS}，持续时间为 {EVENT.AGE}，已确认：{EVENT.ACK.STATUS}。
        - event_source: DISCOVERY
          operation_mode: PROBLEM
          subject: '发现：{DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}'
          message: |
            发现规则：{DISCOVERY.RULE.NAME}
           
            设备 IP：{DISCOVERY.DEVICE.IPADDRESS}
            设备 DNS：{DISCOVERY.DEVICE.DNS}
            设备状态：{DISCOVERY.DEVICE.STATUS}
            设备运行时间：{DISCOVERY.DEVICE.UPTIME}
            
            设备服务名称：{DISCOVERY.SERVICE.NAME}
            设备服务端口：{DISCOVERY.SERVICE.PORT}
            设备服务状态：{DISCOVERY.SERVICE.STATUS}
            设备服务运行时间：{DISCOVERY.SERVICE.UPTIME}
        - event_source: AUTOREGISTRATION
          operation_mode: PROBLEM
          subject: '自动注册：{HOST.HOST}'
          message: |
            主机名：{HOST.HOST}
            主机 IP：{HOST.IP}
            agent 端口：{HOST.PORT}
```

[comment]: # ({/0e03cb7e-480f411a})

[comment]: # ({5f52b0c3-f0190043})
####导出的元素

导出的元素在下表中进行了解释。

|元素|<|类型|描述|
|-|---|---|------------------|
|name|<|string|(必需)媒体类型名称。|
|type|<|string|(必需)媒体类型使用的传输方式。<br>可能的取值：^[1](#footnotes)^EMAIL(0),SMS(1),SCRIPT(2),WEBHOOK(4)。|
|status|<|string|媒体类型是否启用。<br>可能的取值：^[1](#footnotes)^ENABLED(0,默认),DISABLED(1)。|
|max_sessions|<|integer|可以并行处理的最大警报数。<br>SMS的可能取值：^[1](#footnotes)^1(默认)。<br>其他媒体类型的可能取值：^[1](#footnotes)^0-100(其中0表示无限制)。|
|attempts|<|integer|发送警报的最大尝试次数。<br>可能的取值：^[1](#footnotes)^1-10(默认为3)。|
|attempt_interval|<|string|重试尝试之间的间隔（使用秒或[时间后缀](/manual/appendix/suffixes#time-suffixes)）。<br>可能的取值：^[1](#footnotes)^0-60s(默认为10s)。|
|description|<|string|媒体类型描述。|
|message_templates|<||用于媒体类型消息模板的根元素。|
||event_source|string|(必需)事件来源。<br>可能的取值：^[1](#footnotes)^TRIGGERS(0),DISCOVERY(1),AUTOREGISTRATION(2),INTERNAL(3),SERVICE(4)。|
|^|operation_mode|string|操作模式。<br>可能的取值：^[1](#footnotes)^PROBLEM(0),RECOVERY(1),UPDATE(2)。|
|^|subject|string|消息主题。|
|^|message|string|消息正文。|

:::noteclassic
另请参阅：[媒体类型对象](/manual/api/reference/mediatype/object)（查看相关属性与匹配名称）。
:::

[comment]: # ({/5f52b0c3-f0190043})

[comment]: # ({1252a795-f8c574e0})
**电子邮件**

以下附加元素仅针对 *电子邮件* 媒介类型导出。

|Element|<|Type|Description|
|-|---|---|-----------------------|
|provider|<|string|电子邮件提供商。|
|smtp\_server|<|string|SMTP 服务器。|
|smtp\_port|<|integer|要连接的 SMTP 服务器端口。<br>默认值：25。|
|smtp\_helo|<|string|SMTP helo。|
|smtp\_email|<|string|用于发送通知的电子邮件地址。|
|smtp\_security|<|string|要使用的 SMTP 连接安全级别。<br>可能的值：^[1](#footnotes)^ NONE (0，默认)，STARTTLS (1)，SSL\_OR\_TLS (2)。|
|smtp\_verify\_host|<|string|SMTP 的 SSL 验证主机。<br>可能的值：^[1](#footnotes)^ NO (0，默认)，YES (1)。|
|smtp\_verify\_peer|<|string|SMTP 的 SSL 验证对端。<br>可能的值：^[1](#footnotes)^ NO (0，默认)，YES (1)。|
|smtp\_authentication|<|string|要使用的 SMTP 身份验证方法。<br>可能的值：^[1](#footnotes)^ NONE (0，默认)，PASSWORD (1)，OAUTH (2)。|
|username|<|string|用户名。|
|password|<|string|身份验证密码。|
|redirection\_url|<|string|用于重定向回 OAuth 授权的 Zabbix 前端 URL。|
|client\_id|<|string|在 OAuth 授权服务器中注册的客户端标识符。|
|authorization\_url|<|string|用于获取访问令牌和刷新令牌的 OAuth URL（带参数）。|
|token\_url|<|string|用于将授权令牌交换为访问令牌和刷新令牌的 OAuth URL。|
|message\_format|<|string|消息格式。<br>可能的值：^[1](#footnotes)^ TEXT (0)，HTML (1，默认)。|

::: noteclassic
另请参见：[Media type object](/manual/api/reference/mediatype/object)（请参阅名称匹配的相关属性）。
:::

[comment]: # ({/1252a795-f8c574e0})

[comment]: # ({0c1541c3-bb543a21})
**SMS**

以下附加元素仅针对*SMS*媒体类型进行导出。

|元素|<|类型|描述|
|---|---|--------|----------|
|gsm_modem|<|string|(必需)GSM模块的串行设备名称。|

:::noteclassic
另请参阅：[媒体类型对象](/manual/api/reference/mediatype/object)（查看相关属性与匹配名称）。
:::

[comment]: # ({/0c1541c3-bb543a21})

[comment]: # ({a2dd5866-fdd6388b})
**脚本**

以下附加元素仅针对*脚本*媒体类型进行导出。

|元素|<|类型|描述|
|------------------|---|--------|--------------------------------|
|scriptname|<|string|(必需)脚本名称。|
|parameters|<||脚本参数的根元素。|
|sortorder|<|string|(必需)传递给脚本的参数的排序顺序。|
|value|<|string|脚本参数的值。|

:::noteclassic
另请参阅：[媒体类型对象](/manual/api/reference/mediatype/object)（查看相关属性与匹配名称）。
:::

[comment]: # ({/a2dd5866-fdd6388b})

[comment]: # ({28dc7d8d-7429c5ea})
**Webhook**

以下附加元素仅针对*Webhook*媒体类型进行导出。

|元素|<|类型|描述|
|----|---|--------|-----------------|
|script|<|string|脚本。|
|timeout|<|string|JavaScript脚本HTTP请求超时时间间隔。<br>可能的值：^[1](#footnotes)^1-60s（默认为30s）。|
|process\_tags|<|string|是否处理返回的标签。<br>可能的值：^[1](#footnotes)^NO(0,默认),YES(1)。|
|show\_event\_menu|<|string|如果在`event_menu_url`和`event_menu_name`字段中成功解析了{EVENT.TAGS.\*}宏，则指示事件菜单中存在条目。<br>可能的值：^[1](#footnotes)^NO(0,默认),YES(1)。|
|event\_menu\_url|<|string|事件菜单条目的URL。支持{EVENT.TAGS.\*}宏。|
|event\_menu\_name|<|string|事件菜单条目的名称。支持{EVENT.TAGS.\*}宏。|
|parameters|<||Webhook媒体类型参数的根元素。|
|name|<|string|(必需)Webhook参数的名称。|
|value|<|string|Webhook参数的值。|

:::noteclassic
另请参阅：[媒体类型对象](/manual/api/reference/mediatype/object)（查看相关属性与匹配名称）。
:::

[comment]: # ({/28dc7d8d-7429c5ea})

[comment]: # ({74389cfd-c1b1c6ab})
#### 附注

^1^ API 中的整数值在括号中，例如，ENABLED (0)，仅供参考。
有关更多信息，请参阅表中每个条目的链接 API 对象页面或各节末尾。

[comment]: # ({/74389cfd-c1b1c6ab})