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

Remote Rendering - Create Session

参考

服务:: Mixed Reality

API 版本:: 2021-01-01

创建新的呈现会话。

PUT {endpoint}/accounts/{account_id}/sessions/{session_id}?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。

请求正文

名称	必需	类型	说明
maxLeaseTimeMinutes	True	integer	达到“就绪”状态后，会话将运行的时间（以分钟为单位）。它必须介于 0 到 1440 之间。
size	True	session_size	用于呈现会话的服务器的大小。大小会影响服务器可以呈现的多边形数。请参阅 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes 了解详细信息。

响应

名称	类型	说明
200 OK	session_properties	没问题。指示已存在具有相同设置的会话。重试会话创建时，这是预期的。
201 Created	session_properties	Created. 已成功创建会话。标头 MS-CV: string
400 Bad Request	error_response	错误的请求。返回的错误对象描述发生了哪些问题。标头 MS-CV: string
401 Unauthorized		未授权。缺少或无效的授权。标头 MS-CV: string WWW-Authenticate: string
403 Forbidden		已禁止。给定资源的授权不足。标头 MS-CV: string
429 Too Many Requests		请求过多。已超出速率限制。在 Retry-After 标头中给定的持续时间后重试请求。标头 MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	内部错误。服务器遇到内部错误。重试请求可能会产生成功的结果。标头 MS-CV: string
Other Status Codes	error_response	冲突。远程呈现帐户已存在 ID 为的呈现会话。

安全性

Authorization

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

类型: apiKey
在: header

示例

Create a rendering session

示例请求

HTTP

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

{
  "maxLeaseTimeMinutes": 60,
  "size": "Standard"
}

示例响应

状态代码:: 201

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "maxLeaseTimeMinutes": 60,
  "size": "Standard",
  "status": "Starting",
  "error": null
}

状态代码:: 200

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "maxLeaseTimeMinutes": 60,
  "size": "Standard",
  "status": "Starting",
  "error": null
}

状态代码:: 400

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "error": {
    "code": "BadRequest",
    "message": "The request was malformed."
  }
}

状态代码:: 409

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "error": {
    "code": "Conflict",
    "message": "A resource already exists under the given ID."
  }
}

状态代码:: 401

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

状态代码:: 403

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

定义

名称	说明
create_session_settings	要创建的会话的设置。
error	包含请求失败原因的详细信息的错误对象。
error_response	包含请求失败原因的详细信息的错误响应。
session_properties	呈现会话的属性。
session_size	用于呈现会话的服务器的大小。大小会影响服务器可以呈现的多边形数。请参阅 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes 了解详细信息。
session_status	呈现会话的状态。终端状态为“错误”、“已过期”和“已停止”。

create_session_settings

要创建的会话的设置。

名称	类型	说明
maxLeaseTimeMinutes	integer	达到“就绪”状态后，会话将运行的时间（以分钟为单位）。它必须介于 0 到 1440 之间。
size	session_size	用于呈现会话的服务器的大小。大小会影响服务器可以呈现的多边形数。请参阅 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes 了解详细信息。

error

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

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

error_response

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

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

session_properties

呈现会话的属性。

名称	类型	说明
arrInspectorPort	integer	托管 Azure 远程渲染检查器工具的 TCP 端口。
creationTime	string	创建呈现会话的时间。采用 ISO 8601 格式的日期和时间。
elapsedTimeMinutes	integer	会话处于“就绪”状态或处于“就绪”状态的时间量（以分钟为单位）。时间向下舍入为整分钟。
error	error	包含有关呈现会话启动失败的详细信息的错误对象。
handshakePort	integer	建立连接时用于握手的 TCP 端口。
hostname	string	呈现会话可访问的主机名。
id	string	创建会话时提供的会话的 ID。
maxLeaseTimeMinutes	integer	达到“就绪”状态后，会话将运行的时间（以分钟为单位）。
size	session_size	用于呈现会话的服务器的大小。大小会影响服务器可以呈现的多边形数。请参阅 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes 了解详细信息。
status	session_status	呈现会话的状态。终端状态为“错误”、“已过期”和“已停止”。
teraflops	number	渲染会话 GPU 的计算能力（以 teraflops 为单位）。

session_size

用于呈现会话的服务器的大小。大小会影响服务器可以呈现的多边形数。请参阅 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes 了解详细信息。

名称	类型	说明
Premium	string	高级呈现会话大小。
Standard	string	标准呈现会话大小。

session_status

呈现会话的状态。终端状态为“错误”、“已过期”和“已停止”。

名称	类型	说明
Error	string	呈现会话遇到错误，不可用。这是终端状态。
Expired	string	当呈现会话处于“就绪”状态的时间超过其租用时间时，呈现会话将进入“已过期”状态。这是终端状态。
Ready	string	呈现会话已准备好用于传入连接。
Starting	string	呈现会话正在启动，但尚未接受传入连接。
Stopped	string	呈现会话已通过“停止会话”操作停止。这是终端状态。

通过