Remote Rendering - Stop Session

Ссылка

Служба:: Mixed Reality

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

Останавливает определенный сеанс отрисовки.

POST {endpoint}/accounts/{account_id}/sessions/{session_id}/:stop?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.

Ответы

Имя	Тип	Описание
204 No Content		NoContent. Запрос на остановку выполнен успешно. Сеанс отрисовки остановлен. Заголовки MS-CV: string
401 Unauthorized		Не авторизовано. Отсутствует или недопустимая авторизация. Заголовки MS-CV: string WWW-Authenticate: string
403 Forbidden		Запрещено. Недостаточно авторизации для заданного ресурса. Заголовки MS-CV: string
404 Not Found		Не найдено. Сеанс с указанным идентификатором сеанса не существует. Заголовки 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

Примеры

Stop a session

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

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

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

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

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

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

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

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

MS-CV: dKEFmka2kkSlDmp/af+sOw

Код состояния:: 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	Ответ об ошибке, содержащий сведения о том, почему произошел сбой запроса.

error

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

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

error_response

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

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

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