Справка по базовому API портала устройствDevice Portal core API reference

Все функциональные возможности портала устройств поддерживают REST API, которые разработчики могут вызывать напрямую для получения доступа к ресурсам и управления устройствами программными средствами.All Device Portal functionality is built on REST APIs that developers can call directly to access resources and control their devices programmatically.

Развертывание приложенияApp deployment

Установка приложенияInstall an app

ЗапросRequest

Приложение можно установить с помощью следующего формата запроса.You can install an app by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/app/packagemanager/package/api/app/packagemanager/package

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
Пакетpackage (обязательно) Имя файла устанавливаемого пакета.(required) The file name of the package to be installed.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • Файл .appx или .appxbundle, а также все зависимости, требуемые приложением.The .appx or .appxbundle file, as well as any dependencies the app requires.
  • Сертификат, используемый для подписывания приложения, если это устройство IoT или настольный компьютер с Windows.The certificate used to sign the app, if the device is IoT or Windows Desktop. Другие платформы не требуют сертификата.Other platforms do not require the certificate.

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 Принятый и обрабатываемый запрос на развертываниеDeploy request accepted and being processed
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

ЗапросRequest

Связанный набор можно установить с помощью следующего формата запроса.You can install a related set by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/app/packagemanager/package/api/app/packagemanager/package

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
Пакетpackage (Обязательный. ) Имена файлов устанавливаемых пакетов.(required) The file names of the packages to be installed.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • Добавляйте расширение .opt к именам файлов дополнительных пакетов, если они используются в качестве параметра, например: foo.appx.opt или bar.appxbundle.opt.Add ".opt" to the optional package file names when specifying them as a parameter, like so: "foo.appx.opt" or "bar.appxbundle.opt".
  • Файл .appx или .appxbundle, а также все зависимости, требуемые приложением.The .appx or .appxbundle file, as well as any dependencies the app requires.
  • Сертификат, используемый для подписывания приложения, если это устройство IoT или настольный компьютер с Windows.The certificate used to sign the app, if the device is IoT or Windows Desktop. Другие платформы не требуют сертификата.Other platforms do not require the certificate.

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 Принятый и обрабатываемый запрос на развертываниеDeploy request accepted and being processed
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Регистрация приложения в свободной папкеRegister an app in a loose folder

ЗапросRequest

Вы можете зарегистрировать приложение в свободной папке с помощью следующего формата запросов.You can register an app in a loose folder by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/app/packagemanager/networkapp/api/app/packagemanager/networkapp

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

{
    "mainpackage" :
    {
        "networkshare" : "\\some\share\path",
        "username" : "optional_username",
        "password" : "optional_password"
    }
}

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 Принятый и обрабатываемый запрос на развертываниеDeploy request accepted and being processed
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

ЗапросRequest

Вы можете зарегистрировать связанный набор в свободных папках с помощью следующего формата запросов.You can register a related set in loose folders by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/app/packagemanager/networkapp/api/app/packagemanager/networkapp

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

{
    "mainpackage" :
    {
        "networkshare" : "\\some\share\path",
        "username" : "optional_username",
        "password" : "optional_password"
    },
    "optionalpackages" :
    [
        {
            "networkshare" : "\\some\share\path2",
            "username" : "optional_username2",
            "password" : "optional_password2"
        },
        ...
    ]
}

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 Принятый и обрабатываемый запрос на развертываниеDeploy request accepted and being processed
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Получение состояния установки приложенияGet app installation status

ЗапросRequest

Сведения о состоянии выполняемой в настоящее время установки приложения можно получить, используя для этого следующий формат запроса.You can get the status of an app installation that is currently in progress by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/app/packagemanager/state/api/app/packagemanager/state

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 Результат последнего развертыванияThe result of the last deployment
204204 Выполняется установкаThe installation is running
404404 Операция по установке не обнаруженаNo installation action was found

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Удаление приложенияUninstall an app

ЗапросRequest

Удалить приложение можно с помощью следующего формата запроса.You can uninstall an app by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
DELETEDELETE /api/app/packagemanager/package/api/app/packagemanager/package

Параметры URIURI parameters

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
Пакетpackage (обязательно) PackageFullName (из GET /api/app/packagemanager/packages) целевого приложения(required) The PackageFullName (from GET /api/app/packagemanager/packages) of the target app

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Получение списка установленных приложенийGet installed apps

ЗапросRequest

Список установленных в системе приложений можно получить, используя следующий формат запроса.You can get a list of apps installed on the system by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/app/packagemanager/packages/api/app/packagemanager/packages

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ включает список установленных пакетов с соответствующими сведениями.The response includes a list of installed packages with associated details. Шаблон для этого ответа выглядит следующим образом.The template for this response is as follows.

{"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
     },...
     ]
    },...
]}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

BluetoothBluetooth


Получение списка радиомодулей Bluetooth на компьютереGet the Bluetooth radios on the machine

ЗапросRequest

Список установленных на компьютере радиомодулей Bluetooth можно получить, используя следующий формат запросов.You can get a list of the Bluetooth radios that are installed on the machine by using the following request format. Его также можно обновить до подключения WebSocket, используя те же данные JSON.This can be upgraded to a WebSocket connection as well, with the same JSON data.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/bt/getradios/api/bt/getradios
GET/WebSocketGET/WebSocket /api/bt/getradios/api/bt/getradios

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ содержит массив подключенных к устройству радиомодулей Bluetooth в формате JSON.The response includes a JSON array of Bluetooth radios attached to the device.

{"BluetoothRadios" : [
    {
        "BluetoothAddress" : int64,
        "DisplayName" : string,
        "HasUnknownUsbDevice" : boolean,
        "HasProblem" : boolean,
        "ID" : string,
        "ProblemCode" : int,
        "State" : string
    },...
]}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Включение и отключение радиомодулей BluetoothTurn the Bluetooth radio on or off

ЗапросRequest

Включает и отключает определенный радиомодуль Bluetooth.Sets a specific Bluetooth radio to On or Off.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/bt/setradio/api/bt/setradio

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
КодID (Обязательный. ) Идентификатор устройства для радиомодуля Bluetooth иметь кодировку base64.(required) The device ID for the Bluetooth radio and must be base 64 encoded.
StateState (Обязательный. ) Может иметь значение "On" или "Off".(required) This can be "On" or "Off".

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Получение списка связанных устройств BluetoothGet a list of paired Bluetooth devices

ЗапросRequest

Вы можете получить список связанных устройств Bluetooth, используя следующий формат запроса.You can get a list of the currently paired Bluetooth devices by using the following request format. Его можно обновить до подключения WebSocket, используя те же данные JSON.This can be upgraded to a WebSocket connection with the same JSON data. За время существования подключения WebSocket список устройств может измениться.During the lifetime of the WebSocket connection, the device list can change. Полный список устройств будет отправляться через подключение WebSocket при каждом обновлении.A complete list of devices will be sent over the WebSocket connection each time there is an update.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/bt/getpaired/api/bt/getpaired
GET/WebSocketGET/WebSocket /api/bt/getpaired/api/bt/getpaired

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ содержит массив связанных устройств Bluetooth в формате JSON.The response includes a JSON array of Bluetooth devices that are currently paired.

{"PairedDevices": [
    {
        "Name" : string,
        "ID" : string,
        "AudioConnectionStatus" : string
    },...
]}

Если устройство может использоваться для воспроизведения аудио в этой системе, отобразится поле AudioConnectionStatus.The AudioConnectionStatus field will be present if the device can be used for audio on this system. (На это поведение могут влиять политики и необязательные компоненты.) AudioConnectionStatus будет иметь значение Connected или Disconnected.(Policies and optional components may affect this.) AudioConnectionStatus will be either "Connected" or "Disconnected".


