*Konten ini diterjemahkan menggunakan AI (Beta) dan mungkin mengandung kesalahan. Untuk melihat halaman ini dalam bahasa Inggris, klik di sini.

Instance

Mewakili instansi model data.

Atribut

pathstring

Jalur sumber daya dari kejadian.

Format: universes/{universe_id}/places/{place_id}/instances/{instance_id}.

hasChildrenboolean
Hanya Output

apakah instansi memiliki anak kejadian.

engineInstanceobject

detail properti dari kejadian.

Base URL
https://apis.roblox.com
Resource Instance
{

  "path": "universes/123/places/123/instances/0123456789abcdef0123456789abcdef",

  "hasChildren": true,

  "engineInstance": {

    "Id": "string",

    "Parent": "string",

    "Name": "string",

    "Details": {

      "Folder": {}

    }

  }

}

Instance

Get Instance
Beta

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}

Mendapatkan instansi dan data propertinya.

Ukuran data respons maksimum yang didukung adalah 500.000 bayt.Jika batas ini dilampaui, Operation yang dikembalikan akan diselesaikan dengan hasil kesalahan yang memiliki kode kesalahan 422.

Cakupan
universe.place.instance:read
PermintaanParameter Jalur
universe_idstring
Diperlukan

ID alam semesta.

place_idstring
Diperlukan

ID tempat.

instance_idstring
Diperlukan

ID instance.

Respons

Metode ini tidak sinkron dan menghasilkan sebuah Operasi, yang mewakili keadaan operasi saat ini. Operasi tersebut berisi jalur endpoint yang dapat Anda pantau untuk memperoleh respons aktual dan metadata yang relevan. Lihat dokumentasi tentang operasi jangka panjang untuk mengetahui informasi selengkapnya.

Bagian berikut menjelaskan objek respons dan metadata yang disediakan saat operasi selesai.

ResponsInstanceMetadata

Tidak ada

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}' \

  -H 'x-api-key: {your-api-key}'

Instance

Update Instance
Beta

PATCH /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}

Memperbarui data properti kejadian.

Saat memperbarui properti sumber instansi Script , ukuran properti maksimum yang didukung adalah 200.000 byte setelah dienkodekan UTF-8.

Cakupan
universe.place.instance:write
PermintaanParameter Jalur
universe_idstring
Diperlukan

ID alam semesta.

place_idstring
Diperlukan

ID tempat.

instance_idstring
Diperlukan

ID instance.

Parameter Kueri
updateMaskstring

Daftar bidang untuk update. String ini diformat sebagai FieldMask.

Request BodyInstance
Respons

Metode ini tidak sinkron dan menghasilkan sebuah Operasi, yang mewakili keadaan operasi saat ini. Operasi tersebut berisi jalur endpoint yang dapat Anda pantau untuk memperoleh respons aktual dan metadata yang relevan. Lihat dokumentasi tentang operasi jangka panjang untuk mengetahui informasi selengkapnya.

Bagian berikut menjelaskan objek respons dan metadata yang disediakan saat operasi selesai.

ResponsInstanceMetadata

Tidak ada

PATCH /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}?updateMask={string}' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{

  "engineInstance": {

    "Id": "string",

    "Parent": "string",

    "Name": "string",

    "Details": {

      "Folder": {}

    }

  }

}'

Instance

List Instance Children
Beta

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren

Daftar anak-anak instansi.

Ukuran data respons maksimum yang didukung adalah 500.000 bayt.Jika batas ini dilampaui, Operation yang dikembalikan akan diselesaikan dengan hasil kesalahan yang memiliki kode kesalahan 422.

Cakupan
universe.place.instance:read
PermintaanParameter Jalur
universe_idstring
Diperlukan

ID alam semesta.

place_idstring
Diperlukan

ID tempat.

instance_idstring
Diperlukan

ID instance.

Parameter Kueri
maxPageSizenumber

Jumlah maksimum instansi anak untuk dikembalikan.Layanan dapat kembali kurang dari nilai ini.Jika tidak ditentukan, maksimal 200 anak akan dikembalikan.Nilai maksimum adalah 200; nilai di atas 200 akan dipaksa menjadi 200.

pageTokenstring

Token halaman, diterima dari panggilan sebelumnya ListInstanceChildrenRequest . Berikan ini untuk mengambil halaman berikutnya.

Saat paginasi, semua parameter lain yang disediakan ke ListInstanceChildrenRequest harus cocok dengan panggilan yang memberikan token halaman.

Respons

Metode ini tidak sinkron dan menghasilkan sebuah Operasi, yang mewakili keadaan operasi saat ini. Operasi tersebut berisi jalur endpoint yang dapat Anda pantau untuk memperoleh respons aktual dan metadata yang relevan. Lihat dokumentasi tentang operasi jangka panjang untuk mengetahui informasi selengkapnya.

Bagian berikut menjelaskan objek respons dan metadata yang disediakan saat operasi selesai.

Respons

Kembalikan daftar anak-anak instansi.

instancesarray<Instance>

Daftar instansi anak.

nextPageTokenstring

Token, yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika bidang ini diabaikan, tidak ada halaman berikutnya.

Metadata

Tidak ada

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren?maxPageSize=100&pageToken={string}' \

  -H 'x-api-key: {your-api-key}'