Remote Rendering - Stop Session

リファレンス

Service:: Mixed Reality

API Version:: 2021-01-01

特定のレンダリングセッションを停止します。

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。停止要求が成功しました。レンダリングセッションが停止しています。 Headers MS-CV: string
401 Unauthorized		権限がありません。承認が見つからないか無効です。 Headers MS-CV: string WWW-Authenticate: string
403 Forbidden		Forbidden. 特定のリソースに対する承認が不十分です。 Headers MS-CV: string
404 Not Found		見つかりません。指定されたセッション ID を持つセッションが存在しません。 Headers MS-CV: string
500 Internal Server Error	error_response	内部エラー。サーバーで内部エラーが発生しました。要求を再試行すると、成功した結果が生成される可能性があります。 Headers MS-CV: string
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

例

Stop a session

Sample Request

HTTP

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

Sample Response

Status code:: 204

MS-CV: dKEFmka2kkSlDmp/af+sOw

Status code:: 401

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

Status code:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Status code:: 404

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

定義

名前	説明
error	要求が失敗した理由の詳細を含む error オブジェクト。
error_response	要求が失敗した理由の詳細を含むエラー応答。

error

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

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

error_response

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

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

次の方法で共有