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

Remote Rendering - Create Session

  • Ссылка
Служба:
Mixed Reality
Версия API:
2021-01-01

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

PUT {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

Время в минутах, в течение которых сеанс будет выполняться после достижения состояния "Готово". Он должен находиться в диапазоне от 0 до 1440.
size True

session_size

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

Ответы

Имя Тип Описание
200 OK

session_properties

Все в порядке. Указывает, что уже был сеанс с теми же параметрами. Это ожидаемо при повторном создании сеанса.
201 Created

session_properties

Создан. Сеанс успешно создан.

Заголовки

MS-CV: string
400 Bad Request

error_response

Недопустимый запрос. Возвращенный объект ошибки описывает, какие проблемы произошли.

Заголовки

MS-CV: string
401 Unauthorized

Не авторизовано. Отсутствует или недопустимая авторизация.

Заголовки

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

Запрещено. Недостаточно авторизации для заданного ресурса.

Заголовки

MS-CV: string
429 Too Many Requests

Слишком много запросов. Превышено ограничение скорости. Повторите запрос по истечении длительности, указанной в заголовке Retry-After.

Заголовки

  • MS-CV: string
  • Retry-After: integer
500 Internal Server Error

error_response

Внутренняя ошибка. Сервер обнаружил внутреннюю ошибку. Повторная попытка запроса может привести к успешным результатам.

Заголовки

MS-CV: string
Other Status Codes

error_response

Конфликт. Сеанс отрисовки с идентификатором уже существует для учетной записи удаленной отрисовки.

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

Authorization

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

Тип: apiKey
В: header

Примеры

Create a rendering session

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

PUT 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": 60,
  "size": "Standard"
}

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

Код состояния:
201 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "maxLeaseTimeMinutes": 60,
  "size": "Standard",
  "status": "Starting",
  "error": null
}
Код состояния:
200 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "maxLeaseTimeMinutes": 60,
  "size": "Standard",
  "status": "Starting",
  "error": null
}
Код состояния:
400 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "BadRequest",
    "message": "The request was malformed."
  }
}
Код состояния:
409 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "Conflict",
    "message": "A resource already exists under the given ID."
  }
}
Код состояния:
401 
WWW-Authenticate: Bearer error="invalid_token"
MS-CV: dKEFmka2kkSlDmp/af+sOw
Код состояния:
403 
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."
  }
}

Определения

Имя Описание
create_session_settings

Параметры создаваемого сеанса.
error

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

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

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

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

Состояние сеанса отрисовки. Терминальными состояниями являются "Ошибка", "Истек срок действия" и "Остановлено".

create_session_settings

Параметры создаваемого сеанса.

Имя Тип Описание
maxLeaseTimeMinutes

integer

Время в минутах, в течение которых сеанс будет выполняться после достижения состояния "Готово". Он должен находиться в диапазоне от 0 до 1440.
size

session_size

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

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

Состояние сеанса отрисовки. Терминальными состояниями являются "Ошибка", "Истек срок действия" и "Остановлено".
teraflops

number

Вычислительная мощность GPU сеанса отрисовки, измеряемая в терафлопах.

session_size

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

Имя Тип Описание
Premium

string

Размер сеанса отрисовки уровня "Премиум".
Standard

string

Стандартный размер сеанса отрисовки.

session_status

Состояние сеанса отрисовки. Терминальными состояниями являются "Ошибка", "Истек срок действия" и "Остановлено".

Имя Тип Описание
Error

string

В сеансе отрисовки произошла ошибка, и он непригодный для использования. Это конечное состояние.
Expired

string

Сеанс отрисовки переходит в состояние "Просроченный", когда он был в состоянии "Готово" дольше времени аренды. Это конечное состояние.
Ready

string

Сеанс отрисовки готов для входящих подключений.
Starting

string

Сеанс отрисовки запускается, но пока не принимает входящие подключения.
Stopped

string

Сеанс отрисовки был остановлен с помощью операции "Остановить сеанс". Это конечное состояние.