共用方式為

Remote Rendering - Create Session

  • 參考
服務:
Mixed Reality
API 版本:
2021-01-01

建立新的轉譯會話。

PUT {endpoint}/accounts/{account_id}/sessions/{session_id}?api-version=2021-01-01

URI 參數

名稱 位於 必要 類型 Description
account_id
 path True

string (uuid)

Azure 遠端轉譯帳戶標識碼。
endpoint
 path True

string

要使用的端點，例如 https://remoterendering.eastus.mixedreality.azure.com。 您可以在 https://docs.microsoft.com/azure/remote-rendering/reference/regions找到清單。
session_id
 path True

string

標識符，可唯一識別指定帳戶的轉譯會話。 標識符區分大小寫，可以包含英數位元的任何組合，包括連字元和底線，而且不能包含超過 256 個字元。
api-version
 query True

string

要與 HTTP 要求搭配使用的 API 版本。

要求標頭

名稱 必要 類型 Description
Authorization True

string

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

要求本文

名稱 必要 類型 Description
maxLeaseTimeMinutes True

integer

會話在達到「就緒」狀態之後，會執行以分鐘為單位的時間。 它必須介於 0 到 1440 之間。
size True

session_size

用於轉譯會話的伺服器大小。 大小會影響伺服器可以轉譯的多邊形數目。 如需詳細資訊，請參閱 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes。

回應

名稱 類型 Description
200 OK

session_properties

還行。 表示已經有具有相同設定的會話。 重試會話建立時，這是預期的。
201 Created

session_properties

創建。 已成功建立會話。

標題

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

內部錯誤。 伺服器發生內部錯誤。 重試要求可能會產生成功的結果。

標題

MS-CV: string
Other Status Codes

error_response

衝突。 具有標識符的轉譯會話已存在遠程轉譯帳戶。

安全性

Authorization

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

類型: apiKey
位於: header

範例

Create a rendering session

範例要求

PUT https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/sessions/contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28?api-version=2021-01-01

{
  "maxLeaseTimeMinutes": 60,
  "size": "Standard"
}

範例回覆

狀態碼:
201 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "maxLeaseTimeMinutes": 60,
  "size": "Standard",
  "status": "Starting",
  "error": null
}
狀態碼:
200 
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "maxLeaseTimeMinutes": 60,
  "size": "Standard",
  "status": "Starting",
  "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
create_session_settings

要建立之會話的設定。
error

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

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

轉譯會話的屬性。
session_size

用於轉譯會話的伺服器大小。 大小會影響伺服器可以轉譯的多邊形數目。 如需詳細資訊，請參閱 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes。
session_status

轉譯會話的狀態。 終端機狀態為 「錯誤」、「已過期」和「已停止」。

create_session_settings

Object

要建立之會話的設定。

名稱 類型 Description
maxLeaseTimeMinutes

integer

會話在達到「就緒」狀態之後，會執行以分鐘為單位的時間。 它必須介於 0 到 1440 之間。
size

session_size

用於轉譯會話的伺服器大小。 大小會影響伺服器可以轉譯的多邊形數目。 如需詳細資訊，請參閱 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes。

error

Object

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

名稱 類型 Description
code

string

錯誤碼。
details

error[]

導致此錯誤之特定錯誤的詳細數據陣列。
innerError

error

物件，包含與目前對象有關錯誤更具體的資訊。
message

string

錯誤的人類可讀取表示法。
target

string

特定錯誤的目標（例如，錯誤中的屬性名稱）。

error_response

Object

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

名稱 類型 Description
error

error

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

session_properties

Object

轉譯會話的屬性。

名稱 類型 Description
arrInspectorPort

integer

minimum: 49152
maximum: 65534

裝載 Azure 遠端轉譯偵測器工具的 TCP 連接埠。
creationTime

string (date-time)

建立轉譯會話的時間。 ISO 8601 格式的日期和時間。
elapsedTimeMinutes

integer

會話處於或處於「就緒」狀態的分鐘數。 時間會四捨五入為整分鐘。
error

error

錯誤物件，包含轉譯會話啟動失敗的詳細數據。
handshakePort

integer

minimum: 49152
maximum: 65534

建立連線時用於交握的 TCP 連接埠。
hostname

string

可連線到轉譯會話的主機名。
id

string

建立工作階段時提供的會話標識碼。
maxLeaseTimeMinutes

integer

會話在達到「就緒」狀態之後，會執行以分鐘為單位的時間。
size

session_size

用於轉譯會話的伺服器大小。 大小會影響伺服器可以轉譯的多邊形數目。 如需詳細資訊，請參閱 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes。
status

session_status

轉譯會話的狀態。 終端機狀態為 「錯誤」、「已過期」和「已停止」。
teraflops

number (float)

以 Teraflops 測量之轉譯會話 GPU 的計算能力。

session_size

列舉型別

用於轉譯會話的伺服器大小。 大小會影響伺服器可以轉譯的多邊形數目。 如需詳細資訊，請參閱 https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes。

值 Description
Premium

進階轉譯會話大小。
Standard

標準轉譯會話大小。

session_status

列舉型別

轉譯會話的狀態。 終端機狀態為 「錯誤」、「已過期」和「已停止」。

值 Description
Error

轉譯會話發生錯誤，且無法使用。 這是終端機狀態。
Expired

當轉譯會話處於「就緒」狀態超過租用時間時，轉譯會話會進入「已過期」狀態。 這是終端機狀態。
Ready

轉譯會話已準備好進行連入連線。
Starting

轉譯會話正在啟動，但尚未接受連入連線。
Stopped

轉譯會話已使用「停止會話」作業停止。 這是終端機狀態。