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

Remote Rendering - Create Conversion

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

Создает преобразование с использованием ресурса, хранящегося в учетной записи Хранилище BLOB-объектов Azure.

PUT {endpoint}/accounts/{account_id}/conversions/{conversion_id}?api-version=2021-01-01

Параметры URI

Имя В Обязательно Тип Описание
account_id
 path True

string

uuid

Идентификатор учетной записи azure Удаленная отрисовка.
conversion_id
 path True

string

Идентификатор, однозначно определяющий преобразование для данной учетной записи. Идентификатор учитывает регистр, может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 256 символов.
endpoint
 path True

string

Используемая конечная точка, например https://remoterendering.eastus.mixedreality.azure.com. Список можно найти по адресу https://docs.microsoft.com/azure/remote-rendering/reference/regions.
api-version
 query True

string

Версия API, используемая с HTTP-запросом.

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

Имя Обязательно Тип Описание
Authorization True

string

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

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

Имя Обязательно Тип Описание
settings True

conversion_settings

Параметры преобразования описывают источник входных файлов и назначение выходных файлов.

Ответы

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

conversion

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

Заголовки

MS-CV: string
201 Created

conversion

Создан. Было создано новое преобразование.

Заголовки

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

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

error_response

Конфликт. Преобразование уже существует. Объект ошибки описывает возникшие проблемы.

Заголовки

MS-CV: string

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

Authorization

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

Тип: apiKey
В: header

Примеры

Create a conversion

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

PUT https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/conversions/contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e?api-version=2021-01-01

{
  "settings": {
    "inputLocation": {
      "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput",
      "blobPrefix": "models/",
      "relativeInputAssetPath": "house.fbx"
    },
    "outputLocation": {
      "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput",
      "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e",
      "outputAssetFilename": "convertedHouse.arrAsset"
    }
  }
}

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

Код состояния:
201 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e",
  "creationTime": "2021-01-01T11:11:11.111Z",
  "settings": {
    "inputLocation": {
      "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput",
      "blobPrefix": "models/",
      "relativeInputAssetPath": "house.fbx"
    },
    "outputLocation": {
      "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput",
      "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e",
      "outputAssetFilename": "convertedHouse.arrAsset"
    }
  },
  "status": "NotStarted",
  "error": null
}
Код состояния:
200 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e",
  "creationTime": "2021-01-01T11:11:11.111Z",
  "settings": {
    "inputLocation": {
      "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput",
      "blobPrefix": "models/",
      "relativeInputAssetPath": "house.fbx"
    },
    "outputLocation": {
      "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput",
      "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e",
      "outputAssetFilename": "convertedHouse.arrAsset"
    }
  },
  "status": "NotStarted",
  "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."
  }
}

Определения

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

Свойства преобразования.
conversion_input_settings

Параметры входных данных преобразования описывают источник входных данных преобразования.
conversion_output_settings

Параметры выходных данных преобразования описывают назначение выходных данных преобразования.
conversion_settings

Параметры преобразования описывают источник входных файлов и назначение выходных файлов.
conversion_status

Состояние преобразования. Состояния терминала: "Отменено", "Сбой" и "Успешно".
create_conversion_settings

Запрос на запуск преобразования
error

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

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

Сведения о выходных данных успешного преобразования. Отображается только в том случае, если для преобразования задано состояние "Успешно".

conversion

Свойства преобразования.

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

string

Время создания преобразования. Дата и время в формате ISO 8601.
error

error

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

string

Идентификатор преобразования, предоставленного при создании преобразования.
output

Output

Сведения о выходных данных успешного преобразования. Отображается только в том случае, если для преобразования задано состояние "Успешно".
settings

conversion_settings

Параметры преобразования описывают источник входных файлов и назначение выходных файлов.
status

conversion_status

Состояние преобразования. Состояния терминала: "Отменено", "Сбой" и "Успешно".

conversion_input_settings

Параметры входных данных преобразования описывают источник входных данных преобразования.

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

string

Для выполнения преобразования будут загружены только большие двоичные объекты, начинающиеся с этого префикса. Необязательный элемент. Если этот параметр не указан, будут загружены все большие двоичные объекты из контейнера.
relativeInputAssetPath

string

Относительный путь, начинающийся с blobPrefix (или в корне контейнера, если blobPrefix не указан) к входной модели. Должен указывать на файл с поддерживаемым форматом, заканчивающийся. Дополнительные сведения см. в разделе https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion.
storageContainerReadListSas

string

Подписанный URL-адрес контейнера хранилища BLOB-объектов Azure, предоставляющий доступ на чтение и получение списка к контейнеру хранилища. Необязательный элемент. Если этот параметр не указан, учетная запись Удаленная отрисовка Azure должна быть связана с учетной записью хранения, содержащей контейнер BLOB-объектов. Дополнительные сведения см. в разделе https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. В целях безопасности это поле никогда не заполняется в органах ответов.
storageContainerUri

string

Универсальный код ресурса (URI) контейнера хранилища BLOB-объектов Azure, содержащего входную модель.

conversion_output_settings

Параметры выходных данных преобразования описывают назначение выходных данных преобразования.

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

string

Префикс, который добавляется перед всеми файлами, созданными в процессе преобразования. Будет рассматриваться как виртуальная папка. Необязательный элемент. Если этот параметр не указан, выходные файлы будут храниться в корневом каталоге контейнера.
outputAssetFilename

string

Имя файла выходного ресурса. Должен заканчиваться на .arrAsset. Необязательный элемент. Если оно не указано, имя файла будет совпадать с именем входного ресурса с расширением arrAsset.
storageContainerUri

string

Универсальный код ресурса (URI) контейнера хранилища BLOB-объектов Azure, в который должен быть записан результат преобразования.
storageContainerWriteSas

string

Подписанный URL-адрес контейнера хранилища BLOB-объектов Azure, предоставляющий доступ на запись к контейнеру хранилища. Необязательный элемент. Если этот параметр не указан, учетная запись Удаленная отрисовка Azure должна быть связана с учетной записью хранения, содержащей контейнер BLOB-объектов. Дополнительные сведения см. в разделе https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. В целях безопасности это поле никогда не заполняется в органах ответов.

conversion_settings

Параметры преобразования описывают источник входных файлов и назначение выходных файлов.

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

conversion_input_settings

Параметры входных данных преобразования описывают источник входных данных преобразования.
outputLocation

conversion_output_settings

Параметры выходных данных преобразования описывают назначение выходных данных преобразования.

conversion_status

Состояние преобразования. Состояния терминала: "Отменено", "Сбой" и "Успешно".

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

string

Преобразование было отменено. Это конечное состояние.
Failed

string

Преобразование завершилось сбоем. Дополнительные сведения см. в поле error. Это конечное состояние.
NotStarted

string

Преобразование было создано, но не началось.
Running

string

Преобразование выполняется.
Succeeded

string

Преобразование выполнено успешно. Проверьте расположение выходного ресурса в поле output. Это конечное состояние.

create_conversion_settings

Запрос на запуск преобразования

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

conversion_settings

Параметры преобразования описывают источник входных файлов и назначение выходных файлов.

error

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

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

string

Код ошибки.
details

error[]

Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
innerError

error

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

string

Удобочитаемое представление ошибки.
target

string

Целевой объект конкретной ошибки (например, имя свойства в ошибке).

error_response

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

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

error

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

Output

Сведения о выходных данных успешного преобразования. Отображается только в том случае, если для преобразования задано состояние "Успешно".

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

string

URI ресурса, созданного процессом преобразования.