Remote Rendering - Stop Session

Referência

Serviço:: Mixed Reality

Versão da API:: 2021-01-01

Interrompe uma sessão de renderização específica.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
account_id	path	True	string uuid	A ID da conta Remote Rendering do Azure.
endpoint	path	True	string	O ponto de extremidade a ser usado, por exemplo, https://remoterendering.eastus.mixedreality.azure.com. Uma lista pode ser encontrada em https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id	path	True	string	Uma ID que identifica exclusivamente a sessão de renderização da conta fornecida. A ID diferencia maiúsculas de minúsculas, pode conter qualquer combinação de caracteres alfanuméricos, incluindo hifens e sublinhados, e não pode conter mais de 256 caracteres.
api-version	query	True	string	A versão da API a ser usada com a solicitação HTTP.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Um token de portador retornado pelo serviço de token seguro Realidade Misturada. Para obter detalhes, consulte https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Respostas

Nome	Tipo	Description
204 No Content		NoContent. A solicitação de parada foi bem-sucedida. A sessão de renderização é interrompida. Cabeçalhos MS-CV: string
401 Unauthorized		Não autorizado. Autorização ausente ou inválida. Cabeçalhos MS-CV: string WWW-Authenticate: string
403 Forbidden		Negado. Autorização insuficiente para determinado recurso. Cabeçalhos MS-CV: string
404 Not Found		Não encontrado. Nenhuma sessão com a ID de sessão fornecida existe. Cabeçalhos MS-CV: string
429 Too Many Requests		Excesso de solicitações. O limite de taxa foi excedido. Repita a solicitação após a duração fornecida no cabeçalho Retry-After. Cabeçalhos MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Erro Interno. O servidor encontrou um erro interno. Repetir a solicitação pode produzir resultados bem-sucedidos. Cabeçalhos MS-CV: string

Segurança

Authorization

Um token de portador retornado pelo serviço de token seguro Realidade Misturada. Para obter detalhes, consulte https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Tipo: apiKey
Em: header

Exemplos

Stop a session

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 204

MS-CV: dKEFmka2kkSlDmp/af+sOw

Código de status:: 401

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

Código de status:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Código de status:: 404

MS-CV: dKEFmka2kkSlDmp/af+sOw

Código de status:: 429

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

Código de status:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Definições

Nome	Description
error	O objeto de erro que contém detalhes de por que a solicitação falhou.
error_response	A resposta de erro que contém detalhes de por que a solicitação falhou.

error

O objeto de erro que contém detalhes de por que a solicitação falhou.

Nome	Tipo	Description
code	string	Código do erro.
details	error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innerError	error	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo homem do erro.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

error_response

A resposta de erro que contém detalhes de por que a solicitação falhou.

Nome	Tipo	Description
error	error	O objeto de erro que contém detalhes de por que a solicitação falhou.

Compartilhar via