裝置入口網站 API 參照Device portal API reference

Windows 裝置入口網站中的所有專案都建置於 REST API 的之上,您可以用來以程式設計方式存取資料和控制您的裝置。Everything in the Windows Device Portal is built on top of REST API's that you can use to access the data and control your device programmatically.

應用程式部署常見問題App deloyment

/api/app/packagemanager/package (刪除)/api/app/packagemanager/package (DELETE)

卸載應用程式Uninstalls an app

參數Parameters

  • 封裝:要卸載之封裝的檔案名。package : File name of the package to be uninstalled.

/api/app/packagemanager/package (POST)/api/app/packagemanager/package (POST)

安裝應用程式Installs an App

參數Parameters

  • 封裝:要安裝之套件的檔案名。package : File name of the package to be installed.

PayloadPayload

  • 多部分的符合 HTTP 主體multi-part conforming http body

/api/app/packagemanager/packages (取得)/api/app/packagemanager/packages (GET)

抓取系統上已安裝應用程式的清單,並提供詳細資料Retrieves the list of installed apps on the system, with details

傳回資料Return data

  • 包含詳細資料的已安裝套件清單List of installed packages with details

/api/app/packagemanager/state (取得)/api/app/packagemanager/state (GET)

取得進行中的應用程式安裝狀態Gets the status of in progress app installation

傾印集合Dump collection

/api/debug/dump/usermode/crashcontrol (刪除)/api/debug/dump/usermode/crashcontrol (DELETE)

停用側載應用程式的損毀傾印收集Disables crash dump collection for a sideloaded app

參數Parameters

  • packageFullname:套件名稱packageFullname : package name

/api/debug/dump/usermode/crashcontrol (取得)/api/debug/dump/usermode/crashcontrol (GET)

取得側載 apps 損毀傾印集合的設定Gets settings for sideloaded apps crash dump collection

參數Parameters

  • packageFullname:套件名稱packageFullname : package name

/api/debug/dump/usermode/crashcontrol (POST)/api/debug/dump/usermode/crashcontrol (POST)

啟用並設定側載應用程式的傾印控制項設定Enables and sets dump control settings for a sideloaded app

參數Parameters

  • packageFullname:套件名稱packageFullname : package name

/api/debug/dump/usermode/crashdump (刪除)/api/debug/dump/usermode/crashdump (DELETE)

刪除側載應用程式的損毀傾印Deletes a crash dump for a sideloaded app

參數Parameters

  • packageFullname:套件名稱packageFullname : package name
  • 檔案名:傾印檔案名fileName : dump file name

/api/debug/dump/usermode/crashdump (取得)/api/debug/dump/usermode/crashdump (GET)

捕獲側載應用程式的損毀傾印Retrieves a crash dump for a sideloaded app

參數Parameters

  • packageFullname:套件名稱packageFullname : package name
  • 檔案名:傾印檔案名fileName : dump file name

傳回資料Return data

  • 傾印檔案。Dump file. 使用 WinDbg 或 Visual Studio 檢查Inspect with WinDbg or Visual Studio

/api/debug/dump/usermode/dumps (取得)/api/debug/dump/usermode/dumps (GET)

傳回側載 apps 的所有損毀傾印清單Returns list of all crash dumps for sideloaded apps

傳回資料Return data

  • 每一端載入的應用程式損毀傾印清單List of crash dumps per side loaded app

ETWETW

/api/etw/providers (取得)/api/etw/providers (GET)

列舉已註冊的提供者Enumerates registered providers

傳回資料Return data

  • 提供者清單、易記名稱和 GUIDList of providers, friendly name and GUID

/api/etw/session/realtime (GET/WebSocket)/api/etw/session/realtime (GET/WebSocket)

建立即時 ETW 會話;在 websocket 上進行管理。Creates a realtime ETW session; managed over a websocket.

傳回資料Return data

  • 來自已啟用提供者的 ETW 事件ETW events from the enabled providers

全像攝影版 OSHolographic OS

/api/holographic/os/etw/customproviders (取得)/api/holographic/os/etw/customproviders (GET)

傳回未向系統註冊的 HoloLens 特定 ETW 提供者清單Returns a list of HoloLens specific ETW providers that are not registered with the system

/api/holographic/os/services (取得)/api/holographic/os/services (GET)