Получение списка доступных устройств BluetoothGet a list of available Bluetooth devices

ЗапросRequest

Вы можете получить список доступных для связывания устройств Bluetooth, используя следующий формат запроса.You can get a list of the Bluetooth devices available for pairing by using the following request format. Его можно обновить до подключения WebSocket, используя те же данные JSON.This can be upgraded to a WebSocket connection with the same JSON data. За время существования подключения WebSocket список устройств может измениться.During the lifetime of the WebSocket connection, the device list can change. Полный список устройств будет отправляться через подключение WebSocket при каждом обновлении.A complete list of devices will be sent over the WebSocket connection each time there is an update.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/bt/getavailable/api/bt/getavailable
GET/WebSocketGET/WebSocket /api/bt/getavailable/api/bt/getavailable

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ содержит массив доступных для связывания устройств Bluetooth в формате JSON.The response includes a JSON array of Bluetooth devices that are currently available for pairing.

{"AvailableDevices": [
    {
        "Name" : string,
        "ID" : string
    },...
]}

Подключение устройств BluetoothConnect a Bluetooth device

ЗапросRequest

Выполняет подключение к устройству, если устройство может использоваться для воспроизведения аудио в этой системе.Will connect to the device if the device can be used for audio on this system. (На это поведение могут влиять политики и необязательные компоненты.)(Policies and optional components may affect this.)

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/bt/connectdevice/api/bt/connectdevice

Параметры URIURI parameters

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
КодID (Обязательный. ) Идентификатор конечной точки связи для устройства Bluetooth должен иметь кодировку base64.(required) The Association Endpoint ID for the Bluetooth device and must be Base64-encoded.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Отключение устройств BluetoothDisconnect a Bluetooth device

ЗапросRequest

Выполняет отключение устройства, если устройство может использоваться для воспроизведения аудио в этой системе.Will disconnect the device if the device can be used for audio on this system. (На это поведение могут влиять политики и необязательные компоненты.)(Policies and optional components may affect this.)

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/bt/disconnectdevice/api/bt/disconnectdevice

Параметры URIURI parameters

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
КодID (Обязательный. ) Идентификатор конечной точки связи для устройства Bluetooth должен иметь кодировку base64.(required) The Association Endpoint ID for the Bluetooth device and must be Base64-encoded.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Диспетчер устройствDevice manager


Получение списка установленных на компьютере устройствGet the installed devices on the machine

ЗапросRequest

Список установленных на компьютере устройств можно получить, используя следующий формат запросов.You can get a list of devices that are installed on the machine by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/devicemanager/devices/api/devicemanager/devices

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ содержит массив устройств JSON , подключенных к устройству.The response includes a JSON array of devices attached to the device.

{"DeviceList": [
    {
        "Class": string,
        "Description": string,
        "ID": string,
        "Manufacturer": string,
        "ParentID": string,
        "ProblemCode": int,
        "StatusCode": int
    },...
]}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • Интернет вещейIoT

Получение данных на подключенных устройствах и концентраторах USBGet data on connected USB Devices/Hubs

ЗапросRequest

Вы можете получить список дескрипторов USB для подключенных USB-устройств и концентраторов, используя следующий формат запросов.You can get a list of USB descriptors for connected USB devices and Hubs by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /ext/devices/usbdevices/ext/devices/usbdevices

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ JSON, который включает идентификатор USB-устройства, а также дескрипторы USB и сведения о порте для концентраторов.The response is JSON that includes DeviceID for the USB Device along with the USB Descriptors and port information for hubs.

{
    "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
        },
        ...
    ]
}

Пример возвращаемых данныхSample return data

{
    "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
    }]
}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • Интернет вещейIoT

Коллекция дамповDump collection


Получение списка всех аварийных дампов для приложенийGet the list of all crash dumps for apps

ЗапросRequest

Список всех доступных аварийных дампов для всех неопубликованных приложений можно получить, используя следующий формат запроса.You can get the list of all the available crash dumps for all sideloaded apps by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/debug/dump/usermode/dumps/api/debug/dump/usermode/dumps

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ включает список аварийных дампов для каждого неопубликованного приложения.The response includes a list of crash dumps for each sideloaded application.

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Window Mobile (в программе предварительной оценки Windows)Window Mobile (in Windows Insider Program)
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Получение параметров коллекции аварийных дампов для приложенияGet the crash dump collection settings for an app

ЗапросRequest

Параметры коллекции аварийных дампов для неопубликованного приложения можно получить, используя следующий формат запроса.You can get the crash dump collection settings for a sideloaded app by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/debug/dump/usermode/crashcontrol/api/debug/dump/usermode/crashcontrol

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
packageFullnamepackageFullname (необходимо) Полное имя пакета для неопубликованного приложения.(required) The full name of the package for the sideloaded app.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Этот ответ имеет указанный ниже формат.The response has the following format.

{"CrashDumpEnabled": bool}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Window Mobile (в программе предварительной оценки Windows)Window Mobile (in Windows Insider Program)
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Удаление аварийного дампа неопубликованного приложенияDelete a crash dump for a sideloaded app

ЗапросRequest

Аварийный дамп неопубликованного приложения можно удалить с помощью следующего формата запросов.You can delete a sideloaded app's crash dump by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
DELETEDELETE /api/debug/dump/usermode/crashdump/api/debug/dump/usermode/crashdump

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
packageFullnamepackageFullname (необходимо) Полное имя пакета для неопубликованного приложения.(required) The full name of the package for the sideloaded app.
fileNamefileName (необходимо) Имя файла дампа, который следует удалить.(required) The name of the dump file that should be deleted.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Window Mobile (в программе предварительной оценки Windows)Window Mobile (in Windows Insider Program)
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Отключение аварийных дампов для неопубликованного приложенияDisable crash dumps for a sideloaded app

ЗапросRequest

Аварийные дампы для неопубликованного приложения можно отключить с помощью следующего формата запросов.You can disable crash dumps for a sideloaded app by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
DELETEDELETE /api/debug/dump/usermode/crashcontrol/api/debug/dump/usermode/crashcontrol

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
packageFullnamepackageFullname (необходимо) Полное имя пакета для неопубликованного приложения.(required) The full name of the package for the sideloaded app.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Window Mobile (в программе предварительной оценки Windows)Window Mobile (in Windows Insider Program)
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Загрузка аварийного дампа для неопубликованного приложенияDownload the crash dump for a sideloaded app

ЗапросRequest

Аварийный дамп неопубликованного приложения можно загрузить, используя следующий формат запроса.You can download a sideloaded app's crash dump by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/debug/dump/usermode/crashdump/api/debug/dump/usermode/crashdump

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
packageFullnamepackageFullname (необходимо) Полное имя пакета для неопубликованного приложения.(required) The full name of the package for the sideloaded app.
fileNamefileName (необходимо) Имя файла дампа, который следует загрузить.(required) The name of the dump file that you want to download.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ включает файл дампа.The response includes a dump file. Для изучения файла дампа можно использовать WinDbg или Visual Studio.You can use WinDbg or Visual Studio to examine the dump file.

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Window Mobile (в программе предварительной оценки Windows)Window Mobile (in Windows Insider Program)
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Включение аварийных дампов для неопубликованного приложенияEnable crash dumps for a sideloaded app

ЗапросRequest

