MessageTrace 报告
MessageTrace REST URI 提供了有关针对在过去 30 天内通过组织的 Office 365 系统传递的电子邮件的处理的摘要信息。此报告通常与 MessageTraceDetail 报告 一同使用,以确定邮件为何未按照预期从用户处传递。
上次修改时间: 2015年9月17日
适用范围: Office 365
REST URI
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MessageTrace[?ODATA options]
字段
下列字段可在 $select、$filter 和 $orderby ODATA2 查询选项中指定。如果没有提供 $select 选项,将返回所有字段。
名称 |
WCF 类型* |
EDM 类型* |
[In/Out]** 说明 |
示例值 |
在其中添加的服务版本 |
---|---|---|---|---|---|
EndDate |
System.DateTime |
Edm.DateTime |
[In] 此字段用于限制报告期间。在 $filter 查询选项中使用此字段设置报告期间的结束日期和时间。如果在 $filter 选项中提供 EndDate,则必须还提供 StartDate。此报告中,此字段对应记录的邮件最后处理步骤的日期和时间。 |
简写日期(例如,03/10/2013)或带引号的日期时间(例如,"03/10/2013 4:55 PM") |
2013-V1 |
FromIP |
string |
未指定 |
[In/Out] 将邮件传输到 Office 365 电子邮件系统的 IPv4 或 IPv6 地址。 |
192.168.0.205 |
2013-V1 |
MessageId |
string |
未指定 |
[In/Out] 邮件的 Internet MessageID 邮件头(如果有提供)。此值还可明确为 null。 |
如果没有为邮件提供 ID,则对于 Atom,报告数据将显示 <d:MessageId m:null="true" />,而对于 JSON,报告数据将显示 "MessageId":null |
2013-V1 |
MessageTraceId |
System.Guid |
Edm.Guid |
[In/Out] 用于获取邮件传输跟踪详细信息的标识符。 |
ae4ad8f6-7613-411c-e67e-08cfc740629 |
2013-V1 |
Organization |
string |
未指定 |
[In/Out] 处理电子邮件的完全限定的域名。 |
example.onmicrosoft.com |
2013-V1 |
Received |
System.DateTime |
Edm.DateTime |
[In/Out] Office 365 电子邮件系统收到电子邮件的日期和时间。与第一个邮件跟踪详细条目的 Date 字段对应。 |
2013-01-09T07:32:54Z |
2013-V1 |
RecipientAddress |
string |
未指定 |
[In/Out] 邮件发送到的用户的 SMTP 电子邮件地址。 |
userone@example.onmicrosoft.com |
2013-V1 |
SenderAddress |
string |
未指定 |
[In/Out] 声称邮件来自其中的用户 SMTP 电子邮件地址。由于垃圾电子邮件的发件人地址通常仿冒,因此不视为完全可靠。 |
usertwo@example.onmicrosoft.com |
2013-V1 |
Size |
int |
Edm.Int64 |
[In/Out] 邮件大小,以字节为单位。 |
39405 |
2013-V1 |
StartDate |
System.DateTime |
Edm.DateTime |
[In] 此字段用于限制报告期间。在 $filter 查询选项中使用此字段设置报告期间的开始日期和时间。如果在 $filter 选项中提供 StartDate,则必须还指定 EndDate。此报告中,此字段对应记录的邮件首次处理步骤的日期和时间。 |
简写日期(例如,03/10/2013)或带引号的日期时间(例如,"03/10/2013 4:55 PM") |
2013-V1 |
Status |
string |
未指定 |
[In/Out] Office 365 电子邮件系统中的邮件状态。与记录的邮件最后处理步骤的 Detail 字段对应。 |
Delivered |
2013-V1 |
Subject |
string |
未指定 |
[In/Out] 邮件的主题行(如果邮件上已存在)。 |
Free M0ney WoN! |
2013-V1 |
ToIP |
string |
未指定 |
[In/Out] Office 365 电子邮件系统发送电子邮件到其中的 IPv4 或 IPv6 地址。 |
192.168.0.215 |
2013-V1 |
*WCF 类型指在 Visual Studio 中创建 Windows Communication Foundation (WCF) 服务参考时分配给字段的 .NET Framework 数据类型。EDM 类型指 Atom 格式化报告中返回的 ADO.NET 实体数据模型 (EDM) 类型。
**有关 [In/Out] 指示符的信息,请参阅"输入参数和报告输出列" 部分。
备注
报告中的每个条目都包括元数据的多个字段。有关详细信息,请参阅 Office 365 报告 Web 服务返回的常见元数据。
Date 字段指示邮件由 Office 365 系统处理的时间,并按那些服务器所在的时区报告时间。
此报告提供通过电子邮件系统传递的邮件的摘要信息,该系统为其提供更为详细的跟踪信息。若要获取该详细跟踪信息,您的应用程序可以使用 MessageTraceDetail 报告。重要的是,您的应用程序应提供所有下列信息,以获取详细的跟踪信息。有关跟踪邮件的详细信息,请参阅如何:在 Office 365 中跟踪电子邮件。
来自 MessageTrace 报告输出的 MessageTraceId GUID。
接收邮件的 RecipientAddress。
发出邮件的 SenderAddress。
标识已处理邮件的时间段的 StartDate 和 EndDate。
使用 StartDate 和 EndDate
StartDate 和 EndDate 字段不在报告结果中提供有用的信息,且在报告输出中始终设置为 0001-01-01T00:00:00Z。它们旨在便于限制报告时间段,且提供比"每日"报告更为精确的精度。
这在每小时记录一次基于电子邮件的拒绝服务攻击等情况下尤其有用。使用这些字段时,必须在 $filter 选项中包含两者。它们都被视为可选,但如果您提供一个,则需要提供另一个。如果查询中没有提供 StartDate/EndDate 对,则默认报告时间段是过去两周。本主题下文的"示例"部分显示如何使用 StartDate 和 EndDate 字段。
在 MessageTrace 报告中,这些字段将返回您在 $filter 选项中传递的次数。Received 字段指示系统收到邮件的时间。对于失败的邮件,可以跨越多天。
示例
下面的示例演示如何请求过去 48 小时(默认时间段)内的邮件跟踪信息。
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MessageTrace?
<?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/MessageTrace</id>
<title type="text">MessageTrace</title>
<updated>2013-02-09T23:10:29Z</updated>
<link rel="self" title="MessageTrace" href="MessageTrace" />
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MessageTrace(0)</id>
<category term="TenantReporting.MessageTrace"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MessageTrace" href="MessageTrace(0)" />
<title />
<updated>2013-02-09T23:10:29Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Organization>example.onmicrosoft.com</d:Organization>
<d:MessageId><8CFD41EEA339B87-1048-248A6@servername.organization.example.com></d:MessageId>
<d:Received m:type="Edm.DateTime">2013-02-08T14:22:55.2046427</d:Received>
<d:SenderAddress>useone@example.com</d:SenderAddress>
<d:RecipientAddress>usertwo@example.onmicrosoft.com</d:RecipientAddress>
<d:Subject>Test Inbound Eicar 20130208 - 922AM</d:Subject>
<d:Status>Failed</d:Status>
<d:ToIP m:null="true" />
<d:FromIP>192.168.0.1</d:FromIP>
<d:Size m:type="Edm.Int32">3584</d:Size>
<d:MessageTraceId m:type="Edm.Guid">4682e74e-a81a-4760-c35b-08cfd41eebc2</d:MessageTraceId>
<d:StartDate m:type="Edm.DateTime">2013-02-07T23:10:28.6473929Z</d:StartDate>
<d:EndDate m:type="Edm.DateTime">2013-02-09T23:10:28.6473929Z</d:EndDate>
<d:Index m:type="Edm.Int32">0</d:Index>
</m:properties>
</content>
</entry>
</feed>
输入参数和报告输出列
字段表格中的 [In/Out] 指示符具有以下含义:
字段表中标记为 [In] 的字段主要在 $filter=、$orderby= 和其他限制报告应返回哪些条目的查询选项中使用。字段表中标记为 [In] 的字段可包含在 $select= 选项中,他们将在报告条目中出现,但不包含有用数据。
字段表中标记为 [In/Out] 的字段可在列选择 ($select=) 和条目限制($filter= 和 $orderby=)选项中使用。当您在 $select= 选项中包含这些字段之一时,它们将在报告条目中出现,且将在提供时包含有用数据。
兼容性
MessageTrace 报告在 Office 365 服务版本 2013-V1 中引入。有关版本控制的详细信息,请参阅 Office 365 报告 Web 服务中的版本控制
相应的 Windows PowerShell cmdlet
MessageTrace 报告将返回与 Get-MessageTrace Windows PowerShell cmdlet 相同的信息。
权限
您用于访问报告的帐户必须拥有该 Office 365 组织的管理权限。如果此帐户可以在 Office 365 控制面板中查看此报告,则此帐户具有从 REST Web 服务检索数据的权限。此报告要求为用户分配收件人(仅查看)角色。在默认的 Office 365 权限结构中,具有下列管理员权限的用户可以访问此报告:帐务管理员 、全局管理员、密码管理员、服务管理员和用户管理管理员。有关详细信息,请参阅MailboxUsage 报告。
数据粒度、 持久性和可用性
此报告提供的信息包含每个事件的确切日期和时间。您可以通过在 $filter 选项中包含 StartDate 和 EndDate 字段来使用任何可行的时间段和持续时间。时间按服务器扫描电子邮件的时区报告。
此报告的信息适用于 30 天的时间段,或者直到取消订阅为止。
事件可能被推迟达 24 小时,然后才能显示在报告中。