傳回所有執行中之服務的狀態。Returns the states of all services running.

/api/holographic/os/settings/ipd (取得)/api/holographic/os/settings/ipd (GET)

取得儲存的 IPD (Interpupillary 距離) 以毫米為單位Gets the stored IPD (Interpupillary distance) in millimeters

/api/holographic/os/settings/ipd (POST)/api/holographic/os/settings/ipd (POST)

設定 IPDSets the IPD

參數Parameters

  • ipd:要設定的新 IPD 值(以毫米為單位)ipd : New IPD value to be set in millimeters

/api/holographic/os/webmanagement/settings/HTTPs (取得)/api/holographic/os/webmanagement/settings/https (GET)

取得裝置入口網站的 HTTPS 需求Get HTTPS requirements for the Device Portal

/api/holographic/os/webmanagement/settings/HTTPs (POST)/api/holographic/os/webmanagement/settings/https (POST)

設定裝置入口網站的 HTTPS 需求Sets HTTPS requirements for the Device Portal

參數Parameters

  • 必要:是、否或預設值required : yes, no or default

全像Holographic Perception

/api/holographic/perception/client (GET/WebSocket)/api/holographic/perception/client (GET/WebSocket)

接受 websocket 升級並執行感知用戶端,以 30 fps 的形式傳送更新。Accepts websocket upgrades and runs a perception client that sends updates at 30 fps.

參數Parameters

  • clientmode:「作用中」會在無法被動建立時強制視覺化追蹤模式clientmode: "active" forces visual tracking mode when it can't be established passively

全像熱Holographic Thermal

/api/holographic/thermal/stage (取得)/api/holographic/thermal/stage (GET)

取得裝置的熱階段 (0 正常、1暖、2關鍵) Get the thermal stage of the device (0 normal, 1 warm, 2 critical)

地圖管理員Map Manager

/api/holographic/mapmanager/mapFiles (取得)/api/holographic/mapmanager/mapFiles (GET)

取得可用對應檔 ( mapx) 的清單。Gets the list of the available map files (.mapx).

/api/holographic/mapmanager/anchorFiles (取得)/api/holographic/mapmanager/anchorFiles (GET)

取得可用錨定檔案 ( ancx) 的清單。Gets the list of available anchor files (.ancx).

/api/holographic/mapmanager/srdbFiles (取得)/api/holographic/mapmanager/srdbFiles (GET)

取得可用空間重建資料庫檔案 ( srdb) 的清單。Gets the list of available spatial reconstruction database files (.srdb).

/api/holographic/mapmanager/getanchors (取得)/api/holographic/mapmanager/getanchors (GET)

取得目前使用者的已保存錨點清單。Gets the list of persisted anchors for the current user.

下載/上傳/刪除檔案Download/Upload/Delete Files

/api/holographic/mapmanager/download (取得)/api/holographic/mapmanager/download (GET)

下載地圖、錨點或空間重建資料庫檔案。Downloads a map, anchor, or spatial reconstruction database file. 檔案必須先前已上傳或匯出。The file must have been previously uploaded or exported.

參數Parameters

  • 檔案名:要下載的檔案名。FileName: Name of file to download.

範例:Example:

$.post("/api/holographic/mapmanager/download?FileName=" + spaceID)

/api/holographic/mapmanager/upload (POST)/api/holographic/mapmanager/upload (POST)

上傳地圖、錨點或空間重建資料庫檔案。Uploads a map, anchor, or spatial reconstruction database file. 檔案上傳之後,稍後可以匯入以供系統使用。Once a file is uploaded it can later be imported to be used by the system.

參數Parameters

  • file:要上傳之檔案的名稱。file: Name of the file to upload.

範例:Example:

var form_data = new FormData();
form_data.append("file", file_data);

$.ajax({
    url: "/api/holographic/mapmanager/upload",
    dataType: 'json',
    cache: false,
    contentType: false,
    processData: false,
    data: form_data,
    type: 'post'
})

/api/holographic/mapmanager/delete (POST)/api/holographic/mapmanager/delete (POST)

刪除地圖、錨點或空間重建資料庫檔案。Deletes a map, anchor, or spatial reconstruction database file. 檔案必須先前已上傳或匯出。The file must have been previously uploaded or exported.

參數Parameters

  • FileName:要刪除的檔案名。FileName: Name of file to delete.

範例:Example:

