Referensi API GameLift layanan Amazon (AWSSDK)

Topik ini menyediakan daftar operasi API berbasis tugas untuk digunakan dengan solusi hosting GameLift terkelola Amazon, termasuk hosting untuk server game khusus dan Server Realtime. Operasi ini dikemas ke dalam AWS SDK di namespace. aws.gamelift Unduh AWS SDK atau lihat dokumentasi referensi Amazon GameLift API.

API mencakup dua set operasi untuk hosting game terkelola:

• Menyiapkan dan mengelola sumber daya GameLift hosting Amazon

• Memulai sesi game dan bergabung dengan pemain

Amazon GameLift Service API juga berisi operasi untuk digunakan dengan GameLift alat dan solusi Amazon lainnya. Untuk daftar API FleetIQ, lihat Tindakan API FleetIQ. Untuk daftar FlexMatch API untuk perjodohan, lihat tindakan FlexMatchAPI.

Menyiapkan dan mengelola sumber daya GameLift hosting Amazon

Hubungi operasi ini untuk mengonfigurasi sumber daya hosting untuk server game Anda, menskalakan kapasitas untuk memenuhi permintaan pemain, mengakses performa dan metrik pemanfaatan, dan banyak lagi. Operasi API ini digunakan dengan server game yang di-host di AmazonGameLift, termasuk Server Realtime. Anda dapat menggunakan GameLiftkonsol Amazon untuk sebagian besar tugas pengelolaan sumber daya, atau Anda dapat melakukan panggilan ke layanan menggunakan alat AWS Command Line Interface (AWS CLI) atau AWS SDK.

Siapkan server game untuk deployment

Unggah dan konfigurasikan kode server game Anda dalam persiapan deployment dan peluncuran sumber daya hosting.

Mengelola build server game kustom

• upload-build — Unggah file build dari jalur lokal dan buat sumber daya build Amazon GameLift baru. Operasi ini, yang hanya tersedia sebagai perintah AWS CLI, adalah metode yang paling umum untuk mengunggah server pembuatan game.

• CreateBuild— Buat build baru menggunakan file yang disimpan dalam bucket Amazon S3.

• ListBuilds- Dapatkan daftar semua build yang diunggah ke GameLift wilayah Amazon.

• DescribeBuild- Ambil informasi yang terkait dengan build.

• UpdateBuild- Ubah metadata build, termasuk nama dan versi build.

• DeleteBuild- Hapus build dari AmazonGameLift.

Mengelola skrip konfigurasi Server Realtime

• CreateScript- Unggah JavaScript file dan buat sumber daya GameLift skrip Amazon baru.

• ListScripts- Dapatkan daftar semua skrip Realtime yang diunggah ke GameLift wilayah Amazon.

• DescribeScript- Ambil informasi yang terkait dengan skrip Realtime.

• UpdateScript- Ubah metadata skrip dan unggah konten skrip yang direvisi.

• DeleteScript- Hapus skrip Realtime dari AmazonGameLift.

Mengatur sumber daya komputasi untuk hosting

Mengonfigurasi sumber daya hosting dan men-deploy sumber daya dengan build server game Anda atau konfigurasi skrip Realtime.

Membuat dan mengelola armada

• CreateFleet- Konfigurasikan dan terapkan GameLift armada Amazon baru sumber daya komputasi untuk menjalankan server game Anda. Setelah di-deploy, server game secara otomatis diluncurkan sesuai konfigurasi dan siap untuk menjadi host sesi game.

• ListFleets- Dapatkan daftar semua armada di GameLift wilayah Amazon.

• DeleteFleet- Hentikan armada yang tidak lagi menjalankan server game atau hosting pemain.

• Melihat/memperbarui lokasi armada.

  • CreateFleetLocations- Tambahkan lokasi terpencil ke armada yang ada yang mendukung beberapa lokasi

  • DescribeFleetLocationAttributes- Dapatkan daftar semua lokasi terpencil untuk armada dan melihat status saat ini dari setiap lokasi.

  • DeleteFleetLocations- Hapus lokasi terpencil dari armada yang mendukung beberapa lokasi.

