*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.

Instance

Repräsentiert eine Datenmodell-Instanz.

Attribute

pathstring

Der Ressourcenpfad der Instanz.

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

hasChildrenboolean
Nur Ausgabe

ob die instanz irgendwelche kinderinstanzen hat.

engineInstanceobject

die eigenschaftsdetails der instanz.

Basis-URL
https://apis.roblox.com
Die Instance-Ressource
{

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

  "hasChildren": true,

  "engineInstance": {

    "Id": "string",

    "Parent": "string",

    "Name": "string",

    "Details": {

      "Folder": {}

    }

  }

}

Instance

Instanz erhalten
Beta

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

Holt sich eine Instanz und ihre Eigenschaftsdaten.

Die maximale unterstützte Antwortdatengröße beträgt 500.000 Bytes.Wenn diese Grenze überschritten wird, wird die zurückgegebene Operation mit einem Fehlerergebnis abgeschlossen, das einen Fehlercode von 422 hat.

Bereiche
universe.place.instance:read
AnfragePfadparameter
universe_idstring
Erforderlich

Die Universum-ID.

place_idstring
Erforderlich

Die Platz-ID.

instance_idstring
Erforderlich

Die Instanz-ID.

Rückmeldung

Diese Methode ist asynchron und gibt eine Operation zurück, die den aktuellen Status der Operation darstellt. Sie enthält einen Endpunktpfad, den du abfragen kannst, um die tatsächliche Antwort und die entsprechenden Metadaten zu erhalten. Weitere Informationen findest du in der Dokumentation.

Die folgenden Abschnitte beschreiben die Antwort- und Metadatenobjekte, die bereitgestellt werden, wenn eine Operation abgeschlossen ist.

RückmeldungInstanceMetadaten

Keine

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

Instanz aktualisieren
Beta

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

Aktualisiert die Eigenschaftsdaten einer Instanz.

Wenn du die Quell属性 einer Script, ist die maximale unterstützte Größe der Eigenschaft 200.000 Bytes nach UTF-8-Kodierung

Bereiche
universe.place.instance:write
AnfragePfadparameter
universe_idstring
Erforderlich

Die Universum-ID.

place_idstring
Erforderlich

Die Platz-ID.

instance_idstring
Erforderlich

Die Instanz-ID.

Anfrageparameter
updateMaskstring

Die Liste der zu aktualisierenden Felder. Dieser String ist als FieldMask formatiert.

Text anfordernInstance
Rückmeldung

Diese Methode ist asynchron und gibt eine Operation zurück, die den aktuellen Status der Operation darstellt. Sie enthält einen Endpunktpfad, den du abfragen kannst, um die tatsächliche Antwort und die entsprechenden Metadaten zu erhalten. Weitere Informationen findest du in der Dokumentation.

Die folgenden Abschnitte beschreiben die Antwort- und Metadatenobjekte, die bereitgestellt werden, wenn eine Operation abgeschlossen ist.

RückmeldungInstanceMetadaten

Keine

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

Instanzkindern listen
Beta

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

Listet die Kinder einer Instanz auf.

Die maximale unterstützte Antwortdatengröße beträgt 500.000 Bytes.Wenn diese Grenze überschritten wird, wird die zurückgegebene Operation mit einem Fehlerergebnis abgeschlossen, das einen Fehlercode von 422 hat.

Bereiche
universe.place.instance:read
AnfragePfadparameter
universe_idstring
Erforderlich

Die Universum-ID.

place_idstring
Erforderlich

Die Platz-ID.

instance_idstring
Erforderlich

Die Instanz-ID.

Anfrageparameter
maxPageSizenumber

Die maximale Anzahl der Kindinstanzen, die zurückzukehren sind.Der Dienst kann weniger als diesen Wert zurückgeben.Wenn nicht spezifiziert, werden höchstens 200 Kinder zurückgegeben.Der maximale Wert beträgt 200; Werte über 200 werden auf 200 gezwungen.

pageTokenstring

Ein Seiten-Token, das von einer früheren ListInstanceChildrenRequest Anruf erhalten wurde. Stelle dies bereit, um die nachfolgende Seite abzurufen.

Wenn Seiten nummeriert werden, müssen alle anderen Parameter, die ListInstanceChildrenRequest bereitgestellt wurden, der Anruf entsprechen, der das Seiten-Token bereitgestellt hat.

Rückmeldung

Diese Methode ist asynchron und gibt eine Operation zurück, die den aktuellen Status der Operation darstellt. Sie enthält einen Endpunktpfad, den du abfragen kannst, um die tatsächliche Antwort und die entsprechenden Metadaten zu erhalten. Weitere Informationen findest du in der Dokumentation.

Die folgenden Abschnitte beschreiben die Antwort- und Metadatenobjekte, die bereitgestellt werden, wenn eine Operation abgeschlossen ist.

Rückmeldung

Gibt eine Liste der Kinder der Instanz zurück.

instancesarray<Instance>

Eine Liste von Kind-Instanzen.

nextPageTokenstring

Ein Token, das als page_token an einen Server gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld ausgelassen wird, gibt es keine nachfolgenden Seiten.

Metadaten

Keine

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