你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Remote Rendering - Get Conversion

获取特定转换的状态。

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

URI 参数

名称 必需 类型 说明
account_id
path True

string (uuid)

Azure 远程渲染帐户 ID。

conversion_id
path True

string

唯一标识给定帐户转换的 ID。 ID 区分大小写,可以包含字母数字字符(包括连字符和下划线)的任意组合,并且不能包含超过 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 版本。

请求头

名称 必需 类型 说明
Authorization True

string

混合现实安全令牌服务返回的持有者令牌。 有关详细信息,请参阅 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

找不到。 不存在具有提供的转换 ID 的转换。

标头

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

混合现实安全令牌服务返回的持有者令牌。 有关详细信息,请参阅 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

示例响应

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"
  }
}
WWW-Authenticate: Bearer error="invalid_token"
MS-CV: dKEFmka2kkSlDmp/af+sOw
MS-CV: dKEFmka2kkSlDmp/af+sOw
MS-CV: dKEFmka2kkSlDmp/af+sOw
Retry-After: 15
MS-CV: dKEFmka2kkSlDmp/af+sOw
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

转换的状态。 终端状态为“Cancelled”、“Failed”和“Succeeded”。

error

包含请求失败原因的详细信息的错误对象。

error_response

包含请求失败原因的详细信息的错误响应。

Output

有关成功转换的输出的信息。 仅当转换状态为“Succeeded”时才存在。

conversion

转换的属性。

名称 类型 说明
creationTime

string (date-time)

创建转换的时间。 采用 ISO 8601 格式的日期和时间。

error

error

包含有关转换失败的详细信息的错误对象。

id

string

创建转换时提供的转换的 ID。

output

Output

有关成功转换的输出的信息。 仅当转换状态为“Succeeded”时才存在。

settings

conversion_settings

转换设置描述输入文件和输出文件的目的地。

status

conversion_status

转换的状态。 终端状态为“Cancelled”、“Failed”和“Succeeded”。

conversion_input_settings

转换输入设置描述转换输入的来源。

名称 类型 说明
blobPrefix

string

仅下载以此前缀开头的 Blob 才能执行转换。 可选。 如果未提供,则会下载容器中的所有 Blob。

relativeInputAssetPath

string

从 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 (uri)

包含输入模型的 Azure Blob 存储容器的 URI。

conversion_output_settings

转换输出设置描述转换输出的目标。

名称 类型 说明
blobPrefix

string

一个前缀,该前缀在转换过程生成的所有文件前面追加。 将被视为虚拟文件夹。 可选。 如果未提供,输出文件将存储在容器根目录中。

outputAssetFilename

string

输出资产的文件名。 必须以“.arrAsset”结尾。 可选。 如果未提供,文件名将与输入资产的名称相同,扩展名为“.arrAsset”

storageContainerUri

string (uri)

应将转换结果写入到的 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

转换设置描述输入文件和输出文件的目的地。

名称 类型 说明
inputLocation

conversion_input_settings

转换输入设置描述转换输入的来源。

outputLocation

conversion_output_settings

转换输出设置描述转换输出的目标。

conversion_status

转换的状态。 终端状态为“Cancelled”、“Failed”和“Succeeded”。

说明
Cancelled

转换已取消。 这是一种终端状态。

Failed

转换失败。 有关更多详细信息,请查看“错误”字段。 这是一种终端状态。

NotStarted

转换已创建,但尚未启动。

Running

转换正在运行。

Succeeded

转换已成功。 检查输出资产位置的“输出”字段。 这是一种终端状态。

error

包含请求失败原因的详细信息的错误对象。

名称 类型 说明
code

string

错误代码。

details

error[]

导致此报告错误的特定错误的详细信息数组。

innerError

error

包含与当前对象有关错误的更具体信息的对象。

message

string

错误的人工可读表示形式。

target

string

特定错误的目标(例如错误属性的名称)。

error_response

包含请求失败原因的详细信息的错误响应。

名称 类型 说明
error

error

包含请求失败原因的详细信息的错误对象。

Output

有关成功转换的输出的信息。 仅当转换状态为“Succeeded”时才存在。

名称 类型 说明
outputAssetUri

string (uri)

转换过程生成的资产的 URI。