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

2025-06-10

在 Microsoft Store Analytics API 中使用此方法，以获取 JSON 格式的应用的特定错误的详细数据。此方法只能检索过去 30 天内发生的错误的详细信息。合作伙伴中心桌面应用的健康报告中也有详细的错误数据可用。

在使用此方法之前，必须先使用获取错误报告数据方法检索要获取其详细信息的错误 ID。

先决条件

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

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

请求

请求语法

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

请求标头

标题	类型	DESCRIPTION
授权	字符串	必填。 Azure AD 访问令牌，形式为Bearer<token>。

请求参数

参数	类型	DESCRIPTION	必选
应用ID	字符串	要为其检索错误详细信息的桌面应用程序的产品 ID。若要获取桌面应用程序的产品 ID，请在合作伙伴中心（如运行状况报告）中打开桌面应用程序的任何分析报告，并从 URL 检索产品 ID。	是的
故障哈希码	字符串	你想要获取详细信息的错误的唯一 ID。若要获取你感兴趣的错误的此值，请使用获取错误报告数据方法，并在该方法的响应正文中使用 failureHash 值。	是的
开始日期	日期	可检索详细错误数据的日期范围中的开始日期。默认值为当前日期之前的 30 天。注意：此方法只能检索过去 30 天内发生的错误的详细信息。	否
结束日期	日期	要检索的详细错误数据的日期范围中的结束日期。默认值为当前日期。	否
顶部	整数 (int)	请求中要返回的数据行数。如果未指定，则最大值和默认值为 10000。如果查询中有更多行，响应正文将包含下一个链接，可用于请求下一页的数据。	否
跳过	整数 (int)	查询中要跳过的行数。使用此参数可分页浏览大型数据集。例如，top=10 和 skip=0 检索前 10 行的数据，top=10 和 skip=10 检索接下来的 10 行数据，依此等。	否
过滤器	字符串	一个或多个用于筛选响应中行的语句。每个语句都包含响应正文中的字段名称和值，这些字段名称与 eq 或 ne 运算符相关联，语句可以使用和、或进行组合。字符串值必须用筛选器参数中的单引号括起来。可以从响应正文中指定以下字段：市场日期 cabIdHash cabExpirationTime 设备类型设备型号操作系统版本 osRelease 应用程序版本 osBuild 文件名	否
排序	字符串	对结果数据值进行排序的语句。语法为 orderby=field [order]，field [order]，...。字段参数可以是以下字符串之一：市场日期 cabIdHash cabExpirationTime 设备类型设备型号操作系统版本 osRelease 应用程序版本 osBuild 文件名顺序参数是可选的，可以是 asc 或 desc 来指定每个字段的升序或降序。默认值为 asc。下面是一个 orderby 字符串的示例：orderby=date,market	否

请求示例

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails?applicationId=10238467886765136388&failureHash=00001111-aaaa-2222-bbbb-3333cccc4444&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=00001111-aaaa-2222-bbbb-3333cccc4444&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>

响应

响应体

价值	类型	DESCRIPTION
价值	数组	包含详细错误数据的对象的数组。有关每个对象中的数据的详细信息，请参阅下面的错误详细信息值部分。
@nextLink	字符串	如果有其他数据页，此字符串包含可用于请求下一页数据的 URI。例如，如果请求的顶部参数设置为 10，但查询的错误行数超过 10 行，则返回此值。
总计数	整数	查询的数据结果中的行总数。

错误的详细信息值

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

价值	类型	DESCRIPTION
应用ID	字符串	用于您检索错误详细信息的桌面应用程序的产品 ID。
故障哈希码	字符串	错误唯一标识符。
故障名称	字符串	失败的名称由四个部分组成：一个或多个问题类、异常/bug 检查代码、发生故障的图像的名称以及关联的函数名称。
日期	字符串	错误数据日期范围的起始日期。如果请求指定了某一天，此值就是该日期。如果请求指定了一周、月或其他日期范围，则此值是该日期范围内的第一个日期。
出租车ID哈希 (cabIdHash)	字符串	与此错误关联的 CAB 文件的唯一 ID 哈希。
缓存过期时间	字符串	CAB 文件过期且无法再下载的日期和时间（采用 ISO 8601 格式）。
市场	字符串	设备市场的 ISO 3166 国家/地区代码。
osBuild	字符串	发生错误的 OS 的内部版本号。
应用程序版本	字符串	发生错误的应用程序可执行文件的版本。
设备型号	字符串	一个字符串，指定发生错误时应用正在运行的设备型号。
osVersion	字符串	以下字符串之一，指定安装了桌面应用程序的 OS 版本： Windows 7 Windows 8.1 Windows 10 Windows 11 Windows Server 2016 Windows Server 1709 未知
osRelease	字符串	以下字符串之一，用于指定发生错误的 OS 版本或预发布环（作为 OS 版本中的子组）。适用于 Windows 11：版本 2110 对于 Windows 10：版本 1507 版本 1511 版本 1607 版本 1703 版本 1709 版本 1803 发布预览内部人士快速版内部消息缓慢对于 Windows Server 1709： RTM 对于 Windows Server 2016：版本 1607 对于 Windows 8.1：更新 1 对于 Windows 7：服务包 1 如果操作系统版本或飞行环未知，此字段的值为未知。
设备类型	字符串	以下字符串之一，指示发生错误的设备的类型：个人电脑服务器未知
cabDownloadable	布尔型	指示 CAB 文件是否可供此用户下载。
文件名	字符串	您用于获取错误详细信息的桌面应用程序可执行文件的名称。

响应示例

以下示例演示此请求的示例 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
}

通过