Remote Rendering - Update Session

Ссылка

Служба:: Mixed Reality

Версия API:: 2021-01-01

Обновления максимальное время аренды определенного сеанса отрисовки.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
account_id	path	True	string uuid	Идентификатор учетной записи Azure Удаленная отрисовка.
endpoint	path	True	string	Используемая конечная точка, например https://remoterendering.eastus.mixedreality.azure.com. Список можно найти по адресу https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id	path	True	string	Идентификатор, однозначно определяющий сеанс отрисовки для заданной учетной записи. Идентификатор учитывает регистр, может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 256 символов.
api-version	query	True	string	Версия API, используемая с HTTP-запросом.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Authorization	True	string	Маркер носителя, возвращаемый службой Смешанная реальность secure Token Service. Дополнительные сведения см. в разделе https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Текст запроса

Имя	Обязательно	Тип	Описание
maxLeaseTimeMinutes	True	integer	Обновите до времени, когда сеанс будет выполняться после достижения состояния "Готово". Оно должно быть больше текущего значения maxLeaseTimeMinutes и меньше 1440.

Ответы

Имя	Тип	Описание
200 OK	session_properties	Все в порядке. Сеанс обновлен.
401 Unauthorized		Не авторизовано. Отсутствует или недопустимая авторизация. Заголовки MS-CV: string WWW-Authenticate: string
403 Forbidden		Запрещено. Недостаточно авторизации для заданного ресурса. Заголовки MS-CV: string
404 Not Found		Не найдено. Сеанс с указанным идентификатором сеанса не существует. Заголовки MS-CV: string
422 Unprocessable Entity	error_response	Необработаемая сущность. Недопустимое значение maxLeaseTimeMinutes. Оно должно быть больше текущего значения maxLeaseTimeMinutes. Заголовки MS-CV: string
429 Too Many Requests		Слишком много запросов. Превышен предел скорости. Повторите запрос по истечении длительности, указанной в заголовке Retry-After. Заголовки MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Внутренняя ошибка. Сервер столкнулся с внутренней ошибкой. Повторная попытка запроса может привести к успешному результату. Заголовки MS-CV: string

Безопасность

Authorization

Маркер носителя, возвращаемый службой Смешанная реальность secure Token Service. Дополнительные сведения см. в разделе https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Тип: apiKey
В: header

Примеры

Update a session

Образец запроса

HTTP

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
}

Пример ответа

Код состояния:: 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
}

Код состояния:: 401

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

Код состояния:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Код состояния:: 404

MS-CV: dKEFmka2kkSlDmp/af+sOw

Код состояния:: 422

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Код состояния:: 429

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

Код состояния:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Определения

Имя	Описание
error	Объект ошибки, содержащий сведения о том, почему произошел сбой запроса.
error_response	Ответ об ошибке, содержащий сведения о том, почему произошел сбой запроса.
session_properties	Свойства сеанса отрисовки.
session_size	Размер сервера, используемого для сеанса отрисовки. Размер влияет на количество многоугольников, которые сервер может отрисовыть. Подробные сведения см. в разделе https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.
session_status	Состояние сеанса отрисовки. Состояния терминала: Error, Expired и Stopped.
update_session_settings	Параметры, используемые для обновления сеанса.

error

Объект ошибки, содержащий сведения о том, почему произошел сбой запроса.

Имя	Тип	Описание
code	string	Код ошибки.
details	error[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
innerError	error	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Понятное представление ошибки.
target	string	Целевой объект конкретной ошибки (например, имя свойства в ошибке).

error_response

Ответ об ошибке, содержащий сведения о том, почему произошел сбой запроса.

Имя	Тип	Описание
error	error	Объект ошибки, содержащий сведения о том, почему произошел сбой запроса.

session_properties

Свойства сеанса отрисовки.

Имя	Тип	Описание
arrInspectorPort	integer	TCP-порт, на котором размещается средство Azure Удаленная отрисовка Inspector.
creationTime	string	Время создания сеанса отрисовки. Дата и время в формате ISO 8601.
elapsedTimeMinutes	integer	Время в минутах, в течение которого сеанс находится или находится в состоянии "Готово". Время округляется до полной минуты.
error	error	Объект ошибки, содержащий сведения о сбое запуска сеанса отрисовки.
handshakePort	integer	TCP-порт, используемый для подтверждения при установке подключения.
hostname	string	Имя узла, под которым доступен сеанс отрисовки.
id	string	Идентификатор сеанса, указанного при создании сеанса.
maxLeaseTimeMinutes	integer	Время в минутах, в течение которых сеанс будет выполняться после достижения состояния "Готово".
size	session_size	Размер сервера, используемого для сеанса отрисовки. Размер влияет на количество многоугольников, которые сервер может отрисовыть. Подробные сведения см. в разделе https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.
status	session_status	Состояние сеанса отрисовки. Состояния терминала: Error, Expired и Stopped.
teraflops	number	Вычислительная мощность GPU сеанса отрисовки измеряется в терафлопах.

session_size

Размер сервера, используемого для сеанса отрисовки. Размер влияет на количество многоугольников, которые сервер может отрисовыть. Подробные сведения см. в разделе https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.

Имя	Тип	Описание
Premium	string	Размер сеанса отрисовки уровня "Премиум".
Standard	string	Стандартный размер сеанса отрисовки.

session_status

Состояние сеанса отрисовки. Состояния терминала: Error, Expired и Stopped.

Имя	Тип	Описание
Error	string	В сеансе отрисовки произошла ошибка, и он непригодный для использования. Это конечное состояние.
Expired	string	Сеанс отрисовки переходит в состояние "Истек срок действия", когда он был в состоянии "Готово" дольше времени аренды. Это конечное состояние.
Ready	string	Сеанс отрисовки готов для входящих подключений.
Starting	string	Сеанс отрисовки запускается, но пока не принимает входящие подключения.
Stopped	string	Сеанс отрисовки был остановлен с помощью операции "Остановить сеанс". Это конечное состояние.

update_session_settings

Параметры, используемые для обновления сеанса.

Имя	Тип	Описание
maxLeaseTimeMinutes	integer	Обновите до времени, когда сеанс будет выполняться после достижения состояния "Готово". Оно должно быть больше текущего значения maxLeaseTimeMinutes и меньше 1440.

Поделиться через