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

Remote Rendering - Stop Session

停止特定的呈现会话。

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

URI 参数

Name In Required Type Description
account_id
path True
  • string
uuid

Azure 远程渲染帐户 ID。

endpoint
path True
  • string

要使用的终结点,例如。 https://remoterendering.eastus.mixedreality.azure.com A list can be found at https://docs.microsoft.com/azure/remote-rendering/reference/regions.

session_id
path True
  • string

唯一标识给定帐户的呈现会话的 ID。 ID 区分大小写,可以包含字母数字字符(包括连字符和下划线)的任意组合,并且不能包含超过 256 个字符。

api-version
query True
  • string

要用于 HTTP 请求的 API 版本。

请求头

Name Required Type Description
Authorization True
  • string

混合现实安全令牌服务返回的持有者令牌。 有关详细信息,请参阅https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens

响应

Name Type Description
204 No Content

NoContent。 停止请求成功。 呈现会话已停止。

Headers

  • MS-CV: string
401 Unauthorized

未授权。 缺少或无效的授权。

Headers

  • MS-CV: string
  • WWW-Authenticate: string
403 Forbidden

已禁止。 授权不足,无法用于给定资源。

Headers

  • MS-CV: string
404 Not Found

未找到。 不存在具有提供的会话 ID 的会话。

Headers

  • MS-CV: string
500 Internal Server Error

内部错误。 服务器遇到内部错误。 重试请求可能会产生成功的结果。

Headers

  • MS-CV: string
Other Status Codes

请求过多。 已超出速率限制。 在Retry-After标头中给定的持续时间后重试请求。

Headers

  • MS-CV: string
  • Retry-After: integer

安全性

Authorization

混合现实安全令牌服务返回的持有者令牌。 有关详细信息,请参阅https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens

Type: apiKey
In: header

示例

Stop a session

Sample Request

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-preview

Sample Response

MS-CV: dKEFmka2kkSlDmp/af+sOw
WWW-Authenticate: Bearer error="invalid_token"
MS-CV: dKEFmka2kkSlDmp/af+sOw
MS-CV: dKEFmka2kkSlDmp/af+sOw
MS-CV: dKEFmka2kkSlDmp/af+sOw
Retry-After: 15
MS-CV: dKEFmka2kkSlDmp/af+sOw
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "InternalServerError",
    "message": "An internal server error occurred."
  }
}

定义

error

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

error_response

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

error

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

Name Type Description
code
  • string

错误代码。

details

有关导致此错误的特定错误的详细信息数组。

innerError

包含与当前对象有关错误的更具体信息的对象。

message
  • string

错误的可读表示形式。

target
  • string

特定错误的目标 (,例如错误) 中的属性的名称。

error_response

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

Name Type Description
error

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