Remote Rendering - List Conversions

Odwołanie

Usługa:: Mixed Reality

Wersja interfejsu API:: 2021-01-01

Pobiera listę wszystkich konwersji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
account_id	path	True	string uuid	Identyfikator konta usługi Azure Remote Rendering.
endpoint	path	True	string	Punkt końcowy do użycia, np. https://remoterendering.eastus.mixedreality.azure.com. Listę można znaleźć na stronie https://docs.microsoft.com/azure/remote-rendering/reference/regions.
api-version	query	True	string	Wersja interfejsu API, która ma być używana z żądaniem HTTP.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token elementu nośnego zwrócony przez usługę tokenu bezpiecznego Mixed Reality. Aby uzyskać szczegółowe informacje, zobacz opis funkcji https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	conversion_list	OK. Nagłówki MS-CV: string
401 Unauthorized		Brak autoryzacji. Brak lub nieprawidłowa autoryzacja. Nagłówki MS-CV: string WWW-Authenticate: string
403 Forbidden		Zakazane. Autoryzacja niewystarczająca dla danego zasobu. Nagłówki MS-CV: string
429 Too Many Requests		Zbyt wiele żądań. Przekroczono limit szybkości. Ponów próbę żądania po upływie czasu trwania podanego w nagłówku Retry-After. Nagłówki MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Błąd wewnętrzny. Serwer napotkał błąd wewnętrzny. Ponowienie próby żądania może spowodować pomyślne wyniki. Nagłówki MS-CV: string

Zabezpieczenia

Authorization

Token elementu nośnego zwrócony przez usługę tokenu bezpiecznego Mixed Reality. Aby uzyskać szczegółowe informacje, zobacz opis funkcji https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Typ: apiKey
W: header

Przykłady

List conversions

Przykładowe żądanie

HTTP

GET https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/conversions?api-version=2021-01-01

Przykładowa odpowiedź

Kod stanu:: 200

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "conversions": [
    {
      "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"
      }
    },
    {
      "id": "contoso-conversion-7da568fb-f3da-4b6d-ba75-d18c8e5a015e",
      "creationTime": "2021-02-02T11:11:11.111Z",
      "settings": {
        "inputLocation": {
          "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput",
          "blobPrefix": "models/",
          "relativeInputAssetPath": "barrel.fbx"
        },
        "outputLocation": {
          "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput",
          "blobPrefix": "conversionOutput/7da568fb-f3da-4b6d-ba75-d18c8e5a015e"
        }
      },
      "status": "Running",
      "error": null
    }
  ]
}

Kod stanu:: 401

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

Kod stanu:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Kod stanu:: 429

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

Kod stanu:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Definicje

Nazwa	Opis
conversion	Właściwości konwersji.
conversion_input_settings	Ustawienia danych wejściowych konwersji opisują pochodzenie danych wejściowych konwersji.
conversion_list	Lista konwersji.
conversion_output_settings	Ustawienia danych wyjściowych konwersji opisują miejsce docelowe danych wyjściowych konwersji.
conversion_settings	Ustawienia konwersji opisują pochodzenie plików wejściowych i miejsce docelowe plików wyjściowych.
conversion_status	Stan konwersji. Stany terminalu to "Anulowane", "Niepowodzenie" i "Powodzenie".
error	Obiekt błędu zawierający szczegółowe informacje o przyczynie niepowodzenia żądania.
error_response	Odpowiedź o błędzie zawierająca szczegółowe informacje o przyczynie niepowodzenia żądania.
Output	Informacje o danych wyjściowych pomyślnej konwersji. Występuje tylko wtedy, gdy stan konwersji to "Powodzenie".

conversion

Właściwości konwersji.

Nazwa	Typ	Opis
creationTime	string	Godzina utworzenia konwersji. Data i godzina w formacie ISO 8601.
error	error	Obiekt błędu zawierający szczegółowe informacje o niepowodzeniu konwersji.
id	string	Identyfikator konwersji podanej podczas tworzenia konwersji.
output	Output	Informacje o danych wyjściowych pomyślnej konwersji. Występuje tylko wtedy, gdy stan konwersji to "Powodzenie".
settings	conversion_settings	Ustawienia konwersji opisują pochodzenie plików wejściowych i miejsce docelowe plików wyjściowych.
status	conversion_status	Stan konwersji. Stany terminalu to "Anulowane", "Niepowodzenie" i "Powodzenie".

conversion_input_settings

Ustawienia danych wejściowych konwersji opisują pochodzenie danych wejściowych konwersji.