Аварийные дампы для неопубликованного приложения можно включить с помощью следующего формата запросов.You can enable crash dumps for a sideloaded app by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/debug/dump/usermode/crashcontrol/api/debug/dump/usermode/crashcontrol

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
packageFullnamepackageFullname (необходимо) Полное имя пакета для неопубликованного приложения.(required) The full name of the package for the sideloaded app.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK

Доступные семейства устройствAvailable device families

  • Window Mobile (в программе предварительной оценки Windows)Window Mobile (in Windows Insider Program)
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Получение списка файлов проверки ошибокGet the list of bugcheck files

ЗапросRequest

Список файлов мини-дампа для проверки ошибок можете получить с помощью следующего формата запроса.You can get the list of bugcheck minidump files by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/debug/dump/kernel/dumplist/api/debug/dump/kernel/dumplist

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ включает список имен файлов дампа, а также размеры этих файлов.The response includes a list of dump file names and the sizes of these files. Этот список будет иметь следующий формат.This list will be in the following format.

{"DumpFiles": [
    {
        "FileName": string,
        "FileSize": int
    },...
]}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • Интернет вещейIoT

Загрузка файла дампа для проверки ошибокDownload a bugcheck dump file

ЗапросRequest

Файл дампа для проверки ошибок можно загрузить с помощью следующего формата запроса.You can download a bugcheck dump file by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/debug/dump/kernel/dump/api/debug/dump/kernel/dump

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
имя_файлаfilename (необходимо) Имя файла дампа.(required) The file name of the dump file. Вы можете найти это с помощью API для получения списка дампов.You can find this by using the API to get the dump list.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ включает файл дампа.The response includes the dump file. Вы можете осмотреть этот файл с помощью WinDbg.You can inspect this file using WinDbg.

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • Интернет вещейIoT

Получение параметров контроля сбоев с использованием проверки ошибокGet the bugcheck crash control settings

ЗапросRequest

Параметры контроля сбоев с использованием проверки ошибок можно получить, используя следующий формат запроса.You can get the bugcheck crash control settings by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/debug/dump/kernel/crashcontrol/api/debug/dump/kernel/crashcontrol

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ включает параметры контроля сбоев.The response includes the crash control settings. Подробнее о CrashControl см. в статье CrashControl.For more information about CrashControl, see the CrashControl article. Шаблон для этого ответа выглядит следующим образом.The template for the response is as follows.

{
    "autoreboot": bool (0 or 1),
    "dumptype": int (0 to 4),
    "maxdumpcount": int,
    "overwrite": bool (0 or 1)
}

Типы дамповDump types

0. Отключен0: Disabled

1. Полный дамп памяти (собирает всю используемую память).1: Complete memory dump (collects all in-use memory)

2. Дамп памяти ядра (игнорирует память в режиме пользователя).2: Kernel memory dump (ignores user mode memory)

3. Ограниченный мини-дамп ядра.3: Limited kernel minidump

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • Интернет вещейIoT

Получение дампа ядра в режиме реального времениGet a live kernel dump

ЗапросRequest

Дамп ядра в режиме реального времени можно получить с помощью следующего формата запроса.You can get a live kernel dump by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/debug/dump/livekernel/api/debug/dump/livekernel

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ включает полный дамп режима ядра.The response includes the full kernel mode dump. Вы можете осмотреть этот файл с помощью WinDbg.You can inspect this file using WinDbg.

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • Интернет вещейIoT

Получение дампа из пользовательского процесса в режиме реального времениGet a dump from a live user process

ЗапросRequest

Дамп из пользовательского процесса в режиме реального времени можно получить, используя следующий формат запроса.You can get the dump for live user process by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/debug/dump/usermode/live/api/debug/dump/usermode/live

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
pidpid (необходимо) Уникальный идентификатор интересующего вас процесса.(required) The unique process id for the process you are interested in.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ включает дамп процесса.The response includes the process dump. Вы можете осмотреть этот файл с помощью WinDbg или Visual Studio.You can inspect this file using WinDbg or Visual Studio.

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • Интернет вещейIoT

Определение параметров контроля сбоев с использованием проверки ошибокSet the bugcheck crash control settings

ЗапросRequest

Параметры для сбора данных проверки ошибок можно настроить с помощью следующего формата запроса.You can set the settings for collecting bugcheck data by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/debug/dump/kernel/crashcontrol/api/debug/dump/kernel/crashcontrol

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
autorebootautoreboot (необязательно) True или false.(optional) True or false. Показывает, перезапускается ли система автоматически после сбоев или блокировок.This indicates whether the system restarts automatically after it fails or locks.
dumptypedumptype (необязательно) Тип дампа.(optional) The dump type. Сведения о поддерживаемых значениях см. в разделе Перечисление CrashDumpType.For the supported values, see the CrashDumpType Enumeration.
maxdumpcountmaxdumpcount (необязательно) Максимальное количество дампов для сохранения.(optional) The maximum number of dumps to save.
перезаписьoverwrite (необязательно) True или false.(optional) True of false. Указывает, следует ли перезаписывать старые дампы, если достигнут предел счетчика дампов, указанный в параметре maxdumpcount.This indicates whether or not to overwrite old dumps when the dump counter limit specified by maxdumpcount has been reached.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • Интернет вещейIoT

Трассировка событий WindowsETW


Создание сеанса трассировки событий Windows по веб-сокету в режиме реального времениCreate a realtime ETW session over a websocket

ЗапросRequest

Можно создать сеанс трассировки событий Windows в режиме реального времени, используя следующий формат запроса.You can create a realtime ETW session by using the following request format. Процесс будет управляться по веб-сокету.This will be managed over a websocket. События трассировки событий Windows упаковываются на сервере и отправляются клиенту раз в секунду.ETW events are batched on the server and sent to the client once per second.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GET/WebSocketGET/WebSocket /api/etw/session/realtime/api/etw/session/realtime

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ включает события трассировки событий Windows от включенных поставщиков.The response includes the ETW events from the enabled providers. Команды WebSocket трассировки событий Windows представлены ниже.See ETW WebSocket commands below.

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Команды WebSocket трассировки событий WindowsETW WebSocket commands

Эти команды отправляются с клиента на сервер.These commands are sent from the client to the server.

КомандаCommand ОписаниеDescription
включение {level} поставщика {guid}provider {guid} enable {level} Включите поставщик, отмеченный {guid} , (без кавычек) на указанном уровне.Enable the provider marked by {guid} (without brackets) at the specified level. {level} является int от 1 (наименьшее количество подробных данных) до 5 (подробные данные).{level} is an int from 1 (least detail) to 5 (verbose).
отключение поставщика {guid}provider {guid} disable Включите поставщик, отмеченный {guid} (без кавычек).Disable the provider marked by {guid} (without brackets).

Эти ответы отправляются с сервера клиенту.This responses is sent from the server to the client. Этот код отправляется в виде текста и вы получаете следующий формат путем синтаксического анализа JSON.This is sent as text and you get the following format by parsing the JSON.

{
    "Events":[
        {
            "Timestamp": int,
            "ProviderName": string,
            "ID": int, 
            "TaskName": string,
            "Keyword": int,
            "Level": int,
            payload objects...
        },...
    ],
    "Frequency": int
}

Объекты полезных данных представляют собой дополнительные пары «ключ-значение» (string:string), предоставляемые в исходном событии трассировки событий Windows.Payload objects are extra key-value pairs (string:string) that are provided in the original ETW event.

Пример:Example:

{
    "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"
}

Перечисление зарегистрированных поставщиков трассировки событий WindowsEnumerate the registered ETW providers