$.post("/api/holographic/mapmanager/delete?FileName=" + spaceID)

匯出Export

/api/holographic/mapmanager/export (POST)/api/holographic/mapmanager/export (POST)

匯出系統目前正在使用的對應。Exports the map currently in use by the system. 一旦匯出之後,即可加以下載。Once exported, it can be downloaded.

範例:Example:

$.post("/api/holographic/mapmanager/export")

/api/holographic/mapmanager/exportanchors (POST)/api/holographic/mapmanager/exportanchors (POST)

匯出系統目前正在使用的對應。Exports the map currently in use by the system. 一旦匯出之後,即可加以下載。Once exported, it can be downloaded. 範例:Example:

$.post("/api/holographic/mapmanager/exportanchors")

/api/holographic/mapmanager/exportmapandanchors (POST)/api/holographic/mapmanager/exportmapandanchors (POST)

匯出系統目前正在使用的對應和錨點。Exports the map and anchors currently in use by the system. 一旦匯出之後,即可加以下載。Once are exported, they can be downloaded. 範例:Example:

$.post("/api/holographic/mapmanager/exportmapandanchors")

/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)/api/holographic/mapmanager/exportmapandspatialmappingdb (POST)

匯出系統目前正在使用的地圖和空間重建資料庫。Exports the map and spatial reconstruction database currently in use by the system. 一旦匯出之後,即可加以下載。Once they are exported, they can be downloaded.

範例:Example:

$.post("/api/holographic/mapmanager/exportmapandspatialmappingdb")

匯入Import

/api/holographic/mapmanager/import (POST)/api/holographic/mapmanager/import (POST)

向系統表示目前使用的對應。Indicates to the system which map should be used be currently used. 可以在已匯出或已上傳的檔案上呼叫。Can be called on files that have been exported or uploaded.

參數Parameters

  • FileName:要使用的對應名稱。FileName: Name of the map to be used.

範例:Example:

$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })

/api/holographic/mapmanager/importanchors (POST)/api/holographic/mapmanager/importanchors (POST)

向系統表示目前使用的錨點。Indicates to the system which anchors should be used be currently used. 可以在已匯出或已上傳的檔案上呼叫。Can be called on files that have been exported or uploaded.

參數Parameters

  • FileName:要使用的錨點名稱。FileName: Name of the anchors to be used.

範例:Example:

$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })

/api/holographic/mapmanager/importspatialmappingdb (POST)/api/holographic/mapmanager/importspatialmappingdb (POST)

向系統表示目前應使用的空間重建資料庫。Indicates to the system which spatial reconstruction database should be used be currently used. 可以在已匯出或已上傳的檔案上呼叫。Can be called on files that have been exported or uploaded.

參數Parameters

  • FileName:要使用之空間對應資料庫的名稱。FileName: Name of the spatial mapping db to be used.

範例:Example:

$.post("/api/holographic/mapmanager/import?FileName=" + spaceID, function() { alert("Import was successful!"); })

其他Other

/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)/api/holographic/mapmanager/resetmapandanchorsandsrdb (POST)

重設對應、錨定和空間重建資料庫的系統。Reset the system the map, anchors and spatial reconstruction database.

範例:Example:

$.post("/api/holographic/mapmanager/resetmapandanchorsandsrdb")

/api/holographic/mapmanager/status (取得)/api/holographic/mapmanager/status (GET)

取得系統的狀態,包括上次匯入的對應、錨點和空間重建資料庫檔案。Gets the status of the system, including which map, anchors, and spatial reconstruction database files that were last imported.

混合實境擷取Mixed Reality Capture

/api/holographic/mrc/file (取得)/api/holographic/mrc/file (GET)

從裝置下載混合的實際檔案。Downloads a mixed reality file from the device. 使用 op = 串流查詢參數進行串流。Use op=stream query parameter for streaming.

參數Parameters

  • 檔案名:要取得之影片檔案的名稱、hex64 編碼filename : Name, hex64 encoded, of the video file to get
  • op:資料流程op : stream

/api/holographic/mrc/file (刪除)/api/holographic/mrc/file (DELETE)

從裝置刪除混合現實記錄。Deletes a mixed reality recording from the device.

參數Parameters

  • 檔案名:要刪除之檔案的名稱、hex64 編碼filename : Name, hex64 encoded, of the file to delete

