获取桌面应用程序中的错误的详细信息

  • 项目

使用 Microsoft Store 分析 API 中的此方法，可以 JSON 格式获取应用的特定错误的详细数据。 此方法仅可以检索过去 30 天内发生的错误的详细信息。 还可以在合作伙伴中心的桌面应用程序运行状况报告中获取详细错误数据。

可以使用此方法之前，必须首先使用获取错误报告数据方法来检索希望获取详细信息的错误的 ID。

必备条件

若要使用此方法，首先需要执行以下操作：

  • 完成 Microsoft Store 分析 API 的所有先决条件（如果尚未这样做）。
  • 获取 Azure AD 访问令牌，以供在此方法的请求标头中使用。 获取访问令牌后，在它到期前，你有 60 分钟的使用时间。 该令牌到期后，可以获取新的令牌。
  • 获取希望获取详细信息的错误的 ID。 若要获取此 ID，请使用获取错误报告数据方法，并使用该方法的响应正文中的 failureHash 值。

请求

请求语法

方法 请求 URI
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails

请求头

标头 类型 说明
授权 字符串 必需。 Azure AD 访问令牌的格式为 Bearertoken<>。

请求参数

参数 类型 说明 必需
applicationId 字符串 要为其检索错误详细信息的桌面应用程序的产品 ID。 若要获取桌面应用程序的产品 ID，请在合作伙伴中心打开桌面应用程序的分析报告（如运行状况报告）并从 URL 检索产品 ID。 是
failureHash 字符串 你希望获取详细信息的错误的唯一 ID。 若要获取感兴趣的错误的此值，请使用获取错误报告数据方法，并使用该方法的响应正文中的 failureHash 值。 是
startDate 日期 要检索的详细错误数据日期范围中的开始日期。 默认值为当前日期之前 30 天。

注意：此方法仅可以检索过去 30 天内发生的错误的详细信息。		 否
endDate 日期 要检索的详细错误数据日期范围中的结束日期。 默认值为当前日期。 否
top int 要在请求中返回的数据行数。 如果未指定，最大值和默认值为 10000。 当查询中存在多行数据时，响应正文中包含的下一个链接可用于请求下一页数据。 否
skip int 要在查询中跳过的行数。 使用此参数可以浏览较大的数据集。 例如，top=10 和 skip=0，将检索前 10 行数据；top=10 和 skip=10，将检索之后的 10 行数据，依此类推。 否
filter string 在响应中筛选行的一条或多条语句。 每条语句包含的响应正文中的字段名称和值使用 eq 或 ne 运算符进行关联，并且语句可以使用 and 或 or 进行组合。 filter 参数中的字符串值必须使用单引号引起来。 可以指定响应正文中的以下字段：

  • market
  • date
  • cabIdHash
  • cabExpirationTime
  • deviceType
  • deviceModel
  • osVersion
  • osRelease
  • applicationVersion
  • osBuild
  • fileName
 否
orderby string 对结果数据值进行排序的语句。 语法为 orderby=field [order],field [order],...，其中 field 参数可以是以下字符串之一：
  • market
  • date
  • cabIdHash
  • cabExpirationTime
  • deviceType
  • deviceModel
  • osVersion
  • osRelease
  • applicationVersion
  • osBuild
  • fileName

order 参数是可选的，可以是 asc 或 desc，用于指定每个字段的升序或降序排列。 默认值为 asc。

下面是一个 orderby 字符串的示例：orderby=date,market

 否

请求示例

以下示例演示用于获取详细错误数据的多个请求。 将 applicationId 值替换为桌面应用程序的产品 ID。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails?applicationId=10238467886765136388&failureHash=012e33e3-dbc9-b12f-c124-9d9810f05d8b&startDate=2016-11-05&endDate=2016-11-06&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails?applicationId=10238467886765136388&failureHash=012e33e3-dbc9-b12f-c124-9d9810f05d8b&startDate=2016-11-05&endDate=2016-11-06&top=10&skip=0&filter=market eq 'US' and deviceType eq 'PC' HTTP/1.1
Authorization: Bearer <your access token>

响应

响应正文

值 类型 说明
Value array 包含详细错误数据的对象数组。 有关每个对象中的数据的详细信息，请参阅以下错误详细信息值部分。
@nextLink string 如果存在其他数据页，则此字符串包含一个你可用来请求下一页数据的 URI。 例如，当请求的 top 参数设置为 10，但查询的错误超过 10 行时，就会返回此值。
TotalCount integer 查询的数据结果中的行总数。

错误详细信息值

Value 数组中的元素包含以下值。

Value 类型 说明
applicationId 字符串 要为其检索错误详细信息的桌面应用程序的产品 ID。
failureHash 字符串 错误的唯一标识符。
failureName string 故障的名称，它由四个部分组成：一个或多个问题类、异常/错误检查代码、发生故障的映像的名称和相关的函数名称。
date string 错误数据的日期范围内的第一个日期。 如果请求指定了某一天，此值就是该日期。 如果请求指定了一周、月或其他日期范围，此值是该日期范围内的第一个日期。
cabIdHash string 与此错误相关联的 CAB 文件的唯一 ID 哈希。
cabExpirationTime string CAB 文件已过期且不能再下载时的日期和时间，以 ISO 8601 格式表示。
market string 设备市场的 ISO 3166 国家/地区代码。
osBuild string 发生错误的操作系统的版本号。
applicationVersion string 发生错误的应用程序可执行文件的版本。
deviceModel string 指定发生错误时，运行应用的设备型号的字符串。
osVersion string 用于指定在其上安装桌面应用程序的操作系统版本的以下字符串之一：

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Unknown
osRelease string 用于指定发生了错误的操作系统版本或外部测试 Ring（作为操作系统版本内的亚组）的以下字符串之一。

对于Windows 11：版本 2110

对于 Windows 10：

  • 版本 1507
  • 版本 1511
  • 版本 1607
  • 版本 1703
  • 版本 1709
  • 版本 1803
  • Release Preview
  • 预览体验成员 - 快
  • 预览体验成员 - 慢

对于 Windows Server 1709：

  • RTM

对于 Windows Server 2016：

  • 版本 1607

对于 Windows 8.1：

  • 更新 1

对于 Windows 7：

  • Service Pack 1

如果操作系统版本或外部测试 Ring 未知，则此字段的值为 Unknown。
deviceType string 用于指示发生了错误的设备类型的以下字符串之一：

  • PC
  • Server
  • Unknown
cabDownloadable 布尔 指示是否可为此用户下载 CAB 文件。
fileName string 为其检索错误详细信息的桌面应用程序的可执行文件名称。

响应示例

以下示例举例说明此请求的 JSON 响应正文。

{
  "Value": [
    {
      "applicationId": "10238467886765136388",
      "failureHash": "012345-5dbc9-b12f-c124-9d9810f05d8b",
      "failureName": "NULL_CLASS_PTR_WRITE_c0000005_contoso.exe!unknown_error_in_process",
      "date": "2018-01-28 23:55:29",
      "cabIdHash": "54ffb83a-e159-41d2-8158-f36f306cc01e",
      "cabExpirationTime": "2018-02-27 23:55:29",
      "market": "US",
      "osBuild": "10.0.10240",
      "applicationVersion": "2.2.2.0",
      "deviceModel": "Contoso All-in-one",
      "osVersion": "Windows 10",
      "osRelease": "Version 1703",
      "deviceType": "PC",
      "cabDownloadable": false,
      "fileName": "contosodemo.exe"
    }
  ],
  "@nextLink": null,
  "TotalCount": 1
}