Remote Rendering - Create Conversion

參考

服務:: Mixed Reality

API 版本:: 2021-01-01

使用儲存在 Azure Blob 儲存體帳戶中的資產建立轉換。

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

URI 參數

名稱	位於	必要	類型	Description
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	要與 HTTP 要求搭配使用的 API 版本。

要求標頭

名稱	必要	類型	Description
Authorization	True	string	Mixed Reality 安全令牌服務所傳回的持有人令牌。如需詳細資訊，請參閱＜https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens＞。

要求本文

名稱	必要	類型	Description
settings	True	conversion_settings	轉換設定描述輸入檔案的來源和輸出檔案的目的地。

回應

名稱	類型	Description
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

Mixed Reality 安全令牌服務所傳回的持有人令牌。如需詳細資訊，請參閱＜https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens＞。

類型: apiKey
位於: header

範例

Create a conversion

範例要求

HTTP

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."
  }
}

定義

名稱	Description
conversion	轉換的屬性。
conversion_input_settings	轉換輸入設定描述轉換輸入的來源。
conversion_output_settings	轉換輸出設定描述轉換輸出的目的地。
conversion_settings	轉換設定描述輸入檔案的來源和輸出檔案的目的地。
conversion_status	轉換的狀態。終端機狀態為「已取消」、「失敗」和「成功」。
create_conversion_settings	啟動轉換的要求
error	錯誤物件，包含要求失敗原因的詳細數據。
error_response	錯誤回應，其中包含要求失敗原因的詳細數據。
Output	成功轉換輸出的相關信息。只有在轉換狀態為「成功」時才存在。

conversion

轉換的屬性。

名稱	類型	Description
creationTime	string	建立轉換的時間。 ISO 8601 格式的日期和時間。
error	error	包含轉換失敗詳細數據的錯誤物件。
id	string	建立轉換時提供的轉換標識碼。
output	Output	成功轉換輸出的相關信息。只有在轉換狀態為「成功」時才存在。
settings	conversion_settings	轉換設定描述輸入檔案的來源和輸出檔案的目的地。
status	conversion_status	轉換的狀態。終端機狀態為「已取消」、「失敗」和「成功」。

conversion_input_settings

轉換輸入設定描述轉換輸入的來源。

名稱	類型	Description
blobPrefix	string	只會下載開頭為這個前置詞的 Blob，以執行轉換。選擇性。如果未提供，則會下載來自容器的所有 Blob。
relativeInputAssetPath	string	如果 blobPrefix 未提供 blobPrefix) 至輸入模型，則從 blobPrefix 開始的相對路徑 (或容器根目錄。必須指向結尾為支援的檔案格式的檔案。如需詳細資訊，請參閱＜https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion＞。
storageContainerReadListSas	string	Azure Blob 記憶體容器共用存取簽章，可讀取和列出記憶體容器的存取權。選擇性。如果未提供，Azure 遠端轉譯帳戶必須與包含 Blob 容器的記憶體帳戶連結。如需詳細資訊，請參閱＜https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts＞。基於安全性目的，此欄位永遠不會在響應主體中填寫。
storageContainerUri	string	包含輸入模型的 Azure Blob 記憶體容器 URI。

conversion_output_settings

轉換輸出設定描述轉換輸出的目的地。

名稱	類型	Description
blobPrefix	string	前置詞，前置於轉換程式所產生的所有檔案前面。將會被視為虛擬資料夾。選擇性。如果未提供，輸出檔案將會儲存在容器根目錄。
outputAssetFilename	string	輸出資產的檔名。必須以『.arrAsset』結尾。選擇性。如果未提供，檔名會與輸入資產同名，擴展名為 '.arrAsset'
storageContainerUri	string	應寫入轉換結果的 Azure Blob 記憶體容器 URI。
storageContainerWriteSas	string	Azure Blob 記憶體容器共用存取簽章，可提供記憶體容器的寫入許可權。選擇性。如果未提供，Azure 遠端轉譯帳戶必須與包含 Blob 容器的記憶體帳戶連結。如需詳細資訊，請參閱＜https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts＞。基於安全性目的，此欄位永遠不會在響應主體中填寫。

conversion_settings

轉換設定描述輸入檔案的來源和輸出檔案的目的地。

名稱	類型	Description
inputLocation	conversion_input_settings	轉換輸入設定描述轉換輸入的來源。
outputLocation	conversion_output_settings	轉換輸出設定描述轉換輸出的目的地。

conversion_status

轉換的狀態。終端機狀態為「已取消」、「失敗」和「成功」。

名稱	類型	Description
Cancelled	string	轉換已取消。這是終端機狀態。
Failed	string	轉換失敗。如需詳細資訊，請查看 [錯誤] 欄位。這是終端機狀態。
NotStarted	string	已建立轉換，但尚未啟動。
Running	string	轉換正在執行。
Succeeded	string	轉換成功。檢查輸出資產位置的 [輸出] 欄位。這是終端機狀態。

create_conversion_settings

啟動轉換的要求

名稱	類型	Description
settings	conversion_settings	轉換設定描述輸入檔案的來源和輸出檔案的目的地。

error

錯誤物件，包含要求失敗原因的詳細數據。

名稱	類型	Description
code	string	錯誤碼。
details	error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innerError	error	物件，包含比目前對象有關錯誤更具體的資訊。
message	string	人類可讀取的錯誤表示法。
target	string	特定錯誤的目標 (例如錯誤) 中的屬性名稱。

error_response

錯誤回應，其中包含要求失敗原因的詳細數據。

名稱	類型	Description
error	error	錯誤物件，包含要求失敗原因的詳細數據。

Output

成功轉換輸出的相關信息。只有在轉換狀態為「成功」時才存在。

名稱	類型	Description
outputAssetUri	string	轉換程式所產生的資產 URI。

共用方式為