/api/holographic/mrc/files (取得)/api/holographic/mrc/files (GET)

傳回儲存在裝置上的混合現實檔案清單Returns the list of mixed reality files stored on the device

/api/holographic/mrc/photo (POST)/api/holographic/mrc/photo (POST)

採用混合的現實照片,並在裝置上建立檔案Takes a mixed reality photo and creates a file on the device

參數Parameters

  • hololens:抓取全像: true 或 false (預設為 false) holo : capture holograms: true or false (defaults to false)
  • pv: capture PV 攝影機: true 或 false (預設為 false) pv : capture PV camera: true or false (defaults to false)
  • RenderFromCamera: (只 HoloLens 2) 從相片/攝影機的觀點轉譯: true 或 false (預設為 true) RenderFromCamera : (HoloLens 2 only) render from perspective of photo/video camera: true or false (defaults to true)

/api/holographic/mrc/settings (取得)/api/holographic/mrc/settings (GET)

取得預設的混合現實捕獲設定Gets the default mixed reality capture settings

/api/holographic/mrc/settings (POST)/api/holographic/mrc/settings (POST)

設定預設的混合現實捕獲設定。Sets the default mixed reality capture settings. 其中某些設定會套用到系統的 MRC 照片和影片捕捉。Some of these settings are applied to the system's MRC photo and video capture.

/api/holographic/mrc/status (取得)/api/holographic/mrc/status (GET)

取得 Windows 裝置入口網站內混合現實捕捉的狀態。Gets the state of mixed reality capture within the Windows Device Portal.

*回應 _*Response _

回應包含 JSON 屬性,指出 Windows 裝置入口網站是否錄製影片。The response contains a JSON property indicating if Windows Device Portal is recording video or not.

{"IsRecording" : boolean}

_ /api/holographic/mrc/thumbnail (取得)*_ /api/holographic/mrc/thumbnail (GET)*

取得指定檔案的縮圖影像。Gets the thumbnail image for the specified file.

參數Parameters

  • 檔案名:已要求縮圖的檔案名、hex64 編碼的檔案filename: Name, hex64 encoded, of the file for which the thumbnail is being requested

/api/holographic/mrc/video/control/start (POST)/api/holographic/mrc/video/control/start (POST)

開始混合現實記錄Starts a mixed reality recording

參數Parameters

  • hololens:抓取全像: true 或 false (預設為 false) holo : capture holograms: true or false (defaults to false)
  • pv: capture PV 攝影機: true 或 false (預設為 false) pv : capture PV camera: true or false (defaults to false)
  • mic: capture 麥克風: true 或 false (預設為 false) mic : capture microphone: true or false (defaults to false)
  • 回送: capture app audio: true 或 false (預設為 false) loopback : capture app audio: true or false (defaults to false)
  • RenderFromCamera: (只 HoloLens 2) 從相片/攝影機的觀點轉譯: true 或 false (預設為 true) RenderFromCamera : (HoloLens 2 only) render from perspective of photo/video camera: true or false (defaults to true)
  • vstab: (只 HoloLens 2) 啟用影片穩定: true 或 false (預設為 true) vstab : (HoloLens 2 only) enable video stabilization: true or false (defaults to true)
  • vstabbuffer: (只 HoloLens 2) video 穩定緩衝區延遲:0到30個畫面格 (預設為15個畫面格) vstabbuffer: (HoloLens 2 only) video stabilization buffer latency: 0 to 30 frames (defaults to 15 frames)

/api/holographic/mrc/video/control/stop (POST)/api/holographic/mrc/video/control/stop (POST)

停止目前的混合現實記錄Stops the current mixed reality recording

混合的現實串流Mixed Reality Streaming

警告

由於回送隔離的原因,您無法從裝置上的應用程式內連線到混合現實串流。Because of loopback isolation, you can't connect to Mixed Reality Streaming from inside an app on a device.

HoloLens 透過區塊下載分散的數量,支援混合現實的即時預覽。HoloLens supports live preview of mixed reality via chunked download of a fragmented mp4.

混合的現實資料流程共用一組相同的參數來控制所要捕獲的內容:Mixed reality streams share the same set of parameters to control what is captured:

  • hololens:抓取全像: true 或 falseholo : capture holograms: true or false
  • pv: capture PV 攝影機: true 或 falsepv : capture PV camera: true or false
  • mic: capture 麥克風: true 或 falsemic : capture microphone: true or false
  • 回送:捕捉應用程式音訊: true 或 falseloopback : capture app audio: true or false