ЗапросRequest

Можно перечислить зарегистрированных поставщиков, используя следующий формат запроса.You can enumerate through the registered providers by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/etw/providers/api/etw/providers

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ включает список поставщиков трассировки событий Windows.The response includes the list of ETW providers. Список будет содержать понятное имя и идентификатор GUID для каждого поставщика в следующем формате.The list will include the friendly name and GUID for each provider in the following format.

{"Providers": [
    {
        "GUID": string, (GUID)
        "Name": string
    },...
]}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Вывод списка настраиваемых поставщиков трассировки событий Windows, предоставляемых платформой.Enumerate the custom ETW providers exposed by the platform.

ЗапросRequest

Можно перечислить зарегистрированных поставщиков, используя следующий формат запроса.You can enumerate through the registered providers by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/etw/customproviders/api/etw/customproviders

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

200 OK.200 OK. Ответ включает список поставщиков трассировки событий Windows.The response includes the list of ETW providers. Список включает понятное имя и идентификатор GUID для каждого поставщика.The list will include the friendly name and GUID for each provider.

{"Providers": [
    {
        "GUID": string, (GUID)
        "Name": string
    },...
]}

Код состоянияStatus code

  • Стандартные коды состояния.Standard status codes.

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

РасположениеLocation


Получение режима переопределения расположенияGet location override mode

ЗапросRequest

Вы можете получить состояние переопределения стека расположения устройства, используя следующий формат запроса.You can get the device's location stack override status by using the following request format. Для успешного выполнения этого вызова необходимо включить режим разработчика.Developer mode must be on for this call to succeed.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /ext/location/override/ext/location/override

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ содержит состояние переопределения устройства в следующем формате.The response includes the override state of the device in the following format.

{"Override" : bool}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Получение режима переопределения расположенияSet location override mode

ЗапросRequest

Вы можете определить состояние переопределения стека расположения устройства, используя следующий формат запроса.You can set the device's location stack override status by using the following request format. Если этот параметр включен, стек расположения допускает внедрение положения.When enabled, the location stack allows position injection. Для успешного выполнения этого вызова необходимо включить режим разработчика.Developer mode must be on for this call to succeed.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
PUTPUT /ext/location/override/ext/location/override

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

{"Override" : bool}

ОтветResponse

Ответ содержит настроенное для устройства состояние переопределения в следующем формате.The response includes the override state that the device has been set to in the following format.

{"Override" : bool}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Получение внедренного положенияGet the injected position

ЗапросRequest

Вы можете получить внедренное (подмененное) расположение устройства, используя следующий формат запроса.You can get the device's injected (spoofed) location by using the following request format. Если внедренное расположение не установлено, появится сообщение об ошибке.An injected location must be set, or an error will be thrown.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /ext/location/position/ext/location/position

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ содержит текущие внедренные значения широты и долготы в следующем формате.The response includes the current injected latitude and longitude values in the following format.

{
    "Latitude" : double,
    "Longitude" : double
}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Определение внедренного положенияSet the injected position

ЗапросRequest

Вы можете определить внедренное (подмененное) расположение устройства, используя следующий формат запроса.You can set the device's injected (spoofed) location by using the following request format. На устройстве должен быть включен режим переопределения расположения, а заданное расположение должно быть допустимым, иначе появится сообщение об ошибке.Location override mode must first be enabled on the device, and the set location must be a valid location or an error will be thrown.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
PUTPUT /ext/location/override/ext/location/override

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

{
    "Latitude" : double,
    "Longitude" : double
}

ОтветResponse

Ответ содержит заданное расположение в следующем формате.The response includes the location that has been set in the following format.

{
    "Latitude" : double,
    "Longitude" : double
}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Сведения об ОСOS information


Получение имени компьютераGet the machine name

ЗапросRequest

Имя компьютера можно получить, используя следующий формат запроса.You can get the name of a machine by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/os/machinename/api/os/machinename

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ содержит имя компьютера в следующем формате.The response includes the computer name in the following format.

{"ComputerName": string}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Получение сведений об операционной системеGet the operating system information

ЗапросRequest

Сведения об ОС на компьютере можно получить, используя следующий формат запроса.You can get the OS information for a machine by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/os/info/api/os/info

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ содержит данные об операционной системе в следующем формате.The response includes the OS information in the following format.

{
    "ComputerName": string,
    "OsEdition": string,
    "OsEditionId": int,
    "OsVersion": string,
    "Platform": string
}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Определение семейства устройствGet the device family

ЗапросRequest

Семейство устройств (Xbox, телефон, настольный компьютер и т. д.) можно определить с помощью следующего формата запроса.You can get the device family (Xbox, phone, desktop, etc) using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/os/devicefamily/api/os/devicefamily

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ включает семейство устройств (SKU — настольный ПК, Xbox, и т. д.).The response includes the device family (SKU - Desktop, Xbox, etc).

{
   "DeviceType" : string
}

Параметр DeviceType имеет значения Windows.Xbox, Windows.Desktop и т. д.DeviceType will look like "Windows.Xbox", "Windows.Desktop", etc.

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Определение имени компьютераSet the machine name

ЗапросRequest

Имя компьютера можно задать, используя следующий формат запроса.You can set the name of a machine by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/os/machinename/api/os/machinename

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
namename (необходимо) Новое имя компьютера.(required) The new name for the machine. Должно быть закодировано в формате base64.This should be base64 encoded.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Информация о пользователеUser information


Получение активного пользователяGet the active user

ЗапросRequest

Вы можете получить имя активного пользователя на устройстве, используя следующий формат запроса.You can get the name of the active user on the device by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/users/activeuser/api/users/activeuser

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ содержит данные о пользователе в следующем формате.The response includes user information in the following format.

При успешном завершении:On success:

{
    "UserDisplayName" : string, 
    "UserSID" : string
}

При сбое:On failure:

{
    "Code" : int, 
    "CodeText" : string, 
    "Reason" : string, 
    "Success" : bool
}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Данные о производительностиPerformance data


Получение списка выполняемых процессовGet the list of running processes

ЗапросRequest

Список работающих в настоящее время процессов можно получить, используя следующий формат запроса.You can get the list of currently running processes by using the following request format. Его также можно обновить до подключения WebSocket с теми же данными JSON, отправляемыми клиенту раз в секунду.this can be upgraded to a WebSocket connection as well, with the same JSON data being pushed to the client once per second.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/resourcemanager/processes/api/resourcemanager/processes
GET/WebSocketGET/WebSocket /api/resourcemanager/processes/api/resourcemanager/processes

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ включает список процессов со сведениями по каждому процессу.The response includes a list of processes with details for each process. Информация предоставляется в формате JSON и имеет следующий шаблон.The information is in JSON format and has the following template.

{"Processes": [
    {
        "CPUUsage": float,
        "ImageName": string,
        "PageFileUsage": long,
        "PrivateWorkingSet": long,
        "ProcessId": int,
        "SessionId": int,
        "UserName": string,
        "VirtualSize": long,
        "WorkingSetSize": long
    },...
]}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Получение статистики производительности системыGet the system performance statistics

ЗапросRequest

Статистику производительности системы можно получить с помощью следующего формата запроса.You can get the system performance statistics by using the following request format. Сюда входит такая информация, как циклы чтения и записи, а также сведения об использовании памяти.This includes information such as read and write cycles and how much memory has been used.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/resourcemanager/systemperf/api/resourcemanager/systemperf
GET/WebSocketGET/WebSocket /api/resourcemanager/systemperf/api/resourcemanager/systemperf

