Remote Rendering - Stop Session

服務:

Mixed Reality

API 版本:

2021-01-01

停止特定的轉譯會話。

POST {endpoint}/accounts/{account_id}/sessions/{session_id}/:stop?api-version=2021-01-01

URI 參數

名稱	位於	必要	類型	Description
account_id	path	True	string uuid	Azure 遠端轉譯 帳戶標識碼。
endpoint	path	True	string	要使用的端點，例如 https://remoterendering.eastus.mixedreality.azure.com。 您可以在 找到 https://docs.microsoft.com/azure/remote-rendering/reference/regions清單。
session_id	path	True	string	可唯一識別指定帳戶之轉譯會話的標識碼。 標識符區分大小寫、可以包含英數位元的任何組合，包括連字元和底線，而且不能包含超過 256 個字元。
api-version	query	True	string	要與 HTTP 要求搭配使用的 API 版本。

要求標頭

名稱	必要	類型	Description
Authorization	True	string	Mixed Reality 安全令牌服務所傳回的持有人令牌。 如需詳細資訊，請參閱＜https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens＞。

回應

名稱	類型	Description
204 No Content		NoContent。 停止要求成功。 轉譯會話已停止。 標題 MS-CV: string
401 Unauthorized		未經授權。 遺失或無效的授權。 標題 MS-CV: string WWW-Authenticate: string
403 Forbidden		禁止。 授權不足，無法取得指定的資源。 標題 MS-CV: string
404 Not Found		找不到。 沒有具有所提供會話標識碼的會話。 標題 MS-CV: string
429 Too Many Requests		過多要求。 已超過速率限制。 在 Retry-After 標頭中指定的持續時間之後重試要求。 標題 MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	內部錯誤。 伺服器發生內部錯誤。 重試要求可能會產生成功的結果。 標題 MS-CV: string

安全性

Authorization

Mixed Reality 安全令牌服務所傳回的持有人令牌。 如需詳細資訊，請參閱＜https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens＞。

類型: apiKey
位於: header

範例

Stop a session

範例要求

HTTP

POST https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/sessions/contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28/:stop?api-version=2021-01-01

範例回覆

狀態碼:

204

MS-CV: dKEFmka2kkSlDmp/af+sOw

狀態碼:

401

WWW-Authenticate: Bearer error="invalid_token"
MS-CV: dKEFmka2kkSlDmp/af+sOw

狀態碼:

403

MS-CV: dKEFmka2kkSlDmp/af+sOw

狀態碼:

404

MS-CV: dKEFmka2kkSlDmp/af+sOw

狀態碼:

429

Retry-After: 15
MS-CV: dKEFmka2kkSlDmp/af+sOw

狀態碼:

500

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "error": {
    "code": "InternalServerError",
    "message": "An internal server error occurred."
  }
}

定義

名稱	Description
error	錯誤物件，包含要求失敗原因的詳細數據。
error_response	錯誤回應，包含要求失敗原因的詳細數據。

error

錯誤物件，包含要求失敗原因的詳細數據。

名稱	類型	Description
code	string	錯誤碼。
details	error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innerError	error	物件，包含比目前對象有關錯誤的更特定資訊。
message	string	人類看得懂的錯誤表示法。
target	string	特定錯誤的目標 (例如錯誤) 中的屬性名稱。

error_response

錯誤回應，包含要求失敗原因的詳細數據。

名稱	類型	Description
error	error	錯誤物件，包含要求失敗原因的詳細數據。