Получение сведений об ошибке в классическом приложении
Используйте этот метод в API аналитики Microsoft Store, чтобы получить подробные данные для конкретной ошибки приложения в формате JSON. Этот метод может получить сведения только об ошибках, произошедших за последние 30 дней. Подробные данные об ошибках также доступны в отчете о работоспособности классических приложений в Центре партнеров.
Прежде чем использовать этот метод, необходимо сначала использовать метод получения данных отчетов об ошибках для получения идентификатора ошибки, для которой требуется получить подробные сведения.
Необходимые компоненты
Чтобы использовать этот метод, сначала необходимо выполнить следующие действия:
- Если это еще не сделано, выполните все предварительные требования для API аналитики Microsoft Store.
- Получите маркер доступа Azure AD для использования в заголовке запроса для этого метода. После получения маркера доступа у вас будет 60 минут, чтобы использовать его до истечения срока действия. После истечения срока действия маркера можно получить новый.
- Получите идентификатор ошибки, для которой требуется получить подробные сведения. Чтобы получить этот идентификатор, используйте метод получения данных отчетов об ошибках и используйте значение failureHash в тексте ответа этого метода.
Запросить
Синтаксис запроса
Способ | URI запроса |
---|---|
GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failuredetails |
Заголовок запроса
Верхний колонтитул | Тип | Описание |
---|---|---|
Авторизация | строка | Обязательный. Маркер доступа Azure AD в маркере> носителя<формы. |
Параметры запроса
Параметр | Тип | Описание | Обязательное поле |
---|---|---|---|
applicationId | строка | Идентификатор продукта классического приложения, для которого требуется получить сведения об ошибке. Чтобы получить идентификатор продукта классического приложения, откройте любой отчет аналитики для классического приложения в Центре партнеров (например , отчет о работоспособности) и получите идентификатор продукта из URL-адреса. | Да |
failureHash | строка | Уникальный идентификатор ошибки, для которой требуется получить подробные сведения. Чтобы получить это значение для интересующей вас ошибки, используйте метод получения данных отчетов об ошибках и используйте значение failureHash в тексте ответа этого метода. | Да |
startDate | Дата | Дата начала в диапазоне дат получения подробных данных об ошибках. Значение по умолчанию — 30 дней до текущей даты.Примечание. Этот метод может получить сведения только об ошибках, возникших за последние 30 дней. | No |
endDate | Дата | Дата окончания в диапазоне дат для получения подробных данных об ошибках. Значение по умолчанию — текущая дата. | No |
популярное | INT | Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию, если не указано значение 10000. Если в запросе есть больше строк, текст ответа содержит следующую ссылку, которую можно использовать для запроса следующей страницы данных. | No |
skip | INT | Количество строк, пропускаемых в запросе. Используйте этот параметр для страницы с помощью больших наборов данных. Например, top=10 и skip=0 извлекает первые 10 строк данных, top=10 и skip=10 извлекает следующие 10 строк данных и т. д. | No |
Фильтр | строка | Одна или несколько инструкций, которые фильтруют строки в ответе. Каждая инструкция содержит имя поля из текста ответа и значения, связанного с операторами eq или ne, и операторы могут быть объединены с помощью или или. Строковые значения должны быть окружены одними кавычками в параметре фильтра . В тексте ответа можно указать следующие поля:
|
No |
orderby | строка | Инструкция, которая упорядочивает значения результирующих данных. Синтаксис — orderby=field [order], field [order],.... Параметр поля может быть одной из следующих строк:
Параметр order является необязательным и может быть asc или desc , чтобы указать возрастание или убывание для каждого поля. Значение по умолчанию — asc. Ниже приведен пример строки заказа : orderby=date,market |
No |
Пример запроса
В следующих примерах показано несколько запросов на получение подробных данных об ошибках. Замените значение 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>
Response
Текст ответа
Значение | Тип | Описание |
---|---|---|
Значение | array | Массив объектов, содержащих подробные данные об ошибках. Дополнительные сведения о данных в каждом объекте см . в разделе сведений об ошибках ниже. |
@nextLink | строка | Если есть дополнительные страницы данных, эта строка содержит универсальный код ресурса (URI), который можно использовать для запроса следующей страницы данных. Например, это значение возвращается, если верхний параметр запроса имеет значение 10, но для запроса имеется более 10 строк ошибок. |
TotalCount | integer | Общее количество строк в результатах данных для запроса. |
Значения сведений об ошибках
Элементы в массиве значений содержат следующие значения.
Значение | Тип | Описание |
---|---|---|
applicationId | строка | Идентификатор продукта классического приложения, для которого вы получили сведения об ошибке. |
failureHash | строка | Уникальный идентификатор ошибки. |
failureName | строка | Имя сбоя, состоящее из четырех частей: один или несколько классов проблем, код проверки исключений и ошибок, имя изображения, в котором произошел сбой, и связанное имя функции. |
Дата | строка | Первая дата в диапазоне дат для данных об ошибках. Если запрос указал один день, это значение равно дате. Если запрос указал неделю, месяц или другой диапазон дат, это значение является первой датой в этом диапазоне дат. |
cabIdHash | строка | Уникальный хэш идентификатора CAB-файла, связанного с этой ошибкой. |
cabExpirationTime | строка | Дата и время истечения срока действия CAB-файла и его невозможно загрузить в формате ISO 8601. |
на рынок | строка | Код страны ISO 3166 рынка устройств. |
osBuild | строка | Номер сборки ОС, в которой произошла ошибка. |
applicationVersion | строка | Версия исполняемого файла приложения, в которой произошла ошибка. |
deviceModel | строка | Строка, указывающая модель устройства, на котором выполнялось приложение при возникновении ошибки. |
osVersion | строка | Одна из следующих строк, указывающая версию ОС, в которой установлено классическое приложение:
|
osRelease | строка | Одна из следующих строк, указывающая выпуск ОПЕРАЦИОННОй системы или кольцо переключения (как подпопление в версии ОС), в котором произошла ошибка. Для Windows 11: версия 2110 Для Windows 10:
Для Windows Server 1709:
Для Windows Server 2016
Для Windows 8.1:
Для Windows 7:
Если выпуск ОС или кольцо полетов неизвестно, это поле имеет значение Unknown. |
deviceType | строка | Одна из следующих строк, указывающих тип устройства, на котором произошла ошибка:
|
cabDownloadable | Логический | Указывает, можно ли скачать CAB-файл для этого пользователя. |
fileName | строка | Имя исполняемого файла для классического приложения, для которого вы получили сведения об ошибке. |
Пример ответа
В следующем примере показан пример текста ответа 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
}