MailTrafficSummary 报告
MailTrafficSummary REST URI 提供各种类别的摘要列表,这些类别与通过组织的 Office 365 电子邮件系统处理的邮件相关。报告的开始和结束日期/时间可以在请求中指定,正如可以指定聚合数据的时间段。该报告返回 20 个一般命名的字段,这些字段中的数据可以根据其他选项更改。
上次修改时间: 2015年9月17日
适用范围: Office 365
REST URI
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficTop[?ODATA options]
字段
下列字段可在 $select、$filter 和 $orderby ODATA2 查询选项中指定。如果没有提供 $select 选项,将返回所有字段。
名称 |
WCF 类型* |
EDM 类型* |
[In/Out]** 说明 |
示例值 |
在其中添加的服务版本 |
---|---|---|---|---|---|
C1 至 C20 |
通常为 string |
通常未指定 |
[In/Out] 在此字段中数据的含义各不相同。请参阅"备注"部分中的定义。 |
userone@example.onmicrosoft.com |
2013-V1 |
Category |
string |
未指定 |
[In] 请求的摘要报告类型。$filter 选项中此字段的设置决定 C1-C20 字段的含义。请参阅"备注"部分,了解详细信息。 |
OutboundHits、TopMailSender、TopMalware 等 |
2013-V1 |
DlpPolicy |
string |
未指定 |
[In/Out] 应用于邮件的 DLP 策略的名称。有关有效 DlpPolicy 值的信息,请参阅 MailFilterList 报告。 |
Financial Data Detection、HIPAA Detection、PII Detection |
2013-V1 |
Domain |
string |
未指定 |
[In/Out] 处理电子邮件的完全限定的域名。 |
example.onmicrosoft.com |
2013-V1 |
EndDate |
System.DateTime |
Edm.DateTime |
[In] 此字段用于限制报告期间。在 $filter 查询选项中使用此字段设置报告期间的结束日期和时间。如果您在 $filter 选项中提供 EndDate,则还必须提供 StartDate。 |
简写日期(例如,03/10/2013)或带引号的日期时间(例如,"03/10/2013 4:55 PM") |
2013-V1 |
StartDate |
System.DateTime |
Edm.DateTime |
[In] 此字段用于限制报告期间。在 $filter 查询选项中使用此字段设置报告期间的开始日期和时间。如果您在 $filter 选项中提供 StartDate,则还必须指定 EndDate。 |
简写日期(例如,03/10/2013)或带引号的日期时间(例如,"03/10/2013 4:55 PM") |
2013-V1 |
TransportRule |
string |
未指定 |
在处理步骤中执行的 Microsoft Exchange 传输规则的名称。有关有效 TransportRule 值的信息,请参阅 MailFilterList 报告。 |
PII Detection |
2013-V1 |
*WCF 类型指在 Visual Studio 中创建 Windows Communication Foundation (WCF) 服务参考时分配给字段的 .NET Framework 数据类型。EDM 类型指 Atom 格式化报告中返回的 ADO.NET 实体数据模型 (EDM) 类型。
**有关 [In/Out] 指示符的信息,请参阅"输入参数和报告输出列" 部分。
备注
报告中的每个条目都包括元数据的多个字段。有关详细信息,请参阅 Office 365 报告 Web 服务返回的常见元数据。
Date 字段指示邮件由 Office 365 系统处理的时间,并按那些服务器所在的时区报告时间。
ODATA $orderby 选项在此报告中无法使用。
使用 StartDate 和 EndDate
StartDate 和 EndDate 字段不在报告结果中提供有用的信息,且在报告输出中始终设置为 0001-01-01T00:00:00Z。它们旨在便于限制报告时间段,且提供比"每日"报告更为精确的精度。
这在每小时记录一次基于电子邮件的拒绝服务攻击等情况下尤其有用。使用这些字段时,必须在 $filter 选项中包含两者。它们都被视为可选,但如果您提供一个,则需要提供另一个。如果查询中没有提供 StartDate/EndDate 对,则默认报告时间段是过去两周。本主题下文的"示例"部分显示如何使用 StartDate 和 EndDate 字段。
类别和 Cn 字段定义
一般命名的 C1 至 C20 字段的定义根据为 Category 指定的值而变化。若要指定一个类别,请在 $filter 选项中添加一个匹配表达式,如以下示例中所示。
$filter=Category eq 'TopMailRecipient'
下面列出了适用于 Category 字段的值,以及返回的信息类型。
InboundDLPHits 返回一个已排序列表,关于入站邮件报告期间触发指示的数据丢失防护 (DLP) 策略操作的次数。
InboundDLPPolicyRuleHits 返回一个已排序列表,关于入站邮件报告期间触发指示的 DLP 策略规则操作的次数。
InboundTransportRuleHits 返回一个已排序列表,关于入站邮件报告期间触发指示的传输规则操作的次数。
OutboundDLPHits 返回一个已排序列表,关于出站邮件报告期间触发指示的数据泄漏保护 (DLP) 策略操作的次数。
OutboundDLPPolicyRuleHits 返回一个已排序列表,关于出站邮件报告期间触发指示的 DLP 策略规则操作的次数。
OutboundTransportRuleHits 返回一个已排序列表,关于出站邮件报告期间触发指示的传输规则操作的次数。
TopMailSender 返回一个已排序列表,关于报告期间发送电子邮件最多的用户。
TopMailRecipient 返回一个已排序列表,关于报告期间接收电子邮件最多的用户。
TopMalware 返回一个已排序列表,关于报告期间检测到的恶意软件。
TopMalwareRecipient 返回一个已排序列表,关于报告期间接收包含恶意软件的邮件最多的用户。
TopSpamRecipient 返回一个已排序列表,关于报告期间接收包含垃圾内容的邮件最多的用户。
下表列出了"类别"值和 Cn 字段的结果定义。表中仅列出了包含信息的列。在报告中没有数据的列的值为 null。列中返回的很多值也显示在 MailFilterList 报告返回的列表中。如果您使用 $filter 表达式来匹配特定 DLP 策略、DLP 规则或传输规则,请使用 MailFilterList 报告中返回的值以确保准确匹配。
字段 C4-C20 目前未使用,保留以供将来扩展。
类别 |
填充的列 |
示例 |
---|---|---|
InboundDLPHits |
C1:[string] 数据丢失防护 (DLP) 规则名称。 |
<d:C1>PII Detection</d:C1> |
InboundDLPPolicyRuleHits |
C1:[string] DLP 策略名称。 |
<d:C1>PII Detection</d:C1> |
InboundTransportRuleHits |
C1:[string] 传输规则名称。 |
<d:C1>PII Detection</d:C1> |
OutboundDLPHits |
C1:[string] DLP 规则名称。 |
<d:C1>PII Detection</d:C1> |
OutboundDLPPolicyRuleHits |
C1:[string] DLP 策略名称。 |
<d:C1>PII Detection</d:C1> |
OutboundTransportRuleHits |
C1:[string] 传输规则。 |
<d:C1>PII Detection</d:C1> |
TopMailSender |
C1:[string] 报告期间发送电子邮件最多的用户的 SMTP 电子邮件地址。 |
<d:C1>userone@example.onmicrosoft.com</C1> |
TopMailRecipient |
C1:[string] 报告期间接收电子邮件最多的用户的 SMTP 电子邮件地址。 |
<d:C1>usertwo@example.onmicrosoft.com</C1> |
TopMalware |
C1:[string] 报告期间最常收到的恶意软件名称。 |
<d:C1>dos/eicar_test_file</d:C1> |
TopMalwareRecipient |
C1:[string] 报告期间收到包含恶意软件的邮件最多的用户的 SMTP 电子邮件地址。 |
<d:C1>usertwo@example.onmicrosoft.com</C1> |
TopSpamRecipient |
C1:[string] 报告期间收到包含垃圾内容的邮件最多的用户的 SMTP 电子邮件地址。 |
<d:C1>usertwo@example.onmicrosoft.com</C1> |
示例
以下示例请求 2012 年最后三个月的前两名电子邮件收件人。为清楚起见,请求和响应中添加了换行符。
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficSummary?
$select=C1,C2,C3&
$filter=Category%20eq%20'TopMailRecipient'%20and%20
StartDate%20eq%20datetime'2012-10-01T00:00:00Z'%20and%20
EndDate%20eq%20datetime'2013-12-31T23:59:59Z'&
$top=2&
$format=Atom
<?xml version="1.0" encoding="utf-8"?>
<feed xml:base="https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/"
xmlns="http://www.w3.org/2005/Atom"
xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices"
xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
<id>https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficSummary</id>
<title type="text">MailTrafficSummary</title>
<updated>2013-02-09T20:06:36Z</updated>
<link rel="self" title="MailTrafficSummary" href="MailTrafficSummary" />
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficSummary(0)</id>
<category term="TenantReporting.MailTrafficSummaryReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailTrafficSummaryReport" href="MailTrafficSummary(0)" />
<title />
<updated>2013-02-09T20:06:36Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:C1>userone@example.onmicrosoft.com</d:C1>
<d:C2>3185</d:C2>
<d:C3 m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficSummary(0)</id>
<category term="TenantReporting.MailTrafficSummaryReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailTrafficSummaryReport" href="MailTrafficSummary(0)" />
<title />
<updated>2013-02-09T20:06:36Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:C1>usertwo@example.onmicrosoft.com</d:C1>
<d:C2>352</d:C2>
<d:C3 m:null="true" />
</m:properties>
</content>
</entry>
</feed>
下面以 JSON 格式显示相同的结果。
{
"d":
[
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficSummary(0)",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficSummary(0)",
"type":"TenantReporting.MailTrafficSummaryReport"
},
"C1":"userone@example.onmicrosoft.com",
"C2":"3185",
"C3":null
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficSummary(0)",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficSummary(0)",
"type":"TenantReporting.MailTrafficSummaryReport"
},
"C1":"usetwo@example.onmicrosoft.com",
"C2":"352",
"C3":null
}
]
}
输入参数和报告输出列
字段表格中的 [In/Out] 指示符具有以下含义:
字段表中标记为 [In] 的字段主要在 $filter=、$orderby= 和其他限制报告应返回哪些条目的查询选项中使用。字段表中标记为 [In] 的字段可包含在 $select= 选项中,它们将在报告条目中出现,但不包含有用数据。
字段表中标记为 [In/Out] 的字段可在列选择 ($select=) 和条目限制($filter= 和 $orderby=)选项中使用。当您在 $select= 选项中包含这些字段之一时,它们将在报告条目中出现,且将在提供时包含有用数据。
兼容性
MailTrafficSummary 报告在 Office 365 服务版本 2013-V1 中引入。有关版本控制的详细信息,请参阅 Office 365 报告 Web 服务中的版本控制。
相应的 Windows PowerShell cmdlet
MailTrafficTop 报告将返回与 Get-MailTrafficSummaryReport Windows PowerShell cmdlet 相同的信息。
权限
您用于访问报告的帐户必须拥有该 Office 365 组织的管理权限。如果此帐户可以在 Office 365 控制面板中查看此报告,则此帐户具有从 REST Web 服务检索数据的权限。此报告要求为用户分配收件人(仅查看)角色。在默认的 Office 365 权限结构中,具有下列管理员权限的用户可以访问此报告:帐务管理员 、全局管理员、密码管理员、服务管理员和用户管理管理员。有关详细信息,请参阅MailboxUsage 报告。
数据粒度、持久性和可用性
此报告提供的信息存储每个事件的确切日期和时间。您可以通过在 $filter 选项中包含 StartDate 和 EndDate 字段来使用任何可行的时间段和持续时间。时间按服务器扫描电子邮件的时区报告。
此报告的信息适用于 14 天的时间段,或者直到取消订阅为止。
事件可能被推迟达 24 小时,然后才能显示在报告中。