• Melihat/memperbarui konfigurasi armada.

  • DescribeFleetAttributes/UpdateFleetAttributes— Melihat atau mengubah metadata armada dan pengaturan untuk perlindungan sesi game dan batas pembuatan sumber daya.

  • DescribeFleetPortSettings/UpdateFleetPortSettings- Lihat atau ubah izin masuk (alamat IP dan rentang pengaturan port) yang diizinkan untuk armada.

  • DescribeRuntimeConfiguration/UpdateRuntimeConfiguration— Lihat atau ubah proses server apa (dan berapa banyak) untuk dijalankan pada setiap instance dalam armada.

Mengelola kapasitas armada

• DescribeEC2 InstanceLimits - Ambil jumlah maksimum instance yang diizinkan untuk AWS akun saat ini dan tingkat penggunaan saat ini.

• DescribeFleetCapacity- Ambil pengaturan kapasitas saat ini untuk Wilayah asal armada.

• DescribeFleetLocationCapacity- Ambil pengaturan kapasitas saat ini untuk setiap lokasi armada multi-lokasi.

• UpdateFleetCapacity- Secara manual menyesuaikan pengaturan kapasitas untuk armada.

• Mengatur penskalaan otomatis:

  • PutScalingPolicy- Aktifkan penskalaan otomatis berbasis target atau buat kebijakan penskalaan otomatis khusus, atau perbarui kebijakan yang ada.

  • DescribeScalingPolicies- Ambil kebijakan penskalaan otomatis yang ada.

  • DeleteScalingPolicy- Hapus kebijakan penskalaan otomatis dan hentikan agar tidak memengaruhi kapasitas armada.

  • StartFleetActions- Mulai ulang kebijakan penskalaan otomatis armada.

  • StopFleetActions- Tangguhkan kebijakan penskalaan otomatis armada.

Pantau aktivitas armada.

• DescribeFleetUtilization- Ambil statistik jumlah proses server, sesi permainan, dan pemain yang saat ini aktif di armada.

• DescribeFleetLocationUtilization- Ambil statistik pemanfaatan untuk setiap lokasi dalam armada multi-lokasi.

• DescribeFleetEvents- Lihat peristiwa yang dicatat untuk armada selama rentang waktu tertentu.

• DescribeGameSessions- Ambil metadata sesi game, termasuk waktu berjalan game dan jumlah pemain saat ini.

Mengatur antrean untuk penempatan sesi game yang optimal

Siapkan antrian multi-armada dan multi-wilayah untuk menempatkan sesi game dengan sumber daya hosting terbaik yang tersedia dalam hal biaya, latensi, dan ketahanan.

• CreateGameSessionQueue- Buat antrian untuk digunakan saat memproses permintaan penempatan sesi game.

• DescribeGameSessionQueues- Ambil antrean sesi game yang ditentukan di wilayah Amazon. GameLift

• UpdateGameSessionQueue- Ubah konfigurasi antrian sesi game.

• DeleteGameSessionQueue- Hapus antrian sesi permainan dari wilayah tersebut.

Mengelola alias

Gunakan alias untuk mewakili armada Anda atau membuat tujuan alternatif terminal. Alias berguna saat melakukan transisi aktivitas game dari satu armada ke armada lainnya, seperti saat memperbarui build server game.

• CreateAlias- Tentukan alias baru dan secara opsional menetapkannya ke armada.

• ListAliases- Dapatkan semua alias armada yang didefinisikan di wilayah AmazonGameLift.

• DescribeAlias- Ambil informasi tentang alias yang ada.

• UpdateAlias- Ubah pengaturan untuk alias, seperti mengalihkannya dari satu armada ke armada lainnya.

• DeleteAlias- Hapus alias dari wilayah tersebut.

• ResolveAlias- Dapatkan ID armada yang menunjuk alias tertentu.

Mengakses instans hosting

Melihat informasi tentang masing-masing instans dalam armada, atau meminta akses jarak jauh ke instans armada tertentu untuk pemecahan masalah.