Также можно обновить до подключения WebSocket.This can also be upgraded to a WebSocket connection. Оно предоставляет одинаковые данные JSON, представленные ниже, один раз в секунду.It provides the same JSON data below once every second.

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ включает статистику производительности системы, например использование ЦП и GPU, доступ к памяти и доступ к сети.The response includes the performance statistics for the system such as CPU and GPU usage, memory access, and network access. Эта информация предоставляется в формате JSON и имеет следующий шаблон.This information is in JSON format and has the following template.

{
    "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
    }
}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

МощныйPower


Получение текущего состояния аккумулятораGet the current battery state

ЗапросRequest

Данные о текущем состоянии аккумулятора можно получить, используя следующий формат запроса.You can get the current state of the battery by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/power/battery/api/power/battery

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Текущая информация о состоянии батареи возвращается в следующем формате.The current battery state information is returned using the following format.

{
    "AcOnline": int (0 | 1),
    "BatteryPresent": int (0 | 1),
    "Charging": int (0 | 1),
    "DefaultAlert1": int,
    "DefaultAlert2": int,
    "EstimatedTime": int,
    "MaximumCapacity": int,
    "RemainingCapacity": int
}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Получение активной схемы питанияGet the active power scheme

ЗапросRequest

Данные об активной схеме питания можно получить, используя следующий формат запроса.You can get the active power scheme by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/power/activecfg/api/power/activecfg

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Активная схема питания имеет следующий формат.The active power scheme has the following format.

{"ActivePowerScheme": string (guid of scheme)}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • Интернет вещейIoT

Получение вспомогательного значения для схемы питанияGet the sub-value for a power scheme

ЗапросRequest

Данные о вспомогательном значении для схемы питания можно получить, используя следующий формат запроса.You can get the sub-value for a power scheme by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/power/cfg/ /api/power/cfg/

Параметры:Options:

  • SCHEME_CURRENTSCHEME_CURRENT

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

Полный список доступных состояний питания предоставляется по количеству приложений и в соответствии с параметрами для отметки состояний питания, таких как «низкий заряд батареи» и «почти полная разрядка батареи».A full listing of power states available is on a per-application basis and the settings for flagging various power states like low and critical batterty.

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • Интернет вещейIoT

Получение состояния питания системыGet the power state of the system

ЗапросRequest

Состояние питания системы можно проверить, используя следующий формат запроса.You can check the power state of the system by using the following request format. Это позволяет проверить, находится ли устройство в состоянии низкого энергопотребления.This will let you check to see if it is in a low power state.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/power/state/api/power/state

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Данные о состоянии питания имеют следующий шаблон.The power state information has the following template.

{"LowPowerState" : false, "LowPowerStateAvailable" : true }

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Определение активной схемы питанияSet the active power scheme

ЗапросRequest

Активную схему питания можно задать, используя следующий формат запроса.You can set the active power scheme by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/power/activecfg/api/power/activecfg

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
схемаscheme (необходимо) Индикатор GUID для схемы, которую следует задать в качестве активной схемы электропитания для системы.(required) The GUID of the scheme you want to set as the active power scheme for the system.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • Интернет вещейIoT

Определение вспомогательного значения для схемы питанияSet the sub-value for a power scheme

ЗапросRequest

Вспомогательное значение для схемы питания можно установить, используя следующий формат запроса.You can set the sub-value for a power scheme by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/power/cfg/ /api/power/cfg/

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
valueACvalueAC (необходимо) Значение, используемое для питания переменного тока.(required) The value to use for A/C power.
valueDCvalueDC (необходимо) Значение, используемое для питания от аккумулятора.(required) The value to use for battery power.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • Интернет вещейIoT

Получение отчета изучения спящего режимаGet a sleep study report

ЗапросRequest

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/power/sleepstudy/report/api/power/sleepstudy/report

Отчет изучения спящего режима можно получить, используя следующий формат запроса.You can get a sleep study report by using the following request format.

Параметры URIURI parameters | Параметр универсального кода ресурса (URI)URI parameter | ОписаниеDescription | | :------ | :------ | | имя_файлаFileName | (необходимо) Полное имя файла, который необходимо скачать.(required) The full name for the file you want to download. Это значение должно кодироваться в hex64.This value should be hex64 encoded. |

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ — это файл, содержащий изучение спящего режима.The response is a file containing the sleep study.

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • Интернет вещейIoT

Перечисление доступных отчетов изучения спящего режимаEnumerate the available sleep study reports

ЗапросRequest

Доступные отчеты изучения спящего режима можно перечислить, используя следующий формат запроса.You can enumerate the available sleep study reports by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/power/sleepstudy/reports/api/power/sleepstudy/reports

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Список доступных отчетов имеет следующий шаблон.The list of available reports has the following template.

{"Reports": [
    {
        "FileName": string
    },...
]}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • Интернет вещейIoT

Получение преобразования изучения спящего режимаGet the sleep study transform

ЗапросRequest

Преобразование изучения спящего режима можно получить, используя следующий формат запроса.You can get the sleep study transform by using the following request format. Этим преобразованием является XSLT для преобразования отчета изучения спящего режима в XML-формат, который может быть прочитан любым пользователем.This transform is an XSLT that converts the sleep study report into an XML format that can be read by a person.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/power/sleepstudy/transform/api/power/sleepstudy/transform

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ содержит преобразование изучения спящего режима.The response contains the sleep study transform.

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • Интернет вещейIoT

Удаленное управлениеRemote control


Перезапуск целевого компьютераRestart the target computer

ЗапросRequest

Можно перезапустить целевой компьютер, используя следующий формат запроса.You can restart the target computer by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/control/restart/api/control/restart

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Завершение работы на целевом компьютереShut down the target computer

ЗапросRequest

Завершить работу целевого компьютера можно с помощью следующего формата запроса.You can shut down the target computer by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/control/shutdown/api/control/shutdown

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Диспетчер задачTask manager


Запуск современного приложенияStart a modern app

ЗапросRequest

Современное приложение можно запустить с помощью следующего формата запроса.You can start a modern app by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/taskmanager/app/api/taskmanager/app

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
appidappid (необходимо) PRAID для приложения, которое необходимо запустить.(required) The PRAID for the app you want to start. Это значение должно кодироваться в hex64.This value should be hex64 encoded.
Пакетpackage (необходимо) Полное имя пакета приложения, которое необходимо запустить.(required) The full name for the app package you want to start. Это значение должно кодироваться в hex64.This value should be hex64 encoded.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Остановка современного приложенияStop a modern app

ЗапросRequest

Современное приложение можно остановить с помощью следующего формата запроса.You can stop a modern app by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
DELETEDELETE /api/taskmanager/app/api/taskmanager/app

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
Пакетpackage (необходимо) Полное имя пакетов приложений, которые необходимо остановить.(required) The full name of the app packages that you want to stop. Это значение должно кодироваться в hex64.This value should be hex64 encoded.
forcestopforcestop (необязательно) Значение да указывает, что система должна принудительно останавливать все процессы.(optional) A value of yes indicates that the system should force all processes to stop.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Завершение процесса, определенного по идентификатору процессаKill process by PID

ЗапросRequest

Процесс можно завершить, используя следующий формат запроса.You can kill a process by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
DELETEDELETE /api/taskmanager/process/api/taskmanager/process

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
pidpid (Обязательный. ) Уникальный идентификатор процесса, который требуется остановить.(required) The unique process id for the process to stop.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

сеть;Networking


Получение текущей конфигурации IPGet the current IP configuration

ЗапросRequest

