*Questo contenuto è tradotto usando AI (Beta) e potrebbe contenere errori. Per visualizzare questa pagina in inglese, clicca qui.

Instance

Rappresenta un'esempiodi modello di dati.

Attributi

pathstring

Il percorso delle risorse dell'esempio.

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

hasChildrenboolean
Solo output

se l'istanza abbia figli esempio.

engineInstanceobject

i dettagli della proprietà dell'esempio.

URL di base

https://apis.roblox.com
Risorsa 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}

Ottiene un'istanza e i suoi dati di proprietà.

La dimensione massima dei dati di risposta supportata è di 500.000 bytes.Se questo limite viene superato, il Operation restituito sarà completato con un risultato di errore che ha un codice di errore di 422 .

Campi
universe.place.instance:read
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

place_idstring
Necessario

L'ID del luogo.

instance_idstring
Necessario

L'ID dell'istanza.

Risposta

Questo metodo è asincrono e restituisce un'"operazione", che rappresenta lo stato corrente della stessa. Contiene un percorso endpoint che è possibile sondare per ottenere la risposta reale e i metadati applicabili. Per ulteriori informazioni, consulta la documentazione sulle operazioni di lunga durata.

Le sezioni seguenti descrivono gli oggetti di risposta e metadati forniti al completamento di un'operazione.

RispostaInstanceMetadati

Nessuno

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}

Aggiorna i dati di proprietà di un'esempio.

Aggiornando la Proprietàdi origine di un'esempioScript , la dimensione massima supportata della proprietà è di 200.000 byte dopo l' encoding UTF-8.

Campi
universe.place.instance:write
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

place_idstring
Necessario

L'ID del luogo.

instance_idstring
Necessario

L'ID dell'istanza.

Parametri query
updateMaskstring

L'elenco dei campi da Aggiornarmento. Questa stringa è formattata come Timestamp.

Corpo della richiestaInstance
Risposta

Questo metodo è asincrono e restituisce un'"operazione", che rappresenta lo stato corrente della stessa. Contiene un percorso endpoint che è possibile sondare per ottenere la risposta reale e i metadati applicabili. Per ulteriori informazioni, consulta la documentazione sulle operazioni di lunga durata.

Le sezioni seguenti descrivono gli oggetti di risposta e metadati forniti al completamento di un'operazione.

RispostaInstanceMetadati

Nessuno

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

Elenca i figli di un'esempio.

La dimensione massima dei dati di risposta supportata è di 500.000 bytes.Se questo limite viene superato, il Operation restituito sarà completato con un risultato di errore che ha un codice di errore di 422 .

Campi
universe.place.instance:read
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

place_idstring
Necessario

L'ID del luogo.

instance_idstring
Necessario

L'ID dell'istanza.

Parametri query
maxPageSizenumber

Il numero massimo di istanza figlia da Riportare.Il servizio può restituire meno di questo valore.Se non specificato, a massimo 200 bambini verranno restituiti.Il valore massimo è 200; i valori superiori a 200 verranno coarti a 200.

pageTokenstring

Un token di pagina, ricevuto da una chiamata precedente ListInstanceChildrenRequest . Fornisci questo per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a ListInstanceChildrenRequest devono corrispondere alla chiamata che ha fornito il token della pagina.

Risposta

Questo metodo è asincrono e restituisce un'"operazione", che rappresenta lo stato corrente della stessa. Contiene un percorso endpoint che è possibile sondare per ottenere la risposta reale e i metadati applicabili. Per ulteriori informazioni, consulta la documentazione sulle operazioni di lunga durata.

Le sezioni seguenti descrivono gli oggetti di risposta e metadati forniti al completamento di un'operazione.

Risposta

Restituisce un elenco dei figli dell'esempio.

instancesarray<Instance>

Un elenco di istanze figlie.

nextPageTokenstring

Un token, che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non ci sono pagine successive.

Metadati

Nessuno

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