Compartir a través de

Remote Rendering - Stop Session

  • Referencia
Servicio:
Mixed Reality
Versión de la API:
2021-01-01

Detiene una sesión de representación determinada.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
account_id
 path True

string

uuid

Identificador de 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

La 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

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

Respuestas

Nombre Tipo Description
204 No Content

NoContent. La solicitud de detención se realizó correctamente. La sesión de representación se detiene.

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. La autorización no es suficiente para un recurso determinado.

Encabezados

MS-CV: string
404 Not Found

Not found. No existe ninguna sesión con el identificador de sesión proporcionado.

Encabezados

MS-CV: string
429 Too Many Requests

Demasiadas solicitudes Se ha superado el límite de velocidad. 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 producir resultados correctos.

Encabezados

MS-CV: string

Seguridad

Authorization

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

Tipo: apiKey
En: header

Ejemplos

Stop a session

Solicitud de ejemplo

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

Respuesta de muestra

status code:
204 
MS-CV: dKEFmka2kkSlDmp/af+sOw
status code:
401 
WWW-Authenticate: Bearer error="invalid_token"
MS-CV: dKEFmka2kkSlDmp/af+sOw
status code:
403 
MS-CV: dKEFmka2kkSlDmp/af+sOw
status code:
404 
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
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.

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 determinado (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.