Текущую конфигурацию IP можно получить, используя следующий формат запроса.You can get the current IP configuration by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/networking/ipconfig/api/networking/ipconfig

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Ответ содержит конфигурацию IP в следующем формате.The response includes the IP configuration in the following template.

{"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"
            },...
        ]
    },...
]}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Настройка статического IP-адреса (конфигурация IPV4)Set a static IP address (IPV4 configuration)

ЗапросRequest

Настраивает статический IP-адрес и параметры DNS для конфигурации IPV4.Sets the IPV4 configuration with static IP and DNS. Если статический IP-адрес не указан, включает DHCP.If a static IP is not specified, then it enables DHCP. Если статический IP-адрес указан, должен быть указан и сервер DNS.If a static IP is specified, then DNS must be specified also.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
PUTPUT /api/networking/ipv4config/api/networking/ipv4config

Параметры URIURI parameters

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
AdapterNameAdapterName (Обязательный. ) GUID сетевого интерфейса.(required) The network interface GUID.
IPAddressIPAddress Статический IP-адрес, который нужно настроить.The static IP address to set.
SubnetMaskSubnetMask (Обязательный, если IPAddress имеет отличающееся от NULL значение.) Статическая маска подсети.(required if IPAddress is not null) The static subnet mask.
DefaultGatewayDefaultGateway (Обязательный, если IPAddress имеет отличающееся от NULL значение.) Статический шлюз по умолчанию.(required if IPAddress is not null) The static default gateway.
PrimaryDNSPrimaryDNS (Обязательный, если IPAddress имеет отличающееся от NULL значение.) Статический адрес основного сервера DNS.(required if IPAddress is not null) The static primary DNS to set.
SecondayDNSSecondayDNS (Обязательный, если PrimaryDNS имеет отличающееся от NULL значение.) Статический адрес дополнительного сервера DNS.(required if PrimaryDNS is not null) The static secondary DNS to set.

Помните, что для настройки DHCP в интерфейсе нужно сериализовать только AdapterName:For clarity, to set an interface to DHCP, serialize just the AdapterName on the wire:

{
    "AdapterName":"{82F86C1B-2BAE-41E3-B08D-786CA44FEED7}"
}

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Перечисление интерфейсов беспроводной сетиEnumerate wireless network interfaces

ЗапросRequest

Доступные интерфейсы беспроводной сети можно перечислять, используя следующий формат запроса.You can enumerate the available wireless network interfaces by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/wifi/interfaces/api/wifi/interfaces

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Список доступных беспроводных интерфейсов с подробными сведениями имеет следующий формат.A list of the available wireless interfaces with details in the following format.

{"Interfaces": [{
    "Description": string,
    "GUID": string (guid with curly brackets),
    "Index": int,
    "ProfilesList": [
        {
            "GroupPolicyProfile": bool,
            "Name": string, (Network currently connected to)
            "PerUserProfile": bool
        },...
    ]
    }
]}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Перечисление беспроводных сетейEnumerate wireless networks

ЗапросRequest

Список беспроводных сетей на указанном интерфейсе можно перечислить с помощью следующего формата запроса.You can enumerate the list of wireless networks on the specified interface by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/wifi/networks/api/wifi/networks

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
интерфейсinterface (необходимо) GUID для сетевого интерфейса для использования в целях поиска беспроводных сетей, без кавычек.(required) The GUID for the network interface to use to search for wireless networks, without brackets.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Список беспроводных сетей, найденных на указанном интерфейсе.The list of wireless networks found on the provided interface. Сюда относятся сведения о сетях в следующем формате.This includes details for the networks in the following format.

{"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,...]
    },...
]}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Подключение и отключение к сети Wi-Fi.Connect and disconnect to a Wi-Fi network.

ЗапросRequest

Подключиться к сети Wi-Fi или отключиться от нее можно с помощью следующего формата запроса.You can connect or disconnect to a Wi-Fi network by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/wifi/network/api/wifi/network

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
интерфейсinterface (необходимо) GUID для сетевого интерфейса, используемого для подключения к сети.(required) The GUID for the network interface you use to connect to the network.
opop (необходимо) Указывает действие, которое необходимо предпринять.(required) Indicates the action to take. Возможные значения: подключить и отключить.Possible values are connect or disconnect.
ssidssid (необходимо, если op == connect) SSID, к которому следует подключиться.(required if op == connect) The SSID to connect to.
keykey (Обязательный, если у параметра op значение connect и сеть требует проверку подлинности. ) Общий ключ.(required if op == connect and network requires authentication) The shared key.
createprofilecreateprofile (необходимо) Создайте профиль для сети на устройстве.(required) Create a profile for the network on the device. В результате устройство будет автоматически подключаться к сети.This will cause the device to auto-connect to the network in the future. Этим значением может быть yes (да) или no (нет) .This can be yes or no.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Удаление профиля Wi-FiDelete a Wi-Fi profile

ЗапросRequest

Профиль, связанный с сетью на определенном интерфейсе, можно удалить с помощью следующего формата запросов.You can delete a profile associated with a network on a specific interface by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
DELETEDELETE /api/wifi/profile/api/wifi/profile

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
интерфейсinterface (необходимо) GUID для сетевого интерфейса, связанного с удаляемым профилем.(required) The GUID for the network interface associated with the profile to delete.
профильprofile (необходимо) Имя профиля для удаления.(required) The name of the profile to delete.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Отчеты об ошибках Windows (WER)Windows Error Reporting (WER)


Загрузка файла отчета об ошибках Windows (WER)Download a Windows error reporting (WER) file

ЗапросRequest

Файл WER можно скачать с помощью следующего формата запроса.You can download a WER-related file by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/wer/report/file/api/wer/report/file

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
пользовательuser (необходимо) Имя пользователя, связанное с отчетом.(required) The user name associated with the report.
typetype (необходимо) Тип отчета.(required) The type of report. Это может быть или в очереди, или в архиве.This can be either queried or archived.
namename (необходимо) Имя отчета.(required) The name of the report. Должно быть закодировано в формате base64.This should be base64 encoded.
filefile (необходимо) Имя файла для загрузки из отчета.(required) The name of the file to download from the report. Должно быть закодировано в формате base64.This should be base64 encoded.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • Ответ содержит запрошенный файл.Response contains the requested file.

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Перечисление файлов в отчете об ошибках Windows (WER)Enumerate files in a Windows error reporting (WER) report

ЗапросRequest

Файлы в отчете WER можно перечислить с помощью следующего формата запроса.You can enumerate the files in a WER report by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/wer/report/files/api/wer/report/files

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
пользовательuser (необходимо) Пользователь, связанный с отчетом.(required) The user associated with the report.
typetype (необходимо) Тип отчета.(required) The type of report. Это может быть или в очереди, или в архиве.This can be either queried or archived.
namename (необходимо) Имя отчета.(required) The name of the report. Должно быть закодировано в формате base64.This should be base64 encoded.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

{"Files": [
    {
        "Name": string, (Filename, not base64 encoded)
        "Size": int (bytes)
    },...
]}

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Список отчетов об ошибках Windows (WER)List the Windows error reporting (WER) reports

ЗапросRequest

Отчеты WER можно получить с помощью следующего формата запроса.You can get the WER reports by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/wer/reports/api/wer/reports

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Отчеты WER в следующем формате.The WER reports in the following format.