如果未指定這些任何一項:將會捕捉全像照片、相片/攝影機和應用程式音訊If none of these are specified: holograms, photo/video camera, and app audio will be captured
如果有指定任何參數:未指定的參數會預設為 falseIf any are specified: the unspecified parameters will default to false

(只 HoloLens 2) 的選擇性參數Optional parameters (HoloLens 2 only)

  • RenderFromCamera:從相片/攝影機的觀點來呈現: true 或 false (預設為 true) RenderFromCamera : render from perspective of photo/video camera: true or false (defaults to true)
  • vstab:啟用影片穩定: true 或 false (預設為 false) vstab : enable video stabilization: true or false (defaults to false)
  • vstabbuffer:影片穩定緩衝區延遲:0到30個畫面格 (預設為15個畫面格) vstabbuffer: video stabilization buffer latency: 0 to 30 frames (defaults to 15 frames)

/api/holographic/stream/live.mp4 (取得)/api/holographic/stream/live.mp4 (GET)

1280x720p 30fps 5Mbit 串流。A 1280x720p 30fps 5Mbit stream.

/api/holographic/stream/live_high.mp4 (取得)/api/holographic/stream/live_high.mp4 (GET)

1280x720p 30fps 5Mbit 串流。A 1280x720p 30fps 5Mbit stream.

/api/holographic/stream/live_med.mp4 (取得)/api/holographic/stream/live_med.mp4 (GET)

854x480p 30fps 2.5 Mbit 串流。A 854x480p 30fps 2.5Mbit stream.

/api/holographic/stream/live_low.mp4 (取得)/api/holographic/stream/live_low.mp4 (GET)

428x240p 15fps 0.6 Mbit 串流。A 428x240p 15fps 0.6Mbit stream.

網路功能Networking

/api/networking/ipconfig (取得)/api/networking/ipconfig (GET)

取得目前的 ip 設定Gets the current ip configuration

作業系統資訊OS Information

/api/os/info (取得)/api/os/info (GET)

取得作業系統資訊Gets operating system information

/api/os/machinename (取得)/api/os/machinename (GET)

取得電腦名稱稱Gets the machine name

/api/os/machinename (POST)/api/os/machinename (POST)

設定電腦名稱稱Sets the machine name

參數Parameters

  • 名稱:新電腦名稱稱、hex64 編碼、設定為name : New machine name, hex64 encoded, to set to

認知模擬控制項Perception Simulation Control

/api/holographic/simulation/control/mode (取得)/api/holographic/simulation/control/mode (GET)

取得模擬模式Get the simulation mode

/api/holographic/simulation/control/mode (POST)/api/holographic/simulation/control/mode (POST)

設定模擬模式Set the simulation mode

參數Parameters

  • 模式:模擬模式:預設、模擬、遠端、舊版mode : simulation mode: default, simulation, remote, legacy

/api/holographic/simulation/control/stream (刪除)/api/holographic/simulation/control/stream (DELETE)

刪除控制資料流程。Delete a control stream.

/api/holographic/simulation/control/stream (GET/WebSocket)/api/holographic/simulation/control/stream (GET/WebSocket)

開啟控制項資料流程的 web 通訊端連接。Open a web socket connection for a control stream.

/api/holographic/simulation/control/stream (POST)/api/holographic/simulation/control/stream (POST)

建立控制項資料流程 (需要優先權) 或將資料張貼至建立的資料流程 (streamId 必要) 。Create a control stream (priority is required) or post data to a created stream (streamId required). 張貼的資料應為 ' application/八進位-stream ' 類型。Posted data is expected to be of type 'application/octet-stream'.

/api/holographic/simulation/display/stream (GET/WebSocket)/api/holographic/simulation/display/stream (GET/WebSocket)

要求模擬影片串流,其中包含在「模擬」模式中呈現給系統顯示的內容。Request a simulation video stream containing the content rendered to the system display when in 'Simulation' mode. 一開始會傳送簡單的格式描述元標頭,後面接著 h.264 編碼的材質,每個標頭前面都有一個標頭,表示眼睛索引和材質大小。A simple format descriptor header will be sent initially, followed by H.264-encoded textures, each preceded by a header indicating the eye index and texture size.

