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

Remote Rendering - Get Conversion

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

Возвращает состояние определенного преобразования.

GET {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.

Ответы

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

conversion

Все в порядке.

Заголовки

  • MS-CV: string
  • Retry-After: integer
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

Примеры

Get a single conversion by ID

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

GET 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

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

Код состояния:
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": "Succeeded",
  "error": null,
  "output": {
    "outputAssetUri": "https://contosostorage01.blob.core.windows.net/arroutput/conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e/convertedHouse.arrAsset"
  }
}
Код состояния:
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."
  }
}

Определения

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

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

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

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

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

Состояние преобразования. Состояния терминала: "Отменено", "Сбой" и "Успешно".
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 для определения расположения выходного ресурса. Это конечное состояние.

error

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

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

string

Код ошибки.
details

error[]

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

error

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

string

Понятное представление ошибки.
target

string

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

error_response

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

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

error

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

Output

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

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

string

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