Remote Rendering - Create Session

リファレンス

Service:: Mixed Reality

API Version:: 2021-01-01

新しいレンダリングセッションを作成します。

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

URI パラメーター

名前	/	必須	型	説明
account_id	path	True	string uuid	Azure Remote Rendering アカウント ID。
endpoint	path	True	string	使用するエンドポイント (例: https://remoterendering.eastus.mixedreality.azure.com)。リストはにあります https://docs.microsoft.com/azure/remote-rendering/reference/regions。
session_id	path	True	string	特定のアカウントのレンダリングセッションを一意に識別する ID。 ID では大文字と小文字が区別され、ハイフンやアンダースコアを含む英数字の任意の組み合わせを含めることができます。また、256 文字を超えることはできません。
api-version	query	True	string	HTTP 要求で使用される API バージョン。

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	セキュリティで保護されたトークンサービスによって返されるベアラートークンMixed Reality。詳細については、https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens を参照してください。

要求本文

名前	必須	型	説明
maxLeaseTimeMinutes	True	integer	"準備完了" 状態に達した後にセッションが実行される時間 (分単位)。 0 から 1440 の間である必要があります。
size	True	session_size	レンダリングセッションに使用されるサーバーのサイズ。サイズは、サーバーがレンダリングできるポリゴンの数に影響します。詳細については、https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes を参照してください。

応答

名前	型	説明
200 OK	session_properties	OK です。同じ設定のセッションが既に存在することを示します。これは、セッションの作成が再試行されるときに想定されます。
201 Created	session_properties	作成されました。セッションが正常に作成されました。 Headers MS-CV: string
400 Bad Request	error_response	正しくない要求。返されたエラーオブジェクトは、発生した問題を示します。 Headers MS-CV: string
401 Unauthorized		権限がありません。承認が見つからないか無効です。 Headers MS-CV: string WWW-Authenticate: string
403 Forbidden		Forbidden. 特定のリソースに対する承認が不十分です。 Headers MS-CV: string
500 Internal Server Error	error_response	内部エラー。サーバーで内部エラーが発生しました。要求を再試行すると、正常な結果が生成される可能性があります。 Headers MS-CV: string
Other Status Codes	error_response	競合しています。 ID を持つレンダリングセッションは、リモートレンダリングアカウント用に既に存在します。
Other Status Codes		要求が多すぎます。レート制限を超えました。 Retry-After ヘッダーで指定された期間が経過したら、要求を再試行します。 Headers MS-CV: string Retry-After: integer

セキュリティ

Authorization

セキュリティで保護されたトークンサービスによって返されるベアラートークンMixed Reality。詳細については、https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens を参照してください。

Type: apiKey
In: header

例

Create a rendering session

Sample Request

HTTP

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

Sample Response

Status code:: 201

MS-CV: dKEFmka2kkSlDmp/af+sOw

Response Body

{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "maxLeaseTimeMinutes": 60,
  "size": "Standard",
  "status": "Starting",
  "error": null
}

Status code:: 200

MS-CV: dKEFmka2kkSlDmp/af+sOw

Response Body

{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "maxLeaseTimeMinutes": 60,
  "size": "Standard",
  "status": "Starting",
  "error": null
}

Status code:: 400

MS-CV: dKEFmka2kkSlDmp/af+sOw

Response Body

{
  "error": {
    "code": "BadRequest",
    "message": "The request was malformed."
  }
}

Status code:: 409

MS-CV: dKEFmka2kkSlDmp/af+sOw

Response Body

{
  "error": {
    "code": "Conflict",
    "message": "A resource already exists under the given ID."
  }
}

Status code:: 401

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

Status code:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Status code:: 429

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

Status code:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

Response Body

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

定義

名前	説明
create_session_settings	作成するセッションの設定。
error	要求が失敗した理由の詳細を含む error オブジェクト。
error_response	要求が失敗した理由の詳細を含むエラー応答。
session_properties	レンダリングセッションのプロパティ。
session_size	レンダリングセッションに使用されるサーバーのサイズ。サイズは、サーバーがレンダリングできるポリゴンの数に影響します。詳細については、https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes を参照してください。
session_status	レンダリングセッションの状態。ターミナルの状態は、'Error'、'Expired'、および 'Stopped' です。

create_session_settings

作成するセッションの設定。

名前	型	説明
maxLeaseTimeMinutes	integer	"準備完了" 状態に達した後にセッションが実行される時間 (分単位)。 0 から 1440 の間である必要があります。
size	session_size	レンダリングセッションに使用されるサーバーのサイズ。サイズは、サーバーがレンダリングできるポリゴンの数に影響します。詳細については、https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes を参照してください。

error

要求が失敗した理由の詳細を含む error オブジェクト。

名前	型	説明
code	string	エラーコード。
details	error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innerError	error	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。

error_response

要求が失敗した理由の詳細を含むエラー応答。

名前	型	説明
error	error	要求が失敗した理由の詳細を含む error オブジェクト。

session_properties

レンダリングセッションのプロパティ。

名前	型	説明
arrInspectorPort	integer	Azure Remote Rendering Inspector ツールがホストされている TCP ポート。
creationTime	string	レンダリングセッションが作成された時刻。 ISO 8601 形式の日付と時刻。
elapsedTimeMinutes	integer	セッションが "準備完了" 状態であったか、または "準備完了" 状態であった時間 (分単位)。時間は 1 分に切り捨てられます。
error	error	レンダリングセッションのスタートアップエラーに関する詳細を含む error オブジェクト。
handshakePort	integer	接続を確立するときにハンドシェイクに使用される TCP ポート。
hostname	string	レンダリングセッションに到達できるホスト名。
id	string	セッションの作成時に指定されたセッションの ID。
maxLeaseTimeMinutes	integer	"準備完了" 状態に達した後にセッションが実行される時間 (分単位)。
size	session_size	レンダリングセッションに使用されるサーバーのサイズ。サイズは、サーバーがレンダリングできるポリゴンの数に影響します。詳細については、https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes を参照してください。
status	session_status	レンダリングセッションの状態。ターミナルの状態は、'Error'、'Expired'、および 'Stopped' です。
teraflops	number	テラフロート単位で測定されたレンダリングセッション GPU の計算能力。

session_size

レンダリングセッションに使用されるサーバーのサイズ。サイズは、サーバーがレンダリングできるポリゴンの数に影響します。詳細については、https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes を参照してください。

名前	型	説明
Premium	string	Premium レンダリングセッションのサイズ。
Standard	string	標準レンダリングセッションサイズ。

session_status

レンダリングセッションの状態。ターミナルの状態は、'Error'、'Expired'、および 'Stopped' です。

名前	型	説明
Error	string	レンダリングセッションでエラーが発生し、使用できません。これは終了状態です。
Expired	string	レンダリングセッションは、リース時間よりも長い "準備完了" 状態の場合に "有効期限切れ" 状態になります。これは終了状態です。
Ready	string	レンダリングセッションは、受信接続の準備ができています。
Starting	string	レンダリングセッションは開始中ですが、受信接続はまだ受け入れられません。
Stopped	string	"セッションの停止" 操作でレンダリングセッションが停止しました。これは終了状態です。

Share via