你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称	在	必需	类型	说明
account_id	path	True	string uuid	Azure 远程渲染帐户 ID。
endpoint	path	True	string	要使用的终结点，例如 https://remoterendering.eastus.mixedreality.azure.com。可以在中找到 https://docs.microsoft.com/azure/remote-rendering/reference/regions列表。
session_id	path	True	string	唯一标识给定帐户的呈现会话的 ID。 ID 区分大小写，可以包含字母数字字符（包括连字符和下划线）的任意组合，并且不能包含超过 256 个字符。
api-version	query	True	string	要与 HTTP 请求一起使用的 API 版本。

请求头

名称	必需	类型	说明
Authorization	True	string	混合现实安全令牌服务返回的持有者令牌。有关详细信息，请参阅https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens。

响应

名称	类型	说明
204 No Content		NoContent。停止请求成功。呈现会话已停止。标头 MS-CV: string
401 Unauthorized		未授权。授权缺失或无效。标头 MS-CV: string WWW-Authenticate: string
403 Forbidden		已禁止。给定资源的授权不足。标头 MS-CV: string
404 Not Found		未找到。不存在具有所提供会话 ID 的会话。标头 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

混合现实安全令牌服务返回的持有者令牌。有关详细信息，请参阅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."
  }
}

定义

名称	说明
error	包含请求失败原因的详细信息的错误对象。
error_response	包含请求失败原因的详细信息的错误响应。

error

包含请求失败原因的详细信息的错误对象。

名称	类型	说明
code	string	错误代码。
details	error[]	有关导致此项报告错误的特定错误的详细信息数组。
innerError	error	一个对象，该对象包含比当前对象更具体的错误信息。
message	string	错误的用户可读表示形式。
target	string	特定错误的目标 (例如，错误) 的属性的名称。

error_response

包含请求失败原因的详细信息的错误响应。

名称	类型	说明
error	error	包含请求失败原因的详细信息的错误对象。

通过