Получите сведения об ошибке в настольном приложении

Используйте этот метод в API аналитики Microsoft Store, чтобы получить подробные данные для конкретной ошибки приложения в формате JSON. Этот метод может получить сведения только об ошибках, произошедших за последние 30 дней. Подробные данные об ошибках также доступны в отчете о работоспособности для настольных приложений в Центре партнеров.

Прежде чем использовать этот метод, необходимо сначала использовать метод получения данных отчетности об ошибках для получения идентификатора ошибки, для которой требуется получить подробные сведения.

Предпосылки

Чтобы использовать этот метод, сначала необходимо выполнить следующие действия:

  • Если это еще не сделано, выполните все предварительные требования для API аналитики Microsoft Store.
  • Получите маркер доступа Azure AD для использования в заголовке запроса для этого метода. После получения маркера доступа у вас есть 60 минут, чтобы использовать его до истечения срока действия. После истечения срока действия токена можно получить новый токен.
  • Получите идентификатор ошибки, для которой требуется получить подробные сведения. Чтобы получить этот идентификатор, используйте метод получения данных отчетов об ошибках и используйте значение failureHash в тексте ответа этого метода.

Просьба

Синтаксис запроса

Метод Запрос URI
ПОЛУЧАЙ https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails

Заголовок запроса

Заголовок Тип Описание
Авторизация струна Обязательное. Токен доступа Azure AD в формате Bearer<token>.

Параметры запроса

Параметр Тип Описание Обязательно
applicationId струна Идентификатор продукта настольного приложения, для которого требуется получить сведения об ошибке. Чтобы получить идентификатор продукта классического приложения, откройте любой отчет аналитики для классического приложения в Центре партнеров (например, отчет о работоспособности) и получите идентификатор продукта из URL-адреса. Да
хеш-сбоя струна Уникальный идентификатор ошибки, для которой требуется получить подробные сведения. Чтобы получить это значение для интересующей вас ошибки, используйте метод получения данных отчетов об ошибках и используйте значение failureHash в тексте ответа этого метода. Да
Дата начала дата Дата начала в диапазоне дат получения подробных данных об ошибках. Значение по умолчанию — 30 дней до текущей даты.

Примечание. Этот метод может получить сведения только об ошибках, возникших за последние 30 дней.
нет
Дата окончания дата Дата окончания в диапазоне дат для получения подробных данных об ошибках. Значение по умолчанию — текущая дата. нет
Верх инт Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию, если не указано значение 10000. Если в запросе есть больше строк, текст ответа содержит следующую ссылку, которую можно использовать для запроса следующей страницы данных. нет
пропустить инт Количество строк, пропускаемых в запросе. Используйте этот параметр для навигации по большим наборам данных. Например, top=10 и skip=0 извлекает первые 10 строк данных, top=10 и skip=10 извлекает следующие 10 строк данных и т. д. нет
фильтр струна Одна или несколько инструкций, которые фильтруют строки в ответе. Каждое выражение содержит имя поля из текста ответа и значение, связанное с операторами eq или ne, и выражения могут быть объединены с помощью и или или. Строковые значения должны быть окружены одними кавычками в параметре фильтра . В тексте ответа можно указать следующие поля:

  • рынок
  • дата
  • cabIdHash
  • время истечения кабины
  • тип устройства
  • модель устройства
  • версия ОС
  • osRelease
  • applicationVersion
  • osBuild
  • имя файла
нет
сортировать по струна Инструкция, которая упорядочивает значения результирующих данных. Синтаксис — orderby=field [order], field [order],.... Параметр field может быть одной из следующих строк:
  • рынок
  • дата
  • cabIdHash
  • время истечения кабины
  • тип устройства
  • модель устройства
  • версия ОС
  • osRelease
  • applicationVersion
  • osBuild
  • имя файла

Параметр order является необязательным и может принимать значения asc или desc, чтобы указать порядок по возрастанию или по убыванию для каждого поля. Значение по умолчанию — asc.

Ниже приведен пример строки orderby: orderby=date,market

нет

Пример запроса

В следующих примерах показано несколько запросов на получение подробных данных об ошибках. Замените значение applicationId идентификатором продукта для настольного приложения.

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>

Ответ

Основная часть ответа

Ценность Тип Описание
Ценность массив Массив объектов, содержащих подробные данные об ошибках. Дополнительные сведения о данных в каждом объекте см. в разделе ниже «Подробные значения ошибок».
@nextLink струна Если есть дополнительные страницы данных, эта строка содержит универсальный код ресурса (URI), который можно использовать для запроса следующей страницы данных. Например, это значение возвращается, если верхний параметр запроса имеет значение 10, но для запроса имеется более 10 строк ошибок.
Общее количество целое число Общее количество строк в результатах данных для запроса.

Значения подробностей об ошибках

Элементы в массиве значений содержат следующие значения.

Ценность Тип Описание
applicationId струна Идентификатор продукта настольного приложения, для которого вы получили сведения об ошибке.
хеш-сбоя струна Уникальный идентификатор ошибки.
название ошибки струна Имя сбоя, состоящее из четырех частей: один или несколько классов проблем, код проверки исключений и ошибок, имя изображения, в котором произошел сбой, и связанное имя функции.
дата струна Первая дата в диапазоне дат для данных об ошибках. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат.
cabIdHash струна Уникальный хэш идентификатора CAB-файла, связанного с этой ошибкой.
время истечения действия cab струна Дата и время, когда срок действия CAB-файла истечёт, и его больше невозможно будет загрузить, в формате ISO 8601.
рынок струна Код страны рынка девайсов по стандарту ISO 3166.
osBuild струна Номер сборки ОС, в которой произошла ошибка.
версия приложения струна Версия исполняемого файла приложения, в которой произошла ошибка.
модель устройства струна Строка, указывающая модель устройства, на котором выполнялось приложение при возникновении ошибки.
Версия ОС струна Одна из следующих строк, указывающая версию ОС, на которой установлено настольное приложение:

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Неизвестный
osRelease струна Одна из следующих строк, указывающая релиз или кольцо тестирования (как подпопуляция в пределах версии ОС), в котором произошла ошибка.

Для Windows 11 : версия 2110

Для Windows 10:

  • Версия 1507
  • Версия 1511
  • Версия 1607
  • Версия 1703
  • Версия 1709
  • Версия 1803
  • Предварительная версия выпуска
  • Программа Insider Fast
  • Медленный режим инсайдера

Для Windows Server 1709:

  • РТМ

Для Windows Server 2016:

  • Версия 1607

Для Windows 8.1:

  • Обновление 1

Для Windows 7:

  • Пакет обновления 1

Если выпуск ОС или флайтинговое кольцо неизвестны, это поле имеет значение Unknown.

тип устройства струна Одна из следующих строк, указывающих тип устройства, на котором произошла ошибка:

  • ПК
  • Сервер
  • Неизвестный
cabЗагружаемый Булев Указывает, можно ли скачать 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
}