*Este contenido se traduce usando la IA (Beta) y puede contener errores. Para ver esta página en inglés, haz clic en aquí.

Instance

Representa una instancia de modelo de datos.

Atributos

pathstring

El camino de recursos de la instancia.

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

hasChildrenboolean
Solo salida

si la instancia tiene algún hijo instancia.

engineInstanceobject

los detalles de la propiedad de la instancia.

URL base

https://apis.roblox.com
El recurso Instance

{
"path": "universes/123/places/123/instances/0123456789abcdef0123456789abcdef",
"hasChildren": true,
"engineInstance": {
"Id": "string",
"Parent": "string",
"Name": "string",
"Details": {
"Folder": {}
}
}
}

Instance

Obtener instancia
Beta

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

Obtiene una instancia y sus datos de propiedad.

El tamaño máximo de los datos de respuesta admitidos es de 500,000 bytes.Si se supera este límite, el devuelto Operation se completará con un resultado de error que tenga un código de error de 422.

Ámbitos
universe.place.instance:read
SolicitudParámetros de ruta
universe_idstring
Obligatorio

La identificación del universo.

place_idstring
Obligatorio

La identificación del lugar.

instance_idstring
Obligatorio

La identificación de la instancia.

Respuesta

Este método es asíncrono y devuelve una Operación, que representa el estado actual de la operación. Contiene una ruta final que puede sondear para obtener la respuesta real y los metadatos aplicables. Ve la documentation en operaciones de larga duración para más información.

Las siguientes secciones describen la respuesta y los objetos metadatos que se proporcionan cuando una operación termina.

RespuestaInstanceMetadatos

Nada

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

Actualizar instancia
Beta

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

Actualiza los datos de propiedad de una instancia.

Al actualizar la propiedad de fuente de una instancia Script actual, el tamaño máximo de propiedad admitido es de 200,000 bytes después de la codificación UTF-8.

Ámbitos
universe.place.instance:write
SolicitudParámetros de ruta
universe_idstring
Obligatorio

La identificación del universo.

place_idstring
Obligatorio

La identificación del lugar.

instance_idstring
Obligatorio

La identificación de la instancia.

Parámetros de consulta
updateMaskstring

La lista de campos para actualizar. Esta cadena está formateada como Timestamp.

Solicitar cuerpoInstance
Respuesta

Este método es asíncrono y devuelve una Operación, que representa el estado actual de la operación. Contiene una ruta final que puede sondear para obtener la respuesta real y los metadatos aplicables. Ve la documentation en operaciones de larga duración para más información.

Las siguientes secciones describen la respuesta y los objetos metadatos que se proporcionan cuando una operación termina.

RespuestaInstanceMetadatos

Nada

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

Lista de hijos de instancia
Beta

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

Lista los hijos de una instancia.

El tamaño máximo de los datos de respuesta admitidos es de 500,000 bytes.Si se supera este límite, el devuelto Operation se completará con un resultado de error que tenga un código de error de 422.

Ámbitos
universe.place.instance:read
SolicitudParámetros de ruta
universe_idstring
Obligatorio

La identificación del universo.

place_idstring
Obligatorio

La identificación del lugar.

instance_idstring
Obligatorio

La identificación de la instancia.

Parámetros de consulta
maxPageSizenumber

El número máximo de instancia hija para devolver.El servicio puede devolver menos que este valor.Si no se especifica, se devolverán un máximo de 200 hijos.El valor máximo es 200; los valores por encima de 200 se verán obligados a 200.

pageTokenstring

Una ficha de página, recibida de una llamada anterior ListInstanceChildrenRequest. Proporcione esto para recuperar la página siguiente.

Al paginar, todos los demás parámetros proporcionados a ListInstanceChildrenRequest deben coincidir con la llamada que proporcionó el token de página.

Respuesta

Este método es asíncrono y devuelve una Operación, que representa el estado actual de la operación. Contiene una ruta final que puede sondear para obtener la respuesta real y los metadatos aplicables. Ve la documentation en operaciones de larga duración para más información.

Las siguientes secciones describen la respuesta y los objetos metadatos que se proporcionan cuando una operación termina.

Respuesta

Devuelve una lista de los hijos de la instancia.

instancesarray<Instance>

Una lista de instancias hijas.

nextPageTokenstring

Una token, que se puede enviar como page_token para recuperar la siguiente página. Si este campo se omite, no hay páginas posteriores.

Metadatos

Nada

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