{"WerReports": [
    {
        "User": string,
        "Reports": [
            {
                "CreationTime": int,
                "Name": string, (not base64 encoded)
                "Type": string ("Queue" or "Archive")
            },
    },...
]}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Windows Performance Recorder (WPR)Windows Performance Recorder (WPR)


Запуск трассировки с использованием пользовательского профиляStart tracing with a custom profile

ЗапросRequest

Можно передать профиль WPR и запустить трассировку с использованием этого профиля, используя следующий формат запроса.You can upload a WPR profile and start tracing using that profile by using the following request format. Одновременно может выполняться только одна трассировка.Only one trace can run at a time. Профиль не останется на устройстве.The profile will not remain on the device.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/wpr/customtrace/api/wpr/customtrace

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • Многокомпонентная основная часть http, которая содержит пользовательский профиль WPR.A multi-part conforming http body that contains the custom WPR profile.

ОтветResponse

Состояние сеанса WPR в следующем формате.The WPR session status in the following format.

{
    "SessionType": string, (Running or Idle) 
    "State": string (normal or boot)
}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Начало сеанса трассировки производительности загрузкиStart a boot performance tracing session

ЗапросRequest

Можно запустить сеанс трассировки WPR с использованием следующего формата запроса.You can start a boot WPR tracing session by using the following request format. Этот сеанс также называется сеансом трассировки производительности.This is also known as a performance tracing session.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/wpr/boottrace/api/wpr/boottrace

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
профильprofile (необходимо) Этот параметр требуется при запуске.(required) This parameter is required on start. Имя профиля, который должен запускать сеанс трассировки производительности.The name of the profile that should start a performance tracing session. Возможные профили сохраняются в perfprofiles/profiles.json.The possible profiles are stored in perfprofiles/profiles.json.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Сначала этот API-интерфейс возвращает состояние сеанса WPR в следующем формате.On start, this API returns the WPR session status in the following format.

{
    "SessionType": string, (Running or Idle) 
    "State": string (boot)
}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Остановка сеанса трассировки производительности загрузкиStop a boot performance tracing session

ЗапросRequest

Можно остановить сеанс трассировки WPR с использованием следующего формата запроса.You can stop a boot WPR tracing session by using the following request format. Этот сеанс также называется сеансом трассировки производительности.This is also known as a performance tracing session.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/wpr/boottrace/api/wpr/boottrace

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • Нет.None. Примечание. Эта операция выполняется долго.Note: This is a long running operation. Значение возвращается, после того как ETL завершит запись на диск.It will return when the ETL is finished writing to disk.

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Запуск сеанса трассировки производительностиStart a performance tracing session

ЗапросRequest

Можно запустить сеанс трассировки WPR с использованием следующего формата запроса.You can start a WPR tracing session by using the following request format. Этот сеанс также называется сеансом трассировки производительности.This is also known as a performance tracing session. Одновременно может выполняться только одна трассировка.Only one trace can run at a time.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/wpr/trace/api/wpr/trace

Параметры URIURI parameters

В запросе URI можно указать следующие дополнительные параметры.You can specify the following additional parameters on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
профильprofile (необходимый) Имя профиля, который должен запускать сеанс трассировки производительности.(required) The name of the profile that should start a performance tracing session. Возможные профили сохраняются в perfprofiles/profiles.json.The possible profiles are stored in perfprofiles/profiles.json.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Сначала этот API-интерфейс возвращает состояние сеанса WPR в следующем формате.On start, this API returns the WPR session status in the following format.

{
    "SessionType": string, (Running or Idle) 
    "State": string (normal)
}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Остановка сеанса трассировки производительностиStop a performance tracing session

ЗапросRequest

Можно остановить сеанс трассировки WPR с использованием следующего формата запроса.You can stop a WPR tracing session by using the following request format. Этот сеанс также называется сеансом трассировки производительности.This is also known as a performance tracing session.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/wpr/trace/api/wpr/trace

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • Нет.None. Примечание. Эта операция выполняется долго.Note: This is a long running operation. Значение возвращается, после того как ETL завершит запись на диск.It will return when the ETL is finished writing to disk.

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Получение состояния сеанса трассировкиRetrieve the status of a tracing session

ЗапросRequest

Состояние текущего сеанса WPR можно получить с помощью следующего формата запроса.You can retrieve the status of the current WPR session by using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/wpr/status/api/wpr/status

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Состояние сеанса трассировки WPR в следующем формате.The status of the WPR tracing session in the following format.

{
    "SessionType": string, (Running or Idle) 
    "State": string (normal or boot)
}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Список завершенных сеансов трассировки (ETL)List completed tracing sessions (ETLs)

ЗапросRequest

Список трассировок ETL на устройстве можно получить, используя следующий формат запроса.You can get a listing of ETL traces on the device using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/wpr/tracefiles/api/wpr/tracefiles

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Список завершенных сеансов трассировки предоставляется в следующем формате.The listing of completed tracing sessions is provided in the following format.

{"Items": [{
    "CurrentDir": string (filepath),
    "DateCreated": int (File CreationTime),
    "FileSize": int (bytes),
    "Id": string (filename),
    "Name": string (filename),
    "SubPath": string (filepath),
    "Type": int
}]}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Загрузка сеанса трассировки (ETL)Download a tracing session (ETL)

ЗапросRequest

Файл трассировки (трассировка загрузки или трассировка в режиме пользователя) можно загрузить с помощью следующего формата запроса.You can download a tracefile (boot trace or user-mode trace) using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/wpr/tracefile/api/wpr/tracefile

Параметры URIURI parameters

В URI запроса можно указать следующий дополнительный параметр.You can specify the following additional parameter on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
имя_файлаfilename (Обязательный) Имя загружаемого файла трассировки ETL.(required) The name of the ETL trace to download. Его можно найти, используя путь /api/wpr/tracefilesThese can be found in /api/wpr/tracefiles

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • Возвращает ETL-файл трассировки.Returns the trace ETL file.

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Удаление сеанса трассировки (ETL)Delete a tracing session (ETL)

ЗапросRequest

Файл трассировки (трассировка загрузки или трассировка в режиме пользователя) можно удалить с помощью следующего формата запроса.You can delete a tracefile (boot trace or user-mode trace) using the following request format.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
DELETEDELETE /api/wpr/tracefile/api/wpr/tracefile

Параметры URIURI parameters

В URI запроса можно указать следующий дополнительный параметр.You can specify the following additional parameter on the request URI:

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
имя_файлаfilename (Обязательный) Имя удаляемого файла трассировки ETL.(required) The name of the ETL trace to delete. Его можно найти, используя путь /api/wpr/tracefilesThese can be found in /api/wpr/tracefiles

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • Возвращает ETL-файл трассировки.Returns the trace ETL file.

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • Интернет вещейIoT

Теги DNS-SDDNS-SD Tags


Просмотр теговView Tags

ЗапросRequest

Просмотр применяемых в настоящее время к устройству тегов.View the currently applied tags for the device. Они объявляются с помощью записей DNS-SD TXT в ключе T.These are advertised via DNS-SD TXT records in the T key.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/dns-sd/tags/api/dns-sd/tags

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

Ответ Применяемые сейчас теги в следующем формате.Response The currently applied tags in the following format.

 {
    "tags": [
        "tag1", 
        "tag2", 
        ...
     ]
}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
5XX5XX Ошибка сервераServer Error

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Удаление теговDelete Tags

ЗапросRequest

Удаление всех тегов, объявленных DNS-SD в настоящее время.Delete all tags currently advertised by DNS-SD.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
DELETEDELETE /api/dns-sd/tags/api/dns-sd/tags

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
5XX5XX Ошибка сервераServer Error

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Удаление тегаDelete Tag

ЗапросRequest

Удаление тега, объявленного DNS-SD в настоящее время.Delete a tag currently advertised by DNS-SD.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
DELETEDELETE /api/dns-sd/tag/api/dns-sd/tag

Параметры URIURI parameters

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
tagValuetagValue (обязательно) Тег, который необходимо удалить.(required) The tag to be removed.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Добавление тегаAdd a Tag

ЗапросRequest

Добавление тега в объявление DNS-SD.Add a tag to the DNS-SD advertisement.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/dns-sd/tag/api/dns-sd/tag

Параметры URIURI parameters

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
tagValuetagValue (обязательно) Тег, который необходимо добавить.(required) The tag to be added.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
401401 Переполнение пространства тегов.Tag space Overflow. Появляется, если длина предлагаемого тега слишком велика для получаемой записи службы DNS-SD.Results when the proposed tag is too long for the resulting DNS-SD service record.

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • XboxXbox
  • HoloLensHoloLens
  • Интернет вещейIoT

Проводник приложенийApp File Explorer


Получение известных папокGet known folders

ЗапросRequest

Получение списка доступных папок верхнего уровня.Obtain a list of accessible top-level folders.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/filesystem/apps/knownfolders/api/filesystem/apps/knownfolders

Параметры URIURI parameters

  • НетNone

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

Ответ: доступные папки в следующем формате.Response The available folders in the following format.

 {"KnownFolders": [
    "folder0",
    "folder1",...
]}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 Принятый и обрабатываемый запрос на развертываниеDeploy request accepted and being processed
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • XboxXbox
  • Интернет вещейIoT

Получение файловGet files

ЗапросRequest

Получение списка файлов в папке.Obtain a list of files in a folder.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/filesystem/apps/files/api/filesystem/apps/files

Параметры URIURI parameters

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
knownfolderidknownfolderid (обязательно) Каталог верхнего уровня, для которого требуется список файлов.(required) The top-level directory where you want the list of files. Использование LocalAppData для доступа в неопубликованные приложения.Use LocalAppData for access to sideloaded apps.
packagefullnamepackagefullname (Обязательный, если у параметра knownfolderid значение LocalAppData. ) Полное имя пакета интересующего вас приложения.(required if knownfolderid == LocalAppData) The package full name of the app you are interested in.
путьpath (необязательно) Вложенный каталог в папке или пакете, указанном выше.(optional) The sub-directory within the folder or package specified above.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

Ответ: доступные папки в следующем формате.Response The available folders in the following format.

{"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
    },...
]}

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • XboxXbox
  • Интернет вещейIoT

