Bagikan melalui


Remote Rendering - Create Session

Membuat sesi penyajian baru.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
account_id
path True

string

uuid

ID akun Azure Remote Rendering.

endpoint
path True

string

Titik akhir yang akan digunakan misalnya https://remoterendering.eastus.mixedreality.azure.com. Daftar dapat ditemukan di https://docs.microsoft.com/azure/remote-rendering/reference/regions.

session_id
path True

string

ID secara unik mengidentifikasi sesi penyajian untuk akun tertentu. ID peka huruf besar/kecil, dapat berisi kombinasi karakter alfanumerik termasuk tanda hubung dan garis bawah, dan tidak boleh berisi lebih dari 256 karakter.

api-version
query True

string

Versi API yang akan digunakan dengan permintaan HTTP.

Header Permintaan

Nama Diperlukan Jenis Deskripsi
Authorization True

string

Token pembawa yang dikembalikan oleh Layanan Token Aman Mixed Reality. Lihat https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens untuk detailnya.

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
maxLeaseTimeMinutes True

integer

Waktu dalam menit sesi akan berjalan setelah mencapai status 'Siap'. Harus antara 0 dan 1440.

size True

session_size

Ukuran server yang digunakan untuk sesi penyajian. Ukuran berdampak pada jumlah poligon yang dapat dirender server. Lihat https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes untuk detailnya.

Respons

Nama Jenis Deskripsi
200 OK

session_properties

OK. Menunjukkan bahwa sudah ada sesi dengan pengaturan yang sama. Ini diharapkan ketika pembuatan sesi dicoba kembali.

201 Created

session_properties

Dibuat. Sesi berhasil dibuat.

Header

MS-CV: string

400 Bad Request

error_response

Permintaan Buruk. Objek kesalahan yang dikembalikan menjelaskan masalah mana yang terjadi.

Header

MS-CV: string

401 Unauthorized

Tidak Sah. Otorisasi hilang atau tidak valid.

Header

  • MS-CV: string
  • WWW-Authenticate: string
403 Forbidden

Terlarang. Otorisasi tidak cukup untuk sumber daya tertentu.

Header

MS-CV: string

429 Too Many Requests

Terlalu Banyak Permintaan. Batas tarif telah terlampaui. Coba lagi permintaan setelah durasi yang diberikan di header Retry-After.

Header

  • MS-CV: string
  • Retry-After: integer
500 Internal Server Error

error_response

Kesalahan Internal. Server mengalami kesalahan internal. Mencoba kembali permintaan dapat menghasilkan hasil yang berhasil.

Header

MS-CV: string

Other Status Codes

error_response

Konflik. Sesi penyajian dengan ID sudah ada untuk akun penyajian jarak jauh.

Keamanan

Authorization

Token pembawa yang dikembalikan oleh Layanan Token Aman Mixed Reality. Lihat https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens untuk detailnya.

Jenis: apiKey
Dalam: header

Contoh

Create a rendering session

Permintaan sampel

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

Respon sampel

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
}
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
}
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "BadRequest",
    "message": "The request was malformed."
  }
}
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
  "error": {
    "code": "Conflict",
    "message": "A resource already exists under the given ID."
  }
}
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."
  }
}

Definisi

Nama Deskripsi
create_session_settings

Pengaturan sesi yang akan dibuat.

error

Objek kesalahan yang berisi detail mengapa permintaan gagal.

error_response

Respons kesalahan yang berisi detail mengapa permintaan gagal.

session_properties

Properti sesi penyajian.

session_size

Ukuran server yang digunakan untuk sesi penyajian. Ukuran berdampak pada jumlah poligon yang dapat dirender server. Lihat https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes untuk detailnya.

session_status

Status sesi penyajian. Status terminal adalah 'Kesalahan', 'Kedaluwarsa', dan 'Dihentikan'.

create_session_settings

Pengaturan sesi yang akan dibuat.

Nama Jenis Deskripsi
maxLeaseTimeMinutes

integer

Waktu dalam menit sesi akan berjalan setelah mencapai status 'Siap'. Harus antara 0 dan 1440.

size

session_size

Ukuran server yang digunakan untuk sesi penyajian. Ukuran berdampak pada jumlah poligon yang dapat dirender server. Lihat https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes untuk detailnya.

error

Objek kesalahan yang berisi detail mengapa permintaan gagal.

Nama Jenis Deskripsi
code

string

Kode Kesalahan.

details

error[]

Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.

innerError

error

Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.

message

string

Representasi kesalahan yang dapat dibaca manusia.

target

string

Target kesalahan tertentu (misalnya, nama properti dalam kesalahan).

error_response

Respons kesalahan yang berisi detail mengapa permintaan gagal.

Nama Jenis Deskripsi
error

error

Objek kesalahan yang berisi detail mengapa permintaan gagal.

session_properties

Properti sesi penyajian.

Nama Jenis Deskripsi
arrInspectorPort

integer

Port TCP tempat alat Azure Remote Rendering Inspector dihosting.

creationTime

string

Waktu saat sesi penyajian dibuat. Tanggal dan waktu dalam format ISO 8601.

elapsedTimeMinutes

integer

Jumlah waktu dalam menit sesi adalah atau berada dalam status 'Siap'. Waktu dibulatkan ke bawah hingga satu menit penuh.

error

error

Objek kesalahan yang berisi detail tentang kegagalan startup sesi penyajian.

handshakePort

integer

Port TCP yang digunakan untuk jabat tangan saat membuat koneksi.

hostname

string

Nama host tempat sesi penyajian dapat dijangkau.

id

string

ID sesi yang disediakan saat sesi dibuat.

maxLeaseTimeMinutes

integer

Waktu dalam menit sesi akan berjalan setelah mencapai status 'Siap'.

size

session_size

Ukuran server yang digunakan untuk sesi penyajian. Ukuran berdampak pada jumlah poligon yang dapat dirender server. Lihat https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes untuk detailnya.

status

session_status

Status sesi penyajian. Status terminal adalah 'Kesalahan', 'Kedaluwarsa', dan 'Dihentikan'.

teraflops

number

Kekuatan komputasi dari GPU sesi penyajian yang diukur dalam teraflop.

session_size

Ukuran server yang digunakan untuk sesi penyajian. Ukuran berdampak pada jumlah poligon yang dapat dirender server. Lihat https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes untuk detailnya.

Nama Jenis Deskripsi
Premium

string

Ukuran sesi penyajian premium.

Standard

string

Ukuran sesi penyajian standar.

session_status

Status sesi penyajian. Status terminal adalah 'Kesalahan', 'Kedaluwarsa', dan 'Dihentikan'.

Nama Jenis Deskripsi
Error

string

Sesi penyajian mengalami kesalahan, dan tidak dapat digunakan. Ini adalah status terminal.

Expired

string

Sesi penyajian memasuki status 'Kedaluwarsa' ketika telah berada dalam status 'Siap' lebih lama dari waktu sewanya. Ini adalah status terminal.

Ready

string

Sesi penyajian siap untuk koneksi masuk.

Starting

string

Sesi penyajian dimulai, tetapi belum menerima koneksi masuk.

Stopped

string

Sesi penyajian telah dihentikan dengan operasi 'Hentikan Sesi'. Ini adalah status terminal.