Partilhar via

Remote Rendering - Update Session

  • Referência
Serviço:
Mixed Reality
Versão da API:
2021-01-01

Atualiza o tempo máximo de concessão de uma sessão de renderização específica.

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

Parâmetros do URI

Name Em Necessário Tipo Description
account_id
 path True

string (uuid)

A ID da conta de Renderização Remota do Azure.
endpoint
 path True

string

O parâmetro de avaliação a utilizar, 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

Um ID que identifica exclusivamente a sessão de renderização para uma determinada conta. O ID diferencia maiúsculas de minúsculas, pode conter qualquer combinação de caracteres alfanuméricos, incluindo hífenes 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 do Pedido

Name Necessário Tipo Description
Authorization True

string

Um token ao portador retornado pelo Serviço de Token Seguro de Realidade Mista. Consulte https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens para obter detalhes.

Corpo do Pedido

Name Necessário Tipo Description
maxLeaseTimeMinutes True

integer

Atualize para a hora em que a sessão será executada depois de ter atingido o estado 'Pronto'. Tem de ser maior do que o valor atual de maxLeaseTimeMinutes e inferior a 1440.

Respostas

Name Tipo Description
200 OK

session_properties

OK. A sessão foi atualizada.
401 Unauthorized

Não autorizado. Autorização ausente ou inválida.

Cabeçalhos

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

Proibido. Autorização insuficiente para determinado recurso.

Cabeçalhos

MS-CV: string
404 Not Found

Não encontrado. Não existe nenhuma sessão com o ID de sessão fornecido.

Cabeçalhos

MS-CV: string
422 Unprocessable Entity

error_response

Entidade não processável. O valor maxLeaseTimeMinutes era inválido. Tem de ser maior do que o valor atual de maxLeaseTimeMinutes.

Cabeçalhos

MS-CV: string
429 Too Many Requests

Demasiados pedidos. O limite da taxa foi excedido. Repita a solicitação após a duração indicada 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 ao portador retornado pelo Serviço de Token Seguro de Realidade Mista. Consulte https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens para obter detalhes.

Tipo: apiKey
Em: header

Exemplos

Update a session

Pedido de amostra

PATCH 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": 72
}

Resposta da amostra

Código de estado:
200 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "arrInspectorPort": 50052,
  "handshakePort": 50051,
  "elapsedTimeMinutes": 10,
  "hostname": "d4cefb7b-10b9-4631-934d-67445ffa9126.remoterenderingvm.westus2.mixedreality.azure.com",
  "maxLeaseTimeMinutes": 72,
  "size": "Standard",
  "status": "Ready",
  "error": null,
  "teraflops": 10.6
}
Código de estado:
401 
WWW-Authenticate: Bearer error="invalid_token"
MS-CV: dKEFmka2kkSlDmp/af+sOw
Código de estado:
403 
MS-CV: dKEFmka2kkSlDmp/af+sOw
Código de estado:
404 
MS-CV: dKEFmka2kkSlDmp/af+sOw
Código de estado:
422 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "UnprocessableEntity",
    "message": "The request was malformed."
  }
}
Código de estado:
429 
Retry-After: 15
MS-CV: dKEFmka2kkSlDmp/af+sOw
Código de estado:
500 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "InternalServerError",
    "message": "An internal server error occurred."
  }
}

Definições

Name Description
error

O objeto de erro que contém detalhes do motivo da falha da solicitação.
error_response

A resposta de erro contendo detalhes do motivo da falha na solicitação.
session_properties

As propriedades de uma sessão de renderização.
session_size

O tamanho do servidor usado para a sessão de renderização. O tamanho afeta o número de polígonos que o servidor pode renderizar. Consulte https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes para obter detalhes.
session_status

O status da sessão de renderização. Os estados do terminal são 'Erro', 'Expirado' e 'Parado'.
update_session_settings

Configurações usadas para atualizar a sessão.

error

Object

O objeto de erro que contém detalhes do motivo da falha da solicitação.

Name Tipo Description
code

string

Código de 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 por humanos do erro.
target

string

O alvo do erro específico (por exemplo, o nome da propriedade em erro).

error_response

Object

A resposta de erro contendo detalhes do motivo da falha na solicitação.

Name Tipo Description
error

error

O objeto de erro que contém detalhes do motivo da falha da solicitação.

session_properties

Object

As propriedades de uma sessão de renderização.

Name Tipo Description
arrInspectorPort

integer

minimum: 49152
maximum: 65534

A porta TCP na qual a ferramenta Inspetor de Renderização Remota do Azure está hospedada.
creationTime

string (date-time)

A hora em que a sessão de renderização foi criada. Data e hora no formato ISO 8601.
elapsedTimeMinutes

integer

Quantidade de tempo em minutos em que a sessão está ou esteve no estado 'Pronto'. O tempo é arredondado para um minuto completo.
error

error

O objeto de erro que contém detalhes sobre a falha de inicialização da sessão de renderização.
handshakePort

integer

minimum: 49152
maximum: 65534

A porta TCP usada para o handshake ao estabelecer uma conexão.
hostname

string

O nome do host sob o qual a sessão de renderização é acessível.
id

string

A ID da sessão fornecida quando a sessão foi criada.
maxLeaseTimeMinutes

integer

O tempo, em minutos, a sessão será executada depois de atingir o estado 'Pronto'.
size

session_size

O tamanho do servidor usado para a sessão de renderização. O tamanho afeta o número de polígonos que o servidor pode renderizar. Consulte https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes para obter detalhes.
status

session_status

O status da sessão de renderização. Os estados do terminal são 'Erro', 'Expirado' e 'Parado'.
teraflops

number (float)

O poder computacional da GPU da sessão de renderização medido em teraflops.

session_size

Enumeração

O tamanho do servidor usado para a sessão de renderização. O tamanho afeta o número de polígonos que o servidor pode renderizar. Consulte https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes para obter detalhes.

Valor Description
Premium

Tamanho da sessão de renderização premium.
Standard

Tamanho padrão da sessão de renderização.

session_status

Enumeração

O status da sessão de renderização. Os estados do terminal são 'Erro', 'Expirado' e 'Parado'.

Valor Description
Error

A sessão de renderização encontrou um erro e está inutilizável. Este é um estado terminal.
Expired

A sessão de renderização entra no estado 'Expirado' quando estiver no estado 'Pronto' por mais tempo do que o tempo de concessão. Este é um estado terminal.
Ready

A sessão de renderização está pronta para conexões de entrada.
Starting

A sessão de renderização está começando, mas ainda não aceita conexões de entrada.
Stopped

A sessão de renderização foi interrompida com a operação 'Parar sessão'. Este é um estado terminal.

update_session_settings

Object

Configurações usadas para atualizar a sessão.

Name Tipo Description
maxLeaseTimeMinutes

integer

Atualize para a hora em que a sessão será executada depois de ter atingido o estado 'Pronto'. Tem de ser maior do que o valor atual de maxLeaseTimeMinutes e inferior a 1440.