Загрузка файлаDownload a file

ЗапросRequest

Получение файла из известной папки или каталога appLocalData.Obtain a file from a known folder or appLocalData.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
GETGET /api/filesystem/apps/file/api/filesystem/apps/file

Параметры URIURI parameters

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
knownfolderidknownfolderid (обязательно) Каталог верхнего уровня, в который требуется скачать файлы.(required) The top-level directory where you want to download files. Использование LocalAppData для доступа в неопубликованные приложения.Use LocalAppData for access to sideloaded apps.
имя_файлаfilename (обязательно) Имя скачиваемого файла.(required) The name of the file being downloaded.
packagefullnamepackagefullname (Обязательный, если у параметра knownfolderid значение LocalAppData) Полное имя интересующего вас пакета.(required if knownfolderid == LocalAppData) The package full name you are interested in.
путьpath (необязательно) Вложенный каталог в папке или пакете, указанном выше.(optional) The sub-directory within the folder or package specified above.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • Запрошенный файл, при наличииThe file requested, if present

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 Запрошенный файлThe requested file
404404 Файл не найденFile not found
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • XboxXbox
  • Интернет вещейIoT

Переименуйте файлRename a file

ЗапросRequest

Переименование файла в папке.Rename a file in a folder.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/filesystem/apps/rename/api/filesystem/apps/rename

Параметры URIURI parameters

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
knownfolderidknownfolderid (обязательно) Каталог верхнего уровня, где находится файл.(required) The top-level directory where the file is located. Использование LocalAppData для доступа в неопубликованные приложения.Use LocalAppData for access to sideloaded apps.
имя_файлаfilename (обязательно) Исходное имя переименуемого файла.(required) The original name of the file being renamed.
newfilenamenewfilename (обязательно) Новое имя файла.(required) The new name of the file.
packagefullnamepackagefullname (Обязательный, если у параметра knownfolderid значение LocalAppData. ) Полное имя пакета интересующего вас приложения.(required if knownfolderid == LocalAppData) The package full name of the app you are interested in.
путьpath (необязательно) Вложенный каталог в папке или пакете, указанном выше.(optional) The sub-directory within the folder or package specified above.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK .. Файл переименованThe file is renamed
404404 Файл не найденFile not found
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • XboxXbox
  • Интернет вещейIoT

Удаление файлаDelete a file

ЗапросRequest

Удаление файла в папке.Delete a file in a folder.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
DELETEDELETE /api/filesystem/apps/file/api/filesystem/apps/file

Параметры URIURI parameters

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
knownfolderidknownfolderid (обязательно) Каталог верхнего уровня, в котором требуется удалить файлы.(required) The top-level directory where you want to delete files. Использование LocalAppData для доступа в неопубликованные приложения.Use LocalAppData for access to sideloaded apps.
имя_файлаfilename (обязательно) Имя удаляемого файла.(required) The name of the file being deleted.
packagefullnamepackagefullname (Обязательный, если у параметра knownfolderid значение LocalAppData. ) Полное имя пакета интересующего вас приложения.(required if knownfolderid == LocalAppData) The package full name of the app you are interested in.
путьpath (необязательно) Вложенный каталог в папке или пакете, указанном выше.(optional) The sub-directory within the folder or package specified above.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

  • НетNone

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK .. Файл удаленThe file is deleted
404404 Файл не найденFile not found
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • XboxXbox
  • Интернет вещейIoT

Отправка файлаUpload a file

ЗапросRequest

Отправка файла в папку.Upload a file to a folder. При этом производится запись поверх существующего файла с тем же именем, но новые папки не создаются.This will overwrite an existing file with the same name, but will not create new folders.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST /api/filesystem/apps/file/api/filesystem/apps/file

Параметры URIURI parameters

Параметр универсального кода ресурса (URI)URI parameter ОписаниеDescription
knownfolderidknownfolderid (обязательно) Каталог верхнего уровня, в который требуется отправить файлы.(required) The top-level directory where you want to upload files. Использование LocalAppData для доступа в неопубликованные приложения.Use LocalAppData for access to sideloaded apps.
packagefullnamepackagefullname (Обязательный, если у параметра knownfolderid значение LocalAppData. ) Полное имя пакета интересующего вас приложения.(required if knownfolderid == LocalAppData) The package full name of the app you are interested in.
путьpath (необязательно) Вложенный каталог в папке или пакете, указанном выше.(optional) The sub-directory within the folder or package specified above.

Заголовки запросаRequest headers

  • НетNone

Текст запросаRequest body

  • НетNone

ОтветResponse

Код состоянияStatus code

Этот API имеет следующие предполагаемые коды состояния.This API has the following expected status codes.

Код состояния HTTPHTTP status code ОписаниеDescription
200200 ОКOK .. Файл отправленThe file is uploaded
4XX4XX Коды ошибокError codes
5XX5XX Коды ошибокError codes

Доступные семейства устройствAvailable device families

  • Windows MobileWindows Mobile
  • Настольный компьютер с WindowsWindows Desktop
  • HoloLensHoloLens
  • XboxXbox
  • Интернет вещейIoT