Nazwa	Typ	Opis
blobPrefix	string	W celu przeprowadzenia konwersji zostaną pobrane tylko obiekty blob rozpoczynające się od tego prefiksu. Opcjonalny. Jeśli nie zostanie podany, zostaną pobrane wszystkie obiekty blob z kontenera.
relativeInputAssetPath	string	Ścieżka względna rozpoczynająca się od parametru blobPrefix (lub w katalogu głównym kontenera, jeśli nie podano prefiksu obiektu blob) do modelu wejściowego. Musi wskazywać plik z obsługiwanym formatem pliku kończącym się. Aby uzyskać szczegółowe informacje, zobacz opis funkcji https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion.
storageContainerReadListSas	string	Sygnatura dostępu współdzielonego kontenera usługi Azure Blob Storage zapewniająca dostęp do odczytu i listy do kontenera magazynu. Opcjonalny. Jeśli nie zostanie podane, konto usługi Azure Remote Rendering musi być połączone z kontem magazynu zawierającym kontener obiektów blob. Aby uzyskać szczegółowe informacje, zobacz opis funkcji https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. Dla celów bezpieczeństwa to pole nigdy nie zostanie wypełnione w organach odpowiedzi.
storageContainerUri	string	Identyfikator URI kontenera usługi Azure Blob Storage zawierający model wejściowy.

conversion_list

Lista konwersji.

Nazwa	Typ	Opis
@nextLink	string	Jeśli dostępnych jest więcej konwersji, to pole będzie zawierać adres URL, pod którym można zażądać następnej partii konwersji. Ten adres URL będzie wymagał tego samego uwierzytelniania co wszystkie wywołania interfejsu API usługi Azure Remote Rendering.
conversions	conversion[]	Lista konwersji.

conversion_output_settings

Ustawienia danych wyjściowych konwersji opisują miejsce docelowe danych wyjściowych konwersji.

Nazwa	Typ	Opis
blobPrefix	string	Prefiks, który jest poprzedzony przed wszystkimi plikami utworzonymi przez proces konwersji. Będzie traktowany jako folder wirtualny. Opcjonalny. Jeśli nie zostanie podany, pliki wyjściowe będą przechowywane w katalogu głównym kontenera.
outputAssetFilename	string	Nazwa pliku elementu zawartości wyjściowej. Musi kończyć się ciągiem ".arrAsset". Opcjonalny. Jeśli nie zostanie podana, nazwa pliku będzie taka sama jak element zawartości wejściowej z rozszerzeniem ".arrAsset"
storageContainerUri	string	Identyfikator URI kontenera usługi Azure Blob Storage, w którym należy zapisać wynik konwersji.
storageContainerWriteSas	string	Sygnatura dostępu współdzielonego kontenera usługi Azure Blob Storage zapewniająca dostęp do zapisu do kontenera magazynu. Opcjonalny. Jeśli nie zostanie podane, konto usługi Azure Remote Rendering musi być połączone z kontem magazynu zawierającym kontener obiektów blob. Aby uzyskać szczegółowe informacje, zobacz opis funkcji https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. Dla celów bezpieczeństwa to pole nigdy nie zostanie wypełnione w organach odpowiedzi.

conversion_settings

Ustawienia konwersji opisują pochodzenie plików wejściowych i miejsce docelowe plików wyjściowych.

Nazwa	Typ	Opis
inputLocation	conversion_input_settings	Ustawienia danych wejściowych konwersji opisują pochodzenie danych wejściowych konwersji.
outputLocation	conversion_output_settings	Ustawienia danych wyjściowych konwersji opisują miejsce docelowe danych wyjściowych konwersji.

conversion_status

Stan konwersji. Stany terminalu to "Anulowane", "Niepowodzenie" i "Powodzenie".

Nazwa	Typ	Opis
Cancelled	string	Konwersja została anulowana. Jest to stan terminalu.
Failed	string	Konwersja nie powiodła się. Sprawdź pole "error", aby uzyskać więcej szczegółów. Jest to stan terminalu.
NotStarted	string	Konwersja została utworzona, ale nie została uruchomiona.
Running	string	Konwersja jest uruchomiona.
Succeeded	string	Konwersja zakończyła się pomyślnie. Sprawdź pole "output" (dane wyjściowe) pod kątem lokalizacji elementu zawartości wyjściowej. Jest to stan terminalu.

error

Obiekt błędu zawierający szczegółowe informacje o przyczynie niepowodzenia żądania.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innerError	error	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy określonego błędu (np. nazwa właściwości w błędzie).

error_response

Odpowiedź o błędzie zawierająca szczegółowe informacje o przyczynie niepowodzenia żądania.

Nazwa	Typ	Opis
error	error	Obiekt błędu zawierający szczegółowe informacje o przyczynie niepowodzenia żądania.

Output

Informacje o danych wyjściowych pomyślnej konwersji. Występuje tylko wtedy, gdy stan konwersji to "Powodzenie".

Nazwa	Typ	Opis
outputAssetUri	string	Identyfikator URI zasobu wygenerowanego przez proces konwersji.

Udostępnij za pośrednictwem