Remote Rendering - List Sessions
すべてのレンダリング セッションの一覧を取得します。
GET {endpoint}/accounts/{account_id}/sessions?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。 |
api-version
|
query | True |
string |
HTTP 要求で使用される API バージョン。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
Authorization | True |
string |
セキュリティで保護されたトークン サービスによって返されるベアラー トークンMixed Reality。 詳細については、https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens を参照してください。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK です。 "開始中" または "準備完了" 状態のセッションの一覧を返します。 |
|
401 Unauthorized |
権限がありません。 承認が見つからないか無効です。 Headers
|
|
403 Forbidden |
Forbidden. 特定のリソースに対する承認が不十分です。 Headers MS-CV: string |
|
500 Internal Server Error |
内部エラー。 サーバーで内部エラーが発生しました。 要求を再試行すると、正常な結果が生成される可能性があります。 Headers MS-CV: string |
|
Other Status Codes |
要求が多すぎます。 レート制限を超えました。 Retry-After ヘッダーで指定された期間が経過したら、要求を再試行します。 Headers
|
セキュリティ
Authorization
セキュリティで保護されたトークン サービスによって返されるベアラー トークンMixed Reality。 詳細については、https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens を参照してください。
Type:
apiKey
In:
header
例
List sessions
Sample Request
GET https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/sessions?api-version=2021-01-01
Sample Response
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
"sessions": [
{
"id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
"creationTime": "2020-11-11T11:11:11.111Z",
"arrInspectorPort": 50052,
"handshakePort": 50051,
"elapsedTimeMinutes": 59,
"hostname": "d4cefb7b-10b9-4631-934d-67445ffa9126.remoterenderingvm.westus2.mixedreality.azure.com",
"maxLeaseTimeMinutes": 60,
"size": "Standard",
"status": "Stopped",
"error": null,
"teraflops": 10.6
},
{
"id": "contoso-session-03c200ce-faf8-4238-8db9-872ac9dd501d",
"creationTime": "2021-01-01T11:11:11.111Z",
"arrInspectorPort": 50053,
"handshakePort": 50052,
"elapsedTimeMinutes": 12,
"hostname": "615854b8-1748-4f2e-9522-bf8523d7299c.remoterenderingvm.westus2.mixedreality.azure.com",
"maxLeaseTimeMinutes": 72,
"size": "Standard",
"status": "Ready",
"error": null,
"teraflops": 10.6
}
]
}
WWW-Authenticate: Bearer error="invalid_token"
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."
}
}
定義
名前 | 説明 |
---|---|
error |
要求が失敗した理由の詳細を含む error オブジェクト。 |
error_response |
要求が失敗した理由の詳細を含むエラー応答。 |
session_properties |
レンダリング セッションのプロパティ。 |
session_size |
レンダリング セッションに使用されるサーバーのサイズ。 サイズは、サーバーがレンダリングできるポリゴンの数に影響します。 詳細については、https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes を参照してください。 |
session_status |
レンダリング セッションの状態。 ターミナルの状態は、'Error'、'Expired'、および 'Stopped' です。 |
sessions_list |
リスト セッション要求の結果。 |
error
要求が失敗した理由の詳細を含む error オブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
details |
error[] |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
innerError |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |
|
message |
string |
エラーの人間が判読できる表現。 |
target |
string |
特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。 |
error_response
要求が失敗した理由の詳細を含むエラー応答。
名前 | 型 | 説明 |
---|---|---|
error |
要求が失敗した理由の詳細を含む error オブジェクト。 |
session_properties
レンダリング セッションのプロパティ。
名前 | 型 | 説明 |
---|---|---|
arrInspectorPort |
integer |
Azure Remote Rendering Inspector ツールがホストされている TCP ポート。 |
creationTime |
string |
レンダリング セッションが作成された時刻。 ISO 8601 形式の日付と時刻。 |
elapsedTimeMinutes |
integer |
セッションが "準備完了" 状態であったか、または "準備完了" 状態であった時間 (分単位)。 時間は 1 分に切り捨てられます。 |
error |
レンダリング セッションのスタートアップ エラーに関する詳細を含む error オブジェクト。 |
|
handshakePort |
integer |
接続を確立するときにハンドシェイクに使用される TCP ポート。 |
hostname |
string |
レンダリング セッションに到達できるホスト名。 |
id |
string |
セッションの作成時に指定されたセッションの ID。 |
maxLeaseTimeMinutes |
integer |
"準備完了" 状態に達した後にセッションが実行される時間 (分単位)。 |
size |
レンダリング セッションに使用されるサーバーのサイズ。 サイズは、サーバーがレンダリングできるポリゴンの数に影響します。 詳細については、https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes を参照してください。 |
|
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 |
"セッションの停止" 操作でレンダリング セッションが停止しました。 これは終了状態です。 |
sessions_list
リスト セッション要求の結果。
名前 | 型 | 説明 |
---|---|---|
@nextLink |
string |
より多くのレンダリング セッションが使用可能な場合、このフィールドには、セッションの次のバッチを要求できる URL が含まれます。 この URL には、Azure Remote Rendering API のすべての呼び出しと同じ認証が必要です。 |
sessions |
レンダリング セッションの一覧。 "停止済み" 状態のセッションは含まれません。 |