• DescribeInstances- Dapatkan informasi tentang setiap instance dalam armada, termasuk ID instans, alamat IP, lokasi, dan status.

• GetInstanceAccess- Meminta kredensi akses yang diperlukan untuk terhubung dari jarak jauh ke instance tertentu dalam armada.

Mengatur peering VPC

Buat dan kelola koneksi peering VPC antara sumber daya GameLift hosting Amazon Anda dan sumber daya lainnyaAWS.

• CreateVpcPeeringAuthorization- Otorisasi koneksi peering ke salah satu VPC Anda.

• DescribeVpcPeeringAuthorizations- Ambil otorisasi koneksi peering valid.

• DeleteVpcPeeringAuthorization- Hapus otorisasi koneksi peering.

• CreateVpcPeeringConnection- Buat koneksi peering antara VPC untuk GameLift armada Amazon dan salah satu VPC Anda.

• DescribeVpcPeeringConnections- Ambil informasi tentang koneksi peering VPC yang aktif atau tertunda dengan armada Amazon. GameLift

• DeleteVpcPeeringConnection- Hapus koneksi peering VPC dengan armada AmazonGameLift.

Memulai sesi game dan bergabung dengan pemain

Hubungi operasi ini dari layanan client game Anda untuk memulai sesi game baru, dapatkan informasi tentang sesi game yang ada, dan bergabunglah dengan pemain ke sesi game. Operasi ini untuk digunakan dengan server game khusus yang di-host di AmazonGameLift. Jika Anda menggunakan Realtime Servers, kelola sesi game menggunakan Referensi API klien Server Realtime (C #).

• Mulai sesi permainan baru untuk satu atau lebih pemain.

  • StartGameSessionPlacement- Minta Amazon GameLift untuk menemukan sumber daya hosting terbaik yang tersedia dan memulai sesi permainan baru. Ini adalah metode yang disukai untuk membuat sesi game baru. Ini bergantung pada antrean sesi game untuk melacak ketersediaan hosting di beberapa wilayah, dan menggunakan algoritme FleetIQ untuk memprioritaskan penempatan berdasarkan latensi pemain, biaya hosting, lokasi, dll.

  • DescribeGameSessionPlacement- Dapatkan detail dan status pada permintaan penempatan.

  • StopGameSessionPlacement- Batalkan permintaan penempatan.

  • CreateGameSession- Mulai sesi permainan baru yang kosong di lokasi armada tertentu. Operasi ini memberi Anda kontrol yang lebih besar atas tempat memulai sesi game, alih-alih menggunakan FleetIQ untuk mengevaluasi opsi penempatan. Anda harus menambahkan pemain ke sesi game baru dalam langkah terpisah.

• Dapatkan pemain ke sesi permainan yang ada. Cari sesi game berjalan dengan slot pemain yang tersedia dan simpan untuk pemain baru.

  • CreatePlayerSession- Pesan slot terbuka untuk pemain untuk bergabung dengan sesi permainan.

  • CreatePlayerSessions- Cadangan slot terbuka untuk beberapa pemain untuk bergabung dengan sesi permainan.

• Bekerja dengan sesi permainan dan data sesi pemain. Kelola informasi tentang sesi game dan sesi pemain.

  • SearchGameSessions- Minta daftar sesi permainan aktif berdasarkan serangkaian kriteria pencarian.

  • DescribeGameSessions- Ambil metadata untuk sesi game tertentu, termasuk lamanya waktu aktif dan jumlah pemain saat ini.

  • DescribeGameSessionDetails- Ambil metadata, termasuk pengaturan perlindungan sesi game, untuk satu atau beberapa sesi game.

  • DescribePlayerSessions- Dapatkan detail tentang aktivitas pemain, termasuk status, waktu bermain, dan data pemain.

  • UpdateGameSession- Ubah pengaturan sesi permainan, seperti jumlah pemain maksimum dan kebijakan bergabung.

  • GetGameSessionLogUrl- Dapatkan lokasi log yang disimpan untuk sesi permainan.