Remote Rendering - Stop Session
特定のレンダリング セッションを停止します。
POST {endpoint}/accounts/{account_id}/sessions/{session_id}/:stop?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 を参照してください。 |
応答
名前 | 型 | 説明 |
---|---|---|
204 No Content |
NoContent。 停止要求が成功しました。 レンダリング セッションが停止しています。 ヘッダー MS-CV: string |
|
401 Unauthorized |
権限がありません。 承認が見つからないか無効です。 ヘッダー
|
|
403 Forbidden |
Forbidden. 特定のリソースに対する承認が不十分です。 ヘッダー MS-CV: string |
|
404 Not Found |
見つかりません。 指定されたセッション ID を持つセッションが存在しません。 ヘッダー MS-CV: string |
|
429 Too Many Requests |
要求が多すぎます。 レート制限を超えました。 Retry-After ヘッダーに指定された期間が経過したら、要求を再試行します。 ヘッダー
|
|
500 Internal Server Error |
内部エラー。 サーバーで内部エラーが発生しました。 要求を再試行すると、成功した結果が生成される可能性があります。 ヘッダー MS-CV: string |
セキュリティ
Authorization
セキュリティで保護されたトークン サービスによって返されるベアラー トークンMixed Reality。 詳細については、https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens を参照してください。
型:
apiKey
/:
header
例
Stop a session
要求のサンプル
POST https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/sessions/contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28/:stop?api-version=2021-01-01
応答のサンプル
MS-CV: dKEFmka2kkSlDmp/af+sOw
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."
}
}
定義
名前 | 説明 |
---|---|
error |
要求が失敗した理由の詳細を含む error オブジェクト。 |
error_response |
要求が失敗した理由の詳細を含むエラー応答。 |
error
要求が失敗した理由の詳細を含む error オブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
details |
error[] |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
innerError |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |
|
message |
string |
エラーの人間が判読できる表現。 |
target |
string |
特定のエラーのターゲット (エラーのプロパティの名前など)。 |
error_response
要求が失敗した理由の詳細を含むエラー応答。
名前 | 型 | 説明 |
---|---|---|
error |
要求が失敗した理由の詳細を含む error オブジェクト。 |