感知模擬播放Perception Simulation Playback

/api/holographic/simulation/playback/file (刪除)/api/holographic/simulation/playback/file (DELETE)

刪除錄製。Delete a recording.

參數Parameters

  • 錄製:要刪除的記錄名稱。recording : Name of recording to delete.

/api/holographic/simulation/playback/file (POST)/api/holographic/simulation/playback/file (POST)

上傳錄製。Upload a recording.

/api/holographic/simulation/playback/files (取得)/api/holographic/simulation/playback/files (GET)

取得所有錄製。Get all recordings.

/api/holographic/simulation/playback/session (取得)/api/holographic/simulation/playback/session (GET)

取得錄製的目前播放狀態。Get the current playback state of a recording.

參數Parameters

  • 錄製:錄製的名稱。recording : Name of recording.

/api/holographic/simulation/playback/session/file (刪除)/api/holographic/simulation/playback/session/file (DELETE)

卸載錄製。Unload a recording.

參數Parameters

  • 記錄:要卸載的記錄名稱。recording : Name of recording to unload.

/api/holographic/simulation/playback/session/file (POST)/api/holographic/simulation/playback/session/file (POST)

載入錄製。Load a recording.

參數Parameters

  • 記錄:要載入的記錄名稱。recording : Name of recording to load.

/api/holographic/simulation/playback/session/files (取得)/api/holographic/simulation/playback/session/files (GET)

取得所有載入的記錄。Get all loaded recordings.

/api/holographic/simulation/playback/session/pause (POST)/api/holographic/simulation/playback/session/pause (POST)

暫停錄製。Pause a recording.

參數Parameters

  • 錄製:錄製的名稱。recording : Name of recording.

/api/holographic/simulation/playback/session/play (POST)/api/holographic/simulation/playback/session/play (POST)

播放錄製。Play a recording.

參數Parameters

  • 錄製:錄製的名稱。recording : Name of recording.

/api/holographic/simulation/playback/session/stop (POST)/api/holographic/simulation/playback/session/stop (POST)

停止錄製。Stop a recording.

參數Parameters

  • 錄製:錄製的名稱。recording : Name of recording.

/api/holographic/simulation/playback/session/types (取得)/api/holographic/simulation/playback/session/types (GET)

取得載入錄製中的資料類型。Get the types of data in a loaded recording.

參數Parameters

  • 錄製:錄製的名稱。recording : Name of recording.

感知模擬錄製Perception Simulation Recording

/api/holographic/simulation/recording/start (POST)/api/holographic/simulation/recording/start (POST)

開始錄製。Start a recording. 一次只能有一個作用中的記錄。Only a single recording can be active at once. 必須設定 head、雙手、spatialMapping 或環境之一。One of head, hands, spatialMapping or environment must be set.

參數Parameters

  • head:設定為1以記錄 head 資料。head : Set to 1 to record head data.
  • 雙手:設定為1以記錄手資料。hands : Set to 1 to record hand data.
  • spatialMapping:設定為1以記錄空間對應。spatialMapping : Set to 1 to record spatial mapping.
  • 環境:設定為1以記錄環境資料。environment : Set to 1 to record environment data.
  • 名稱:錄製的名稱。name : Name of the recording.
  • singleSpatialMappingFrame:設定為1只記錄單一空間對應框架。singleSpatialMappingFrame : Set to 1 to record only a single spatial mapping frame.

/api/holographic/simulation/recording/status (取得)/api/holographic/simulation/recording/status (GET)

取得錄製狀態。Get recording state.

/api/holographic/simulation/recording/stop (取得)/api/holographic/simulation/recording/stop (GET)

停止目前的錄製。Stop the current recording. 記錄會以檔案的形式傳回。Recording will be returned as a file.

效能資料Performance data

/api/resourcemanager/processes (取得)/api/resourcemanager/processes (GET)

傳回執行中進程的清單,並提供詳細資料Returns the list of running processes with details

傳回資料Return data

  • JSON 與進程清單以及每個進程的詳細資料JSON with list of processes and details for each process

/api/resourcemanager/systemperf (取得)/api/resourcemanager/systemperf (GET)

