*Bu içerik, yapay zekâ (beta) kullanılarak çevrildi ve hatalar içerebilir. Sayfayı İngilizce görüntülemek için buraya tıkla.

Instance

Bir veri modeli instansını temsil eder.

Nitelikler

pathstring

Instanstan kaynak yolu.

Biçim: universes/{universe_id}/places/{place_id}/instances/{instance_id}.

hasChildrenboolean
Yalnızca Çıkış

instanstan herhangi bir çocuk instansı olup olmadığı.

engineInstanceobject

instanstan özellik detayları.

Taban URL
https://apis.roblox.com
Instance Kaynağı
{

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

  "hasChildren": true,

  "engineInstance": {

    "Id": "string",

    "Parent": "string",

    "Name": "string",

    "Details": {

      "Folder": {}

    }

  }

}

Instance

İstisna almak GetInstance
Beta

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

Bir örnek ve özellik verileri alır.

Desteklenen maksimum yanıt veri boyutu 500,000 bayttır.Bu sınır aşılırsa, döndürülen Operation ile bir hata kodu olan bir hata sonucu tamamlanacaktır: 422.

Kapsamlar
universe.place.instance:read
TalepYol Parametreleri
universe_idstring
Gerekli

Evren kimliği.

place_idstring
Gerekli

Yer kimliği.

instance_idstring
Gerekli

Instans ID'si.

Yanıt

Eş zamansız olan bu yöntem, işlemin geçerli durumunu temsil eden bir Operation döndürür Gerçek yanıtı ve uygulanabilir üst verileri elde etmek için yoklayabileceğin bir uç nokta yolu içerir. Daha fazla bilgi için uzun süreli işlemlerle ilgili dokümantasyonu incele.

Aşağıdaki kısımlar, bir işlem tamamlandığında sağlanan yanıt ve üst veri nesnelerini tanımlar.

YanıtInstanceÜst Veri

Hiçbiri

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

İstisna Güncelleme
Beta

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

Bir instanstan özellik verilerini günceller.

Bir Script örneğinin kaynak özelliğini güncellerken, maksimum desteklenen özellik boyutu UTF-8 kodlamasından sonra 200,000 bayttır.

Kapsamlar
universe.place.instance:write
TalepYol Parametreleri
universe_idstring
Gerekli

Evren kimliği.

place_idstring
Gerekli

Yer kimliği.

instance_idstring
Gerekli

Instans ID'si.

Sorgu Parametreleri
updateMaskstring

Güncellenmesi gereken alanların listesi. Bu dizi FieldMask olarak biçimlendirilmiş.

Talep GövdesiInstance
Yanıt

Eş zamansız olan bu yöntem, işlemin geçerli durumunu temsil eden bir Operation döndürür Gerçek yanıtı ve uygulanabilir üst verileri elde etmek için yoklayabileceğin bir uç nokta yolu içerir. Daha fazla bilgi için uzun süreli işlemlerle ilgili dokümantasyonu incele.

Aşağıdaki kısımlar, bir işlem tamamlandığında sağlanan yanıt ve üst veri nesnelerini tanımlar.

YanıtInstanceÜst Veri

Hiçbiri

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

Liste İstisna Çocukları
Beta

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

Bir örneğin çocuklarını listeler.

Desteklenen maksimum yanıt veri boyutu 500,000 bayttır.Bu sınır aşılırsa, döndürülen Operation ile bir hata kodu olan bir hata sonucu tamamlanacaktır: 422.

Kapsamlar
universe.place.instance:read
TalepYol Parametreleri
universe_idstring
Gerekli

Evren kimliği.

place_idstring
Gerekli

Yer kimliği.

instance_idstring
Gerekli

Instans ID'si.

Sorgu Parametreleri
maxPageSizenumber

Geri döndürülecek çocuk örnek maksimum sayısı.Hizmet bu değerden daha azını iade edebilir.Belirtilmediğinde, en fazla 200 çocuk iade edilecektir.Maksimum değer 200'dir; 200'in üzerindeki değerler 200'e zorlanacaktır.

pageTokenstring

Önceki bir ListInstanceChildrenRequest çağrısından alınan bir sayfa jetonu. Sonraki sayfayı almak için bunu sağla.

Sayfa numaralandırırken, tüm diğer parametler ListInstanceChildrenRequest sağlanan sayfa jetonu sağlayan çağrıya eşleşmelidir.

Yanıt

Eş zamansız olan bu yöntem, işlemin geçerli durumunu temsil eden bir Operation döndürür Gerçek yanıtı ve uygulanabilir üst verileri elde etmek için yoklayabileceğin bir uç nokta yolu içerir. Daha fazla bilgi için uzun süreli işlemlerle ilgili dokümantasyonu incele.

Aşağıdaki kısımlar, bir işlem tamamlandığında sağlanan yanıt ve üst veri nesnelerini tanımlar.

Yanıt

Instanstan çocukların bir listesini döndürür.

instancesarray<Instance>

Çocuk örneklerinin bir listesi.

nextPageTokenstring

Sonraki sayfayı almak için page_token olarak gönderilebilecek bir jeton. Bu alan atlanırsa, sonraki sayfalar yoktur.

Üst Veri

Hiçbiri

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