Справочные материалы по основным REST API портала устройств Windows
Все функциональные возможности портала устройств Windows (WDP) поддерживают REST API, которые разработчики могут вызывать напрямую для получения доступа к ресурсам и управления устройствами программными средствами.
Развертывание приложения
Установка приложения
Запросить
Приложение можно установить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
POST | /api/app/packagemanager/package |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
package | (обязательно) Имя файла установленного пакета. |
Заголовки запроса
- нет
Текст запроса
- Файл .appx или .appxbundle, а также все зависимости, необходимые приложению.
- Сертификат, используемый для подписи приложения, если устройство является IoT или Windows Desktop. Другие платформы не требуют сертификата.
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | Развертывание запроса, принятого и обрабатываемого |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Примечание.
Windows Mixed Reality работает на обычных ПК, поэтому это тот же портал, что и для ПК.
Установка связанного набора
Запросить
Связанный набор можно установить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
POST | /api/app/packagemanager/package |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
package | (Обязательный.) Имена файлов устанавливаемых пакетов. |
Заголовки запроса
- нет
Текст запроса
- Добавляйте расширение .opt к именам файлов дополнительных пакетов, если они используются в качестве параметра, например: foo.appx.opt или bar.appxbundle.opt.
- Файл .appx или .appxbundle, а также все зависимости, необходимые приложению.
- Сертификат, используемый для подписи приложения, если устройство является IoT или Windows Desktop. Другие платформы не требуют сертификата.
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | Развертывание запроса, принятого и обрабатываемого |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Регистрация приложения в свободной папке
Запросить
Приложение можно зарегистрировать в свободной папке с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
POST | /api/app/packagemanager/networkapp |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
{
"mainpackage" :
{
"networkshare" : "\\some\share\path",
"username" : "optional_username",
"password" : "optional_password"
}
}
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | Развертывание запроса, принятого и обрабатываемого |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- Xbox
- HoloLens
- IoT
Регистрация связанного набора в свободных файловых папках
Запросить
Вы можете зарегистрировать связанный набор в свободных папках с помощью следующего формата запросов.
Способ | URI запроса |
---|---|
POST | /api/app/packagemanager/networkapp |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
{
"mainpackage" :
{
"networkshare" : "\\some\share\path",
"username" : "optional_username",
"password" : "optional_password"
},
"optionalpackages" :
[
{
"networkshare" : "\\some\share\path2",
"username" : "optional_username2",
"password" : "optional_password2"
},
...
]
}
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | Развертывание запроса, принятого и обрабатываемого |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- Xbox
- HoloLens
- IoT
Получение состояния установки приложения
Запросить
Состояние установки приложения, которое в настоящее время выполняется, можно получить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/app/packagemanager/state |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | Результат последнего развертывания |
204 | Установка выполняется |
404 | Действие установки не найдено |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Удаление приложения
Запросить
Приложение можно удалить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
DELETE | /api/app/packagemanager/package |
Параметры универсального кода ресурса
Параметр универсального кода ресурса | Description |
---|---|
package | (обязательно) PackageFullName (из GET/api/app/packagemanager/packages) целевого приложения |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Получение установленных приложений
Запросить
Список приложений, установленных в системе, можно получить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/app/packagemanager/packages |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ содержит список установленных пакетов с соответствующими сведениями. Шаблон для этого ответа выглядит следующим образом.
{"InstalledPackages": [
{
"Name": string,
"PackageFamilyName": string,
"PackageFullName": string,
"PackageOrigin": int, (https://msdn.microsoft.com/library/windows/desktop/dn313167(v=vs.85).aspx)
"PackageRelativeId": string,
"Publisher": string,
"Version": {
"Build": int,
"Major": int,
"Minor": int,
"Revision": int
},
"RegisteredUsers": [
{
"UserDisplayName": string,
"UserSID": string
},...
]
},...
]}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Bluetooth
Получение списка радиомодулей Bluetooth на компьютере
Запросить
Список установленных на компьютере радиомодулей Bluetooth можно получить, используя следующий формат запросов. Его также можно обновить до подключения WebSocket, используя те же данные JSON.
Способ | URI запроса |
---|---|
GET | /api/bt/getradios |
GET/WebSocket | /api/bt/getradios |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ содержит массив подключенных к устройству радиомодулей Bluetooth в формате JSON.
{"BluetoothRadios" : [
{
"BluetoothAddress" : int64,
"DisplayName" : string,
"HasUnknownUsbDevice" : boolean,
"HasProblem" : boolean,
"ID" : string,
"ProblemCode" : int,
"State" : string
},...
]}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- HoloLens
- IoT
Включение и отключение радиомодулей Bluetooth
Запросить
Включает и отключает определенный радиомодуль Bluetooth.
Способ | URI запроса |
---|---|
POST | /api/bt/setradio |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
Идентификатор | (Обязательный.) Идентификатор устройства для радиомодуля Bluetooth иметь кодировку base64. |
Штат | (Обязательный.) Может иметь значение "On" или "Off" . |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- HoloLens
- IoT
Получение списка связанных устройств Bluetooth
Запросить
Вы можете получить список связанных устройств Bluetooth, используя следующий формат запроса. Его можно обновить до подключения WebSocket, используя те же данные JSON. За время существования подключения WebSocket список устройств может измениться. Полный список устройств будет отправляться через подключение WebSocket при каждом обновлении.
Способ | URI запроса |
---|---|
GET | /api/bt/getpaired |
GET/WebSocket | /api/bt/getpaired |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ содержит массив связанных устройств Bluetooth в формате JSON.
{"PairedDevices": [
{
"Name" : string,
"ID" : string,
"AudioConnectionStatus" : string
},...
]}
Если устройство может использоваться для воспроизведения аудио в этой системе, отобразится поле AudioConnectionStatus. (Политики и необязательные компоненты могут повлиять на это.) AudioConnectionStatus будет иметь значение "Подключено" или "Отключено".
Получение списка доступных устройств Bluetooth
Запросить
Вы можете получить список доступных для связывания устройств Bluetooth, используя следующий формат запроса. Его можно обновить до подключения WebSocket, используя те же данные JSON. За время существования подключения WebSocket список устройств может измениться. Полный список устройств будет отправляться через подключение WebSocket при каждом обновлении.
Способ | URI запроса |
---|---|
GET | /api/bt/getavailable |
GET/WebSocket | /api/bt/getavailable |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ содержит массив доступных для связывания устройств Bluetooth в формате JSON.
{"AvailableDevices": [
{
"Name" : string,
"ID" : string
},...
]}
Подключение устройств Bluetooth
Запросить
Выполняет подключение к устройству, если устройство может использоваться для воспроизведения аудио в этой системе. (На это поведение могут влиять политики и необязательные компоненты.)
Способ | URI запроса |
---|---|
POST | /api/bt/connectdevice |
Параметры универсального кода ресурса
Параметр универсального кода ресурса | Description |
---|---|
Идентификатор | (Обязательный.) Идентификатор конечной точки связи для устройства Bluetooth должен иметь кодировку base64. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- HoloLens
- IoT
Отключение устройств Bluetooth
Запросить
Выполняет отключение устройства, если устройство может использоваться для воспроизведения аудио в этой системе. (На это поведение могут влиять политики и необязательные компоненты.)
Способ | URI запроса |
---|---|
POST | /api/bt/disconnectdevice |
Параметры универсального кода ресурса
Параметр универсального кода ресурса | Description |
---|---|
Идентификатор | (Обязательный.) Идентификатор конечной точки связи для устройства Bluetooth должен иметь кодировку base64. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- HoloLens
- IoT
Диспетчер устройств
Получение установленных устройств на компьютере
Запросить
Список устройств, установленных на компьютере, можно получить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/devicemanager/devices |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ включает массив JSON устройств, подключенных к устройству.
{"DeviceList": [
{
"Class": string,
"Description": string,
"ID": string,
"Manufacturer": string,
"ParentID": string,
"ProblemCode": int,
"StatusCode": int
},...
]}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- IoT
Получение данных на подключенных устройствах и концентраторах USB
Запросить
Вы можете получить список дескрипторов USB для подключенных USB-устройств и концентраторов, используя следующий формат запросов.
Способ | URI запроса |
---|---|
GET | /ext/devices/usbdevices |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ JSON, который включает идентификатор USB-устройства, а также дескрипторы USB и сведения о порте для концентраторов.
{
"DeviceList": [
{
"ID": string,
"ParentID": string, // Will equal an "ID" within the list, or be blank
"Description": string, // optional
"Manufacturer": string, // optional
"ProblemCode": int, // optional
"StatusCode": int // optional
},
...
]
}
Пример возвращаемых данных
{
"DeviceList": [{
"ID": "System",
"ParentID": ""
}, {
"Class": "USB",
"Description": "Texas Instruments USB 3.0 xHCI Host Controller",
"ID": "PCI\\VEN_104C&DEV_8241&SUBSYS_1589103C&REV_02\\4&37085792&0&00E7",
"Manufacturer": "Texas Instruments",
"ParentID": "System",
"ProblemCode": 0,
"StatusCode": 25174026
}, {
"Class": "USB",
"Description": "USB Composite Device",
"DeviceDriverKey": "{36fc9e60-c465-11cf-8056-444553540000}\\0016",
"ID": "USB\\VID_045E&PID_00DB\\8&2994096B&0&1",
"Manufacturer": "(Standard USB Host Controller)",
"ParentID": "USB\\VID_0557&PID_8021\\7&2E9A8711&0&4",
"ProblemCode": 0,
"StatusCode": 25182218
}]
}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- IoT
Коллекция дампов
Получение списка всех аварийных дампов для приложений
Запросить
Список всех доступных аварийных дампов для всех неопубликованных приложений можно получить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/debug/dump/usermode/dumps |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ содержит список аварийных дампов для каждого загруженного приложения.
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Window Mobile (в программе предварительной оценки Windows)
- Классические приложения
- HoloLens
- IoT
Получение параметров коллекции аварийного дампа для приложения
Запросить
Параметры сбора аварийных дампов для неопубликованного приложения можно получить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/debug/dump/usermode/crashcontrol |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
packageFullName | (обязательно) Полное имя пакета для неопубликованного приложения. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ имеет следующий формат.
{"CrashDumpEnabled": bool}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Window Mobile (в программе предварительной оценки Windows)
- Классические приложения
- HoloLens
- IoT
Удаление аварийного дампа для неопубликованного приложения
Запросить
Вы можете удалить неопубликованный дамб приложения с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
DELETE | /api/debug/dump/usermode/crashdump |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
packageFullName | (обязательно) Полное имя пакета для неопубликованного приложения. |
fileName | (обязательно) Имя файла дампа, который следует удалить. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Window Mobile (в программе предварительной оценки Windows)
- Классические приложения
- HoloLens
- IoT
Отключение аварийных дампов для неопубликованного приложения
Запросить
Вы можете отключить аварийные дампы для неопубликованного приложения с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
DELETE | /api/debug/dump/usermode/crashcontrol |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
packageFullName | (обязательно) Полное имя пакета для неопубликованного приложения. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Window Mobile (в программе предварительной оценки Windows)
- Классические приложения
- HoloLens
- IoT
Скачивание аварийного дампа для неопубликованного приложения
Запросить
Вы можете скачать неопубликованный дамб приложения с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/debug/dump/usermode/crashdump |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
packageFullName | (обязательно) Полное имя пакета для неопубликованного приложения. |
fileName | (обязательно) Имя файла дампа, который требуется скачать. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ содержит файл дампа. Для проверки файла дампа можно использовать WinDbg или Visual Studio.
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Window Mobile (в программе предварительной оценки Windows)
- Классические приложения
- HoloLens
- IoT
Включение аварийных дампов для неопубликованного приложения
Запросить
Вы можете включить аварийные дампы для неопубликованного приложения с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
POST | /api/debug/dump/usermode/crashcontrol |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
packageFullName | (обязательно) Полное имя пакета для неопубликованного приложения. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
Доступные семейства устройств
- Window Mobile (в программе предварительной оценки Windows)
- Классические приложения
- HoloLens
- IoT
Получение списка файлов проверки ошибок
Запросить
Список мини-файлов с ошибкой можно получить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/debug/dump/kernel/dumplist |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ содержит список имен файлов дампа и размеров этих файлов. Этот список будет иметь следующий формат.
{"DumpFiles": [
{
"FileName": string,
"FileSize": int
},...
]}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
Доступные семейства устройств
- Классические приложения
- IoT
Скачивание файла дампа ошибки
Запросить
Файл дампа ошибки можно скачать с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/debug/dump/kernel/dump |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
filename | (обязательно) Имя файла дампа. Это можно найти с помощью API для получения списка дампов. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ включает файл дампа. Этот файл можно проверить с помощью WinDbg.
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- IoT
Получение параметров управления аварийной ошибкой
Запросить
Параметры управления аварийной ошибкой можно получить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/debug/dump/kernel/crashcontrol |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ включает параметры управления сбоем. Дополнительные сведения о CrashControl см. в статье "CrashControl ". Шаблон ответа выглядит следующим образом.
{
"autoreboot": bool (0 or 1),
"dumptype": int (0 to 4),
"maxdumpcount": int,
"overwrite": bool (0 or 1)
}
Типы дампов
0. Отключено
1. Завершение дампа памяти (собирает всю используемую память)
2. Дамп памяти ядра (игнорирует память в пользовательском режиме)
3. Ограниченный мини-dump ядра
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- IoT
Получение динамического дампа ядра
Запросить
Вы можете получить динамический дамп ядра с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/debug/dump/livekernel |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ включает полный дамп режима ядра. Этот файл можно проверить с помощью WinDbg.
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- IoT
Получение дампа из динамического пользовательского процесса
Запросить
Вы можете получить дамп для динамического пользовательского процесса с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/debug/dump/usermode/live |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
pid | (обязательно) Уникальный идентификатор процесса для интересующего вас процесса. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ включает дамп процесса. Этот файл можно проверить с помощью WinDbg или Visual Studio.
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- IoT
Настройка параметров аварийного контроля ошибок
Запросить
Параметры сбора данных об ошибке можно задать с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
POST | /api/debug/dump/kernel/crashcontrol |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
autoreboot | (необязательно) True или false. Это указывает, выполняется ли автоматическая перезагрузка системы после сбоя или блокировки. |
Дамптип | (необязательно) Тип дампа. Поддерживаемые значения см. в перечислении CrashDumpType. |
maxdumpcount | (необязательно) Максимальное количество дампов для сохранения. |
overwrite | (необязательно) Значение false. Это указывает, следует ли перезаписывать старые дампы при достижении предела счетчика дампа, указанного maxdumpcount . |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- IoT
Трассировка событий Windows
Создание сеанса ETW в режиме реального времени через websocket
Запросить
Сеанс ETW в режиме реального времени можно создать с помощью следующего формата запроса. Это будет управляться через websocket. События ETW пакетируются на сервере и отправляются клиенту один раз в секунду.
Способ | URI запроса |
---|---|
GET/WebSocket | /api/etw/session/realtime |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ включает события ETW от включенных поставщиков. См. приведенные ниже команды ETW WebSocket.
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- IoT
Команды ETW WebSocket
Эти команды отправляются от клиента на сервер.
Команда | Description |
---|---|
provider {guid} enable {level} | Включите поставщик, помеченный {guid} (без квадратных скобок) на указанном уровне. {level} значение int от 1 (наименьших подробностей) до 5 (подробно). |
provider {guid} disable | Отключите поставщик, помеченный {guid} (без квадратных скобок). |
Эти ответы отправляются от сервера клиенту. Это отправляется в виде текста и вы получаете следующий формат, анализируя JSON.
{
"Events":[
{
"Timestamp": int,
"ProviderName": string,
"ID": int,
"TaskName": string,
"Keyword": int,
"Level": int,
payload objects...
},...
],
"Frequency": int
}
Полезные данные — это дополнительные пары "ключ-значение" (string:string), предоставляемые в исходном событии ETW.
Пример:
{
"ID" : 42,
"Keyword" : 9223372036854775824,
"Level" : 4,
"Message" : "UDPv4: 412 bytes transmitted from 10.81.128.148:510 to 132.215.243.34:510. ",
"PID" : "1218",
"ProviderName" : "Microsoft-Windows-Kernel-Network",
"TaskName" : "KERNEL_NETWORK_TASK_UDPIP",
"Timestamp" : 131039401761757686,
"connid" : "0",
"daddr" : "132.245.243.34",
"dport" : "500",
"saddr" : "10.82.128.118",
"seqnum" : "0",
"size" : "412",
"sport" : "500"
}
Перечисление зарегистрированных поставщиков ETW
Запросить
Вы можете перечислить зарегистрированных поставщиков с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/etw/providers |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ содержит список поставщиков ETW. Список будет содержать понятное имя и GUID для каждого поставщика в следующем формате.
{"Providers": [
{
"GUID": string, (GUID)
"Name": string
},...
]}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- IoT
Перечисление настраиваемых поставщиков ETW, предоставляемых платформой.
Запросить
Вы можете перечислить зарегистрированных поставщиков с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/etw/customproviders |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
200 ОК. Ответ содержит список поставщиков ETW. Список будет содержать понятное имя и GUID для каждого поставщика.
{"Providers": [
{
"GUID": string, (GUID)
"Name": string
},...
]}
Код состояния
- Стандартные коды состояния.
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- IoT
Расположение
Получение режима переопределения расположения
Запросить
Вы можете получить состояние переопределения стека расположения устройства, используя следующий формат запроса. Для успешного выполнения этого вызова необходимо включить режим разработчика.
Способ | URI запроса |
---|---|
GET | /ext/location/override |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ содержит состояние переопределения устройства в следующем формате.
{"Override" : bool}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Получение режима переопределения расположения
Запросить
Вы можете определить состояние переопределения стека расположения устройства, используя следующий формат запроса. Если этот параметр включен, стек расположения допускает внедрение положения. Для успешного выполнения этого вызова необходимо включить режим разработчика.
Способ | URI запроса |
---|---|
PUT | /ext/location/override |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
{"Override" : bool}
Response
Ответ содержит настроенное для устройства состояние переопределения в следующем формате.
{"Override" : bool}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Получение внедренного положения
Запросить
Вы можете получить внедренное (подмененное) расположение устройства, используя следующий формат запроса. Если внедренное расположение не установлено, появится сообщение об ошибке.
Способ | URI запроса |
---|---|
GET | /ext/location/position |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ содержит текущие внедренные значения широты и долготы в следующем формате.
{
"Latitude" : double,
"Longitude" : double
}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Определение внедренного положения
Запросить
Вы можете определить внедренное (подмененное) расположение устройства, используя следующий формат запроса. На устройстве должен быть включен режим переопределения расположения, а заданное расположение должно быть допустимым, иначе появится сообщение об ошибке.
Способ | URI запроса |
---|---|
PUT | /ext/location/override |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
{
"Latitude" : double,
"Longitude" : double
}
Response
Ответ содержит заданное расположение в следующем формате.
{
"Latitude" : double,
"Longitude" : double
}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Сведения об ОС
Получение имени компьютера
Запросить
Имя компьютера можно получить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/os/machinename |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ содержит имя компьютера в следующем формате.
{"ComputerName": string}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Получение сведений об операционной системе
Запросить
Сведения об ОС для компьютера можно получить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/os/info |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ содержит сведения об ОС в следующем формате.
{
"ComputerName": string,
"OsEdition": string,
"OsEditionId": int,
"OsVersion": string,
"Platform": string
}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Получение семейства устройств
Запросить
Семейство устройств (Xbox, телефон, рабочий стол и т. д.) можно получить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/os/devicefamily |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ включает семейство устройств (SKU — настольный компьютер, Xbox и т. д.).
{
"DeviceType" : string
}
DeviceType будет выглядеть как "Windows.Xbox", "Windows.Desktop" и т. д.
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Задание имени компьютера
Запросить
Имя компьютера можно задать с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
POST | /api/os/machinename |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
name | (обязательно) Новое имя компьютера. Это должно быть закодировано в кодировке Base64. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Информация о пользователе
Получение активного пользователя
Запросить
Вы можете получить имя активного пользователя на устройстве, используя следующий формат запроса.
Способ | URI запроса |
---|---|
GET | /api/users/activeuser |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ содержит данные о пользователе в следующем формате.
При успешном завершении:
{
"UserDisplayName" : string,
"UserSID" : string
}
При сбое:
{
"Code" : int,
"CodeText" : string,
"Reason" : string,
"Success" : bool
}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- HoloLens
- IoT
Данные о производительности
Получение списка выполняемых процессов
Запросить
Список запущенных процессов можно получить с помощью следующего формата запроса. это можно обновить до подключения WebSocket, а также с теми же данными JSON, отправляемыми клиенту один раз в секунду.
Способ | URI запроса |
---|---|
GET | /api/resourcemanager/processes |
GET/WebSocket | /api/resourcemanager/processes |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ содержит список процессов с подробными сведениями для каждого процесса. Сведения в формате JSON и имеют следующий шаблон.
{"Processes": [
{
"CPUUsage": float,
"ImageName": string,
"PageFileUsage": long,
"PrivateWorkingSet": long,
"ProcessId": int,
"SessionId": int,
"UserName": string,
"VirtualSize": long,
"WorkingSetSize": long
},...
]}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- IoT
Получение статистики производительности системы
Запросить
Статистику производительности системы можно получить с помощью следующего формата запроса. Сюда входят такие сведения, как циклы чтения и записи, а также объем используемой памяти.
Способ | URI запроса |
---|---|
GET | /api/resourcemanager/systemperf |
GET/WebSocket | /api/resourcemanager/systemperf |
Это также можно обновить до подключения WebSocket. Он предоставляет те же данные JSON, приведенные ниже каждые секунды.
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ включает статистику производительности для системы, таких как использование ЦП и GPU, доступ к памяти и сетевой доступ. Эти сведения представлены в формате JSON и имеют следующий шаблон.
{
"AvailablePages": int,
"CommitLimit": int,
"CommittedPages": int,
"CpuLoad": int,
"IOOtherSpeed": int,
"IOReadSpeed": int,
"IOWriteSpeed": int,
"NonPagedPoolPages": int,
"PageSize": int,
"PagedPoolPages": int,
"TotalInstalledInKb": int,
"TotalPages": int,
"GPUData":
{
"AvailableAdapters": [{ (One per detected adapter)
"DedicatedMemory": int,
"DedicatedMemoryUsed": int,
"Description": string,
"SystemMemory": int,
"SystemMemoryUsed": int,
"EnginesUtilization": [ float,... (One per detected engine)]
},...
]},
"NetworkingData": {
"NetworkInBytes": int,
"NetworkOutBytes": int
}
}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Power
Получение текущего состояния батареи
Запросить
Текущее состояние батареи можно получить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/power/battery |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Текущие сведения о состоянии батареи возвращаются с помощью следующего формата.
{
"AcOnline": int (0 | 1),
"BatteryPresent": int (0 | 1),
"Charging": int (0 | 1),
"DefaultAlert1": int,
"DefaultAlert2": int,
"EstimatedTime": int,
"MaximumCapacity": int,
"RemainingCapacity": int
}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- IoT
Получение активной схемы питания
Запросить
Вы можете получить активную схему питания с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/power/activecfg |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Активная схема питания имеет следующий формат.
{"ActivePowerScheme": string (guid of scheme)}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- IoT
Получение подзначного значения для схемы питания
Запросить
Вы можете получить вложенное значение для схемы питания с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/power/cfg/<схема управления питанием> |
Параметры:
- SCHEME_CURRENT
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
Полный список состояний питания доступен на основе каждого приложения и параметры для добавления различных состояний питания, таких как низкое и критическое сбой.
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- IoT
Получение состояния питания системы
Запросить
Вы можете проверить состояние питания системы с помощью следующего формата запроса. Это позволит проверить, находится ли он в состоянии низкой мощности.
Способ | URI запроса |
---|---|
GET | /api/power/state |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Сведения о состоянии питания имеют следующий шаблон.
{"LowPowerState" : false, "LowPowerStateAvailable" : true }
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- HoloLens
- IoT
Настройка активной схемы питания
Запросить
Активную схему питания можно задать с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
POST | /api/power/activecfg |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
scheme | (обязательно) GUID схемы, которую вы хотите задать в качестве активной схемы питания для системы. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- IoT
Установка подзначаемого значения для схемы питания
Запросить
Вы можете задать вложенное значение для схемы питания с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
POST | /api/power/cfg/<схема управления питанием> |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
valueAC | (обязательно) Значение, используемое для питания A/C. |
valueDC | (обязательно) Значение, используемое для питания батареи. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
Доступные семейства устройств
- Классические приложения
- IoT
Получение отчета об изучении сна
Запросить
Способ | URI запроса |
---|---|
GET | /api/power/sleepstudy/report |
Отчет об изучении сна можно получить с помощью следующего формата запроса.
Параметры URI | параметр URI | Описание | | :------ | :------ | | Имя файла| (обязательно) Полное имя файла, который вы хотите загрузить. Это значение должно быть закодировано в шестнадцатеричной кодировке. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ — это файл, содержащий исследование сна.
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- IoT
Перечисление доступных отчетов об изучении сна
Запросить
Вы можете перечислить доступные отчеты об изучении сна с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/power/sleepstudy/reports |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Список доступных отчетов имеет следующий шаблон.
{"Reports": [
{
"FileName": string
},...
]}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- IoT
Получение преобразования исследования сна
Запросить
Преобразование исследования сна можно получить с помощью следующего формата запроса. Это преобразование XSLT, которое преобразует отчет о изучении сна в формат XML, который может читаться человеком.
Способ | URI запроса |
---|---|
GET | /api/power/sleepstudy/transform |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ содержит преобразование исследования сна.
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- IoT
Удаленное управление
Перезагрузите целевой компьютер
Запросить
Вы можете перезапустить целевой компьютер с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
POST | /api/control/restart |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Завершение работы целевого компьютера
Запросить
Вы можете завершить работу целевого компьютера с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
POST | /api/control/shutdown |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Диспетчер задач
Запуск современного приложения
Запросить
Вы можете запустить современное приложение с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
POST | /api/taskmanager/app |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
appid | (обязательно) PRAID для приложения, которое вы хотите запустить. Это значение должно быть закодировано в шестнадцатеричной кодировке. |
package | (обязательно) Полное имя пакета приложения, который вы хотите запустить. Это значение должно быть закодировано в шестнадцатеричной кодировке. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Остановка современного приложения
Запросить
Вы можете остановить современное приложение с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
DELETE | /api/taskmanager/app |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
package | (обязательно) Полное имя пакетов приложений, которые необходимо остановить. Это значение должно быть закодировано в шестнадцатеричной кодировке. |
силами | (необязательно) Значение да указывает, что система должна принудительно остановить все процессы. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Завершение процесса, определенного по идентификатору процесса
Запросить
Процесс можно завершить, используя следующий формат запроса.
Способ | URI запроса |
---|---|
DELETE | /api/taskmanager/process |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
pid | (Обязательный.) Уникальный идентификатор процесса, который требуется остановить. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- HoloLens
- IoT
Сеть
Получение текущей конфигурации IP-адресов
Запросить
Текущую IP-конфигурацию можно получить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/networking/ipconfig |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Ответ включает IP-конфигурацию в следующем шаблоне.
{"Adapters": [
{
"Description": string,
"HardwareAddress": string,
"Index": int,
"Name": string,
"Type": string,
"DHCP": {
"LeaseExpires": int, (timestamp)
"LeaseObtained": int, (timestamp)
"Address": {
"IpAddress": string,
"Mask": string
}
},
"WINS": {(WINS is optional)
"Primary": {
"IpAddress": string,
"Mask": string
},
"Secondary": {
"IpAddress": string,
"Mask": string
}
},
"Gateways": [{ (always 1+)
"IpAddress": "10.82.128.1",
"Mask": "255.255.255.255"
},...
],
"IpAddresses": [{ (always 1+)
"IpAddress": "10.82.128.148",
"Mask": "255.255.255.0"
},...
]
},...
]}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Настройка статического IP-адреса (конфигурация IPV4)
Запросить
Настраивает статический IP-адрес и параметры DNS для конфигурации IPV4. Если статический IP-адрес не указан, включает DHCP. Если статический IP-адрес указан, должен быть указан и сервер DNS.
Способ | URI запроса |
---|---|
PUT | /api/networking/ipv4config |
Параметры универсального кода ресурса
Параметр универсального кода ресурса | Description |
---|---|
AdapterName | (Обязательный.) GUID сетевого интерфейса. |
IPAddress | Статический IP-адрес, который нужно настроить. |
SubnetMask | (Обязательный, если IPAddress имеет отличающееся от NULL значение.) Статическая маска подсети. |
DefaultGateway | (Обязательный, если IPAddress имеет отличающееся от NULL значение.) Статический шлюз по умолчанию. |
PrimaryDNS | (Обязательный, если IPAddress имеет отличающееся от NULL значение.) Статический адрес основного сервера DNS. |
SecondayDNS | (Обязательный, если PrimaryDNS имеет отличающееся от NULL значение.) Статический адрес дополнительного сервера DNS. |
Помните, что для настройки DHCP в интерфейсе нужно сериализовать только AdapterName
:
{
"AdapterName":"{82F86C1B-2BAE-41E3-B08D-786CA44FEED7}"
}
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Перечисление беспроводных сетевых интерфейсов
Запросить
Вы можете перечислить доступные беспроводные сетевые интерфейсы с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/wifi/interfaces |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Список доступных беспроводных интерфейсов со сведениями в следующем формате.
{"Interfaces": [{
"Description": string,
"GUID": string (guid with curly brackets),
"Index": int,
"ProfilesList": [
{
"GroupPolicyProfile": bool,
"Name": string, (Network currently connected to)
"PerUserProfile": bool
},...
]
}
]}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Перечисление беспроводных сетей
Запросить
Список беспроводных сетей можно перечислить в указанном интерфейсе с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/wifi/networks |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
интерфейс | (обязательно) GUID сетевого интерфейса для поиска беспроводных сетей без квадратных скобок. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Список беспроводных сетей, найденных в предоставленном интерфейсе. Сюда входят сведения о сетях в следующем формате.
{"AvailableNetworks": [
{
"AlreadyConnected": bool,
"AuthenticationAlgorithm": string, (WPA2, etc)
"Channel": int,
"CipherAlgorithm": string, (for example, AES)
"Connectable": int, (0 | 1)
"InfrastructureType": string,
"ProfileAvailable": bool,
"ProfileName": string,
"SSID": string,
"SecurityEnabled": int, (0 | 1)
"SignalQuality": int,
"BSSID": [int,...],
"PhysicalTypes": [string,...]
},...
]}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Подключение и отключение к сети Wi-Fi.
Запросить
Вы можете подключить или отключиться к сети Wi-Fi с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
POST | /api/wifi/network |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
интерфейс | (обязательно) GUID сетевого интерфейса, используемого для подключения к сети. |
op | (обязательно) Указывает действие для выполнения. Возможные значения : подключение или отключение. |
ssid | (требуется, если op == connect) SSID для подключения. |
key | (Обязательный, если у параметра op значение connect и сеть требует проверку подлинности.) Общий ключ. |
createprofile | (обязательно) Создайте профиль для сети на устройстве. Это приведет к автоматическому подключению устройства к сети в будущем. Это может быть да или нет. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Удаление профиля Wi-Fi
Запросить
Профиль, связанный с сетью, можно удалить в определенном интерфейсе с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
DELETE | /api/wifi/profile |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
интерфейс | (обязательно) GUID сетевого интерфейса, связанного с профилем для удаления. |
профиль | (обязательно) Имя профиля для удаления. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Отчеты об ошибках Windows (WER)
Скачивание файла отчетов об ошибках Windows (WER)
Запросить
Файл, связанный с WER, можно скачать с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/wer/report/file |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
Пользователь | (обязательно) Имя пользователя, связанное с отчетом. |
type | (обязательно) Тип отчета. Это может быть запрос или архивировано. |
name | (обязательно) Имя отчета. Это должно быть закодировано в кодировке Base64. |
файл | (обязательно) Имя файла для скачивания из отчета. Это должно быть закодировано в кодировке Base64. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
- Ответ содержит запрошенный файл.
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- HoloLens
- IoT
Перечисление файлов в отчете об ошибках Windows (WER)
Запросить
Вы можете перечислить файлы в отчете WER с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/wer/report/files |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
Пользователь | (обязательно) Пользователь, связанный с отчетом. |
type | (обязательно) Тип отчета. Это может быть запрос или архивировано. |
name | (обязательно) Имя отчета. Это должно быть закодировано в кодировке Base64. |
Заголовки запроса
- нет
Текст запроса
{"Files": [
{
"Name": string, (Filename, not base64 encoded)
"Size": int (bytes)
},...
]}
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- HoloLens
- IoT
Вывод списка отчетов об ошибках Windows (WER)
Запросить
Отчеты WER можно получить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/wer/reports |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
WeR сообщает в следующем формате.
{"WerReports": [
{
"User": string,
"Reports": [
{
"CreationTime": int,
"Name": string, (not base64 encoded)
"Type": string ("Queue" or "Archive")
},
]},...
]}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Классические приложения
- HoloLens
- IoT
Средство записи производительности Windows (WPR)
Начало трассировки с пользовательским профилем
Запросить
Вы можете отправить профиль WPR и начать трассировку с помощью этого профиля с помощью следующего формата запроса. Одновременно может выполняться только одна трассировка. Профиль не останется на устройстве.
Способ | URI запроса |
---|---|
POST | /api/wpr/customtrace |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- Многокомпонентный текст http, содержащий пользовательский профиль WPR.
Response
Состояние сеанса WPR в следующем формате.
{
"SessionType": string, (Running or Idle)
"State": string (normal or boot)
}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- IoT
Запуск сеанса трассировки производительности загрузки
Запросить
Сеанс трассировки WPR можно запустить с помощью следующего формата запроса. Это также называется сеансом трассировки производительности.
Способ | URI запроса |
---|---|
POST | /api/wpr/boottrace |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
профиль | (обязательно) Этот параметр требуется при запуске. Имя профиля, который должен запустить сеанс трассировки производительности. Возможные профили хранятся в perfprofiles/profiles.json. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
При запуске этот API возвращает состояние сеанса WPR в следующем формате.
{
"SessionType": string, (Running or Idle)
"State": string (boot)
}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- IoT
Остановка сеанса трассировки производительности загрузки
Запросить
Сеанс трассировки WPR загрузки можно остановить с помощью следующего формата запроса. Это также называется сеансом трассировки производительности.
Способ | URI запроса |
---|---|
GET | /api/wpr/boottrace |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
- Нет. Примечание. Это длительная операция. Он вернет, когда ETL завершит запись на диск.
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- IoT
Запуск сеанса трассировки производительности
Запросить
Сеанс трассировки WPR можно запустить с помощью следующего формата запроса. Это также называется сеансом трассировки производительности. Одновременно может выполняться только одна трассировка.
Способ | URI запроса |
---|---|
POST | /api/wpr/trace |
Параметры универсального кода ресурса
Можно указать следующие дополнительные параметры в URI запроса:
Параметр универсального кода ресурса | Description |
---|---|
профиль | (обязательно) Имя профиля, который должен запустить сеанс трассировки производительности. Возможные профили хранятся в perfprofiles/profiles.json. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
При запуске этот API возвращает состояние сеанса WPR в следующем формате.
{
"SessionType": string, (Running or Idle)
"State": string (normal)
}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- IoT
Остановка сеанса трассировки производительности
Запросить
Сеанс трассировки WPR можно остановить с помощью следующего формата запроса. Это также называется сеансом трассировки производительности.
Способ | URI запроса |
---|---|
GET | /api/wpr/trace |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
- Нет. Примечание. Это длительная операция. Он вернет, когда ETL завершит запись на диск.
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- IoT
Получение состояния сеанса трассировки
Запросить
Состояние текущего сеанса WPR можно получить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/wpr/status |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Состояние сеанса трассировки WPR в следующем формате.
{
"SessionType": string, (Running or Idle)
"State": string (normal or boot)
}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- IoT
Вывод списка завершенных сеансов трассировки (ETLs)
Запросить
Вы можете получить список трассировок ETL на устройстве с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/wpr/tracefiles |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
Список завершенных сеансов трассировки предоставляется в следующем формате.
{"Items": [{
"CurrentDir": string (filepath),
"DateCreated": int (File CreationTime),
"FileSize": int (bytes),
"Id": string (filename),
"Name": string (filename),
"SubPath": string (filepath),
"Type": int
}]}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- IoT
Скачивание сеанса трассировки (ETL)
Запросить
Файл трассировки (трассировка загрузки или трассировка пользовательского режима) можно скачать с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
GET | /api/wpr/tracefile |
Параметры универсального кода ресурса
В URI запроса можно указать следующий дополнительный параметр:
Параметр универсального кода ресурса | Description |
---|---|
filename | (обязательно) Имя трассировки ETL для скачивания. Их можно найти в файлах /api/wpr/tracefile |
Заголовки запроса
- нет
Текст запроса
- нет
Response
- Возвращает файл трассировки ETL.
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- IoT
Удаление сеанса трассировки (ETL)
Запросить
Файл трассировки (трассировка загрузки или трассировка пользовательского режима) можно удалить с помощью следующего формата запроса.
Способ | URI запроса |
---|---|
DELETE | /api/wpr/tracefile |
Параметры универсального кода ресурса
В URI запроса можно указать следующий дополнительный параметр:
Параметр универсального кода ресурса | Description |
---|---|
filename | (обязательно) Имя трассировки ETL для удаления. Их можно найти в файлах /api/wpr/tracefile |
Заголовки запроса
- нет
Текст запроса
- нет
Response
- Возвращает файл трассировки ETL.
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- IoT
Теги DNS-SD
Просмотр тегов
Запросить
Просмотрите примененные теги для устройства. Они объявляются с помощью записей TXT DNS-SD в ключе T.
Способ | URI запроса |
---|---|
GET | /api/dns-sd/tags |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Ответ На текущий примененные теги в следующем формате.
{
"tags": [
"tag1",
"tag2",
...
]
}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
5XX | Ошибка сервера |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Удаление тегов
Запросить
Удалите все теги, объявленные DNS-SD.
Способ | URI запроса |
---|---|
DELETE | /api/dns-sd/tags |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Response
- нет
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
5XX | Ошибка сервера |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Удаление тега
Запросить
Удаление тега, объявленного DNS-SD.
Способ | URI запроса |
---|---|
DELETE | /api/dns-sd/tag |
Параметры универсального кода ресурса
Параметр универсального кода ресурса | Description |
---|---|
tagValue | (обязательно) Тег, который необходимо удалить. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
- нет
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Добавление тега
Запросить
Добавьте тег в объявление DNS-SD.
Способ | URI запроса |
---|---|
POST | /api/dns-sd/tag |
Параметры универсального кода ресурса
Параметр универсального кода ресурса | Description |
---|---|
tagValue | (обязательно) Добавляемый тег. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
- нет
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
401 | Тег переполнения пространства. Результаты, когда предлагаемый тег слишком длинный для полученной записи службы DNS-SD. |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- Xbox
- HoloLens
- IoT
Проводник приложения
Получение известных папок
Запросить
Получите список доступных папок верхнего уровня.
Способ | URI запроса |
---|---|
GET | /api/filesystem/apps/knownfolders |
Параметры универсального кода ресурса
- нет
Заголовки запроса
- нет
Текст запроса
- нет
Ответ доступных папок в следующем формате.
{"KnownFolders": [
"folder0",
"folder1",...
]}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | Развертывание запроса, принятого и обрабатываемого |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- Xbox
- IoT
Получение файлов
Запросить
Получите список файлов в папке.
Способ | URI запроса |
---|---|
GET | /api/filesystem/apps/files |
Параметры универсального кода ресурса
Параметр универсального кода ресурса | Description |
---|---|
известныйfolderid | (обязательно) Каталог верхнего уровня, в котором требуется список файлов. Используйте LocalAppData для доступа к неопубликованным приложениям. |
packagefullname | (Обязательный, если у параметра knownfolderid значение LocalAppData.) Полное имя пакета интересующего вас приложения. |
path | (необязательно) Вложенный каталог в папке или пакете, указанный выше. |
Заголовки запроса
- нет
Текст запроса
- нет
Ответ доступных папок в следующем формате.
{"Items": [
{
"CurrentDir": string (folder under the requested known folder),
"DateCreated": int,
"FileSize": int (bytes),
"Id": string,
"Name": string,
"SubPath": string (present if this item is a folder, this is the name of the folder),
"Type": int
},...
]}
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | OK |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- Xbox
- IoT
Скачивание файла
Запросить
Получите файл из известной папки или appLocalData.
Способ | URI запроса |
---|---|
GET | /api/filesystem/apps/file |
Параметры универсального кода ресурса
Параметр универсального кода ресурса | Description |
---|---|
известныйfolderid | (обязательно) Каталог верхнего уровня, в котором требуется скачать файлы. Используйте LocalAppData для доступа к неопубликованным приложениям. |
filename | (обязательно) Имя скачиваемого файла. |
packagefullname | (Обязательный, если у параметра knownfolderid значение LocalAppData) Полное имя интересующего вас пакета. |
path | (необязательно) Вложенный каталог в папке или пакете, указанный выше. |
Заголовки запроса
- нет
Текст запроса
- Запрошенный файл, если он присутствует
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | Запрошенный файл |
404 | Файл не найден |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- Xbox
- IoT
Переименование файла
Запросить
Переименуйте файл в папке.
Способ | URI запроса |
---|---|
POST | /api/filesystem/apps/rename |
Параметры универсального кода ресурса
Параметр универсального кода ресурса | Description |
---|---|
известныйfolderid | (обязательно) Каталог верхнего уровня, в котором находится файл. Используйте LocalAppData для доступа к неопубликованным приложениям. |
filename | (обязательно) Исходное имя переименоваемого файла. |
newfilename | (обязательно) Новое имя файла. |
packagefullname | (Обязательный, если у параметра knownfolderid значение LocalAppData.) Полное имя пакета интересующего вас приложения. |
path | (необязательно) Вложенный каталог в папке или пакете, указанный выше. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
- нет
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | ОК. Файл переименован |
404 | Файл не найден |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- Xbox
- IoT
Удаление файла
Запросить
Удаление файла в папке.
Способ | URI запроса |
---|---|
DELETE | /api/filesystem/apps/file |
Параметры универсального кода ресурса
Параметр универсального кода ресурса | Description |
---|---|
известныйfolderid | (обязательно) Каталог верхнего уровня, в котором требуется удалить файлы. Используйте LocalAppData для доступа к неопубликованным приложениям. |
filename | (обязательно) Имя удаленного файла. |
packagefullname | (Обязательный, если у параметра knownfolderid значение LocalAppData.) Полное имя пакета интересующего вас приложения. |
path | (необязательно) Вложенный каталог в папке или пакете, указанный выше. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
- нет
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | ОК. Файл удаляется |
404 | Файл не найден |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- Xbox
- IoT
Отправка файла
Запросить
Отправьте файл в папку. Это перезаписывает существующий файл с тем же именем, но не создаст новые папки.
Способ | URI запроса |
---|---|
POST | /api/filesystem/apps/file |
Параметры универсального кода ресурса
Параметр универсального кода ресурса | Description |
---|---|
известныйfolderid | (обязательно) Каталог верхнего уровня, в котором требуется отправить файлы. Используйте LocalAppData для доступа к неопубликованным приложениям. |
packagefullname | (Обязательный, если у параметра knownfolderid значение LocalAppData.) Полное имя пакета интересующего вас приложения. |
extract | (Обязательно.) True или false. Указывает, следует ли извлекать файл после отправки. |
path | (необязательно) Вложенный каталог в папке или пакете, указанный выше. |
Заголовки запроса
- нет
Текст запроса
- нет
Response
Код состояния
Этот API содержит следующие ожидаемые коды состояния.
Код состояния HTTP | Description |
---|---|
200 | ОК. Файл отправляется |
4XX | Коды ошибок |
5XX | Коды ошибок |
Доступные семейства устройств
- Windows Mobile
- Классические приложения
- HoloLens
- Xbox
- IoT