Remote Rendering - Create Session

Referencia

Servicio:: Mixed Reality

Versión de la API:: 2021-01-01

Crea una nueva sesión de representación.

PUT {endpoint}/accounts/{account_id}/sessions/{session_id}?api-version=2021-01-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
account_id	path	True	string uuid	Identificador de la cuenta de Azure Remote Rendering.
endpoint	path	True	string	Punto de conexión que se va a usar, por ejemplo, https://remoterendering.eastus.mixedreality.azure.com. Puede encontrar una lista en https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id	path	True	string	Identificador que identifica de forma única la sesión de representación de la cuenta especificada. El identificador distingue mayúsculas de minúsculas, puede contener cualquier combinación de caracteres alfanuméricos, incluidos guiones y caracteres de subrayado, y no puede contener más de 256 caracteres.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud HTTP.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Authorization	True	string	Token de portador devuelto por el servicio de token seguro de Mixed Reality. Para obtener información detallada, vea https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
maxLeaseTimeMinutes	True	integer	El tiempo en minutos que se ejecutará la sesión después de alcanzar el estado "Listo". Tiene que estar entre 0 y 1440.
size	True	session_size	Tamaño del servidor utilizado para la sesión de representación. El tamaño afecta al número de polígonos que el servidor puede representar. Vea https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes para obtener más información.

Respuestas

Nombre	Tipo	Description
200 OK	session_properties	Aceptar. Indica que ya había una sesión con la misma configuración presente. Esto se espera cuando se reintenta la creación de la sesión.
201 Created	session_properties	Creado. La sesión se creó correctamente. Encabezados MS-CV: string
400 Bad Request	error_response	Solicitud incorrecta. El objeto de error devuelto describe qué problemas se produjeron. Encabezados MS-CV: string
401 Unauthorized		No autorizado. Falta o no es válida la autorización. Encabezados MS-CV: string WWW-Authenticate: string
403 Forbidden		Prohibido. Autorización insuficiente para un recurso determinado. Encabezados MS-CV: string
429 Too Many Requests		Demasiadas solicitudes Se ha superado el límite de frecuencia. Vuelva a intentar la solicitud después de la duración especificada en el encabezado Retry-After. Encabezados MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Error interno. El servidor ha encontrado un error interno. Volver a intentar la solicitud puede generar resultados correctos. Encabezados MS-CV: string
Other Status Codes	error_response	Conflicto. Ya existe una sesión de representación con el identificador para la cuenta de representación remota.

Seguridad

Authorization

Token de portador devuelto por el servicio de token seguro de Mixed Reality. Para obtener información detallada, vea https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Tipo: apiKey
En: header

Ejemplos

Create a rendering session

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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
}

status code:: 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
}

status code:: 400

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

status code:: 409

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

status code:: 401

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

status code:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

status code:: 429

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

status code:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Definiciones

Nombre	Description
create_session_settings	Configuración de la sesión que se va a crear.
error	Objeto de error que contiene detalles de por qué se produjo un error en la solicitud.
error_response	Respuesta de error que contiene detalles de por qué se produjo un error en la solicitud.
session_properties	Propiedades de una sesión de representación.
session_size	Tamaño del servidor utilizado para la sesión de representación. El tamaño afecta al número de polígonos que el servidor puede representar. Vea https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes para obtener más información.
session_status	Estado de la sesión de representación. Los estados terminales son "Error", "Expirado" y "Detenido".

create_session_settings

Configuración de la sesión que se va a crear.

Nombre	Tipo	Description
maxLeaseTimeMinutes	integer	El tiempo en minutos que se ejecutará la sesión después de alcanzar el estado "Listo". Tiene que estar entre 0 y 1440.
size	session_size	Tamaño del servidor utilizado para la sesión de representación. El tamaño afecta al número de polígonos que el servidor puede representar. Vea https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes para obtener más información.

error

Objeto de error que contiene detalles de por qué se produjo un error en la solicitud.

Nombre	Tipo	Description
code	string	Código de error.
details	error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innerError	error	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error concreto (por ejemplo, el nombre de la propiedad en error).

error_response

Respuesta de error que contiene detalles de por qué se produjo un error en la solicitud.

Nombre	Tipo	Description
error	error	Objeto de error que contiene detalles de por qué se produjo un error en la solicitud.

session_properties

Propiedades de una sesión de representación.

Nombre	Tipo	Description
arrInspectorPort	integer	Puerto TCP en el que se hospeda la herramienta Azure Remote Rendering Inspector.
creationTime	string	Hora a la que se creó la sesión de representación. Fecha y hora en formato ISO 8601.
elapsedTimeMinutes	integer	Cantidad de tiempo en minutos en que la sesión está o estaba en estado "Listo". El tiempo se redondea a un minuto completo.
error	error	Objeto de error que contiene detalles sobre el error de inicio de la sesión de representación.
handshakePort	integer	Puerto TCP utilizado para el protocolo de enlace al establecer una conexión.
hostname	string	Nombre de host en el que se puede acceder a la sesión de representación.
id	string	Identificador de la sesión proporcionada cuando se creó la sesión.
maxLeaseTimeMinutes	integer	El tiempo en minutos que se ejecutará la sesión después de alcanzar el estado "Listo".
size	session_size	Tamaño del servidor utilizado para la sesión de representación. El tamaño afecta al número de polígonos que el servidor puede representar. Vea https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes para obtener más información.
status	session_status	Estado de la sesión de representación. Los estados terminales son "Error", "Expirado" y "Detenido".
teraflops	number	Potencia computacional de la GPU de la sesión de representación medida en teraflops.

session_size

Tamaño del servidor utilizado para la sesión de representación. El tamaño afecta al número de polígonos que el servidor puede representar. Vea https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes para obtener más información.

Nombre	Tipo	Description
Premium	string	Tamaño de sesión de representación Premium.
Standard	string	Tamaño de sesión de representación estándar.

session_status

Estado de la sesión de representación. Los estados terminales son "Error", "Expirado" y "Detenido".

Nombre	Tipo	Description
Error	string	La sesión de representación ha encontrado un error y no se puede usar. Se trata de un estado terminal.
Expired	string	La sesión de representación entra en el estado "Expirado" cuando ha estado en el estado "Listo" durante más tiempo que su tiempo de concesión. Se trata de un estado terminal.
Ready	string	La sesión de representación está lista para las conexiones entrantes.
Starting	string	La sesión de representación se está iniciando, pero aún no acepta conexiones entrantes.
Stopped	string	La sesión de representación se ha detenido con la operación "Detener sesión". Se trata de un estado terminal.

Compartir a través de