傳回系統效能統計資料 (i/o 讀取/寫入、記憶體統計資料等。Returns system perf statistics (I/O read/write, memory stats etc.

傳回資料Return data

  • 具有系統資訊的 JSON: CPU、GPU、記憶體、網路、IOJSON with system information: CPU, GPU, Memory, Network, IO

電源Power

/api/power/battery (取得)/api/power/battery (GET)

取得目前的電池狀態Gets the current battery state

/api/power/state (取得)/api/power/state (GET)

檢查系統是否處於低電源狀態Checks if the system is in a low power state

遠端控制Remote Control

/api/control/restart (POST)/api/control/restart (POST)

重新開機目標裝置Restarts the target device

/api/control/shutdown (POST)/api/control/shutdown (POST)

關閉目標裝置Shuts down the target device

工作管理員Task Manager

/api/taskmanager/app (刪除)/api/taskmanager/app (DELETE)

停止新式應用程式Stops a modern app

參數Parameters

  • 封裝:應用程式套件的完整名稱,hex64 編碼package : Full name of the app package, hex64 encoded
  • forcestop:強制所有進程停止 (= 是) forcestop : Force all processes to stop (=yes)

/api/taskmanager/app (POST)/api/taskmanager/app (POST)

啟動新式應用程式Starts a modern app

參數Parameters

  • appid:要啟動的應用程式 PRAID,hex64 編碼appid : PRAID of app to start, hex64 encoded
  • 封裝:應用程式套件的完整名稱,hex64 編碼package : Full name of the app package, hex64 encoded

WiFi 管理WiFi Management

/api/wifi/interfaces (取得)/api/wifi/interfaces (GET)

列舉無線網路介面Enumerates wireless network interfaces

傳回資料Return data

  • 具有詳細資料 (GUID、描述等 ) 的無線介面清單List of wireless interfaces with details (GUID, description etc.)

/api/wifi/network (刪除)/api/wifi/network (DELETE)

刪除與指定介面上的網路相關聯的設定檔Deletes a profile associated with a network on a specified interface

參數Parameters

  • 介面:網路介面 guidinterface : network interface guid
  • 設定檔:設定檔名稱profile : profile name

/api/wifi/networks (取得)/api/wifi/networks (GET)

列舉指定網路介面上的無線網路Enumerates wireless networks on the specified network interface

參數Parameters

  • 介面:網路介面 guidinterface : network interface guid

傳回資料Return data

  • 網路介面上找到的無線網路清單與詳細資料List of wireless networks found on the network interface with details

/api/wifi/network (POST)/api/wifi/network (POST)

連接或中斷指定介面上的網路連線Connects or disconnects to a network on the specified interface

參數Parameters

  • 介面:網路介面 guidinterface : network interface guid
  • ssid: ssid、hex64 編碼、要連接的ssid : ssid, hex64 encoded, to connect to
  • op:連線或中斷連接op : connect or disconnect
  • createprofile:是或否createprofile : yes or no
  • 機碼:共用金鑰,hex64 編碼key : shared key, hex64 encoded

Windows Performance RecorderWindows Performance Recorder

/api/wpr/customtrace (POST)/api/wpr/customtrace (POST)

上傳 WPR 設定檔,並使用上傳的設定檔開始追蹤。Uploads a WPR profile and starts tracing using the uploaded profile.

PayloadPayload

  • 多部分的符合 HTTP 主體multi-part conforming http body

傳回資料Return data

  • 傳回 WPR 會話狀態。Returns the WPR session status.

/api/wpr/status (取得)/api/wpr/status (GET)

捕獲 WPR 會話的狀態Retrieves the status of the WPR session

傳回資料Return data

  • WPR 會話狀態。WPR session status.

/api/wpr/trace (取得)/api/wpr/trace (GET)

停止 WPR (效能) 追蹤會話Stops a WPR (performance) tracing session

傳回資料Return data

  • 傳回追蹤 ETL 檔案Returns the trace ETL file

/api/wpr/trace (POST)/api/wpr/trace (POST)

啟動 WPR (效能) 追蹤會話Starts a WPR (performance) tracing sessions

參數Parameters

  • 設定檔:設定檔名稱。profile : Profile name. 可用的設定檔會儲存在 perfprofiles/profiles.jsAvailable profiles are stored in perfprofiles/profiles.json

傳回資料Return data

  • 在開始時,會傳回 WPR 會話狀態。On start, returns the WPR session status.

請參閱See also