Le chemin de ressource de l'instance.
Format : universes/{universe_id}/places/{place_id}/instances/{instance_id}.
*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.
Instance
Représente une instance de modèle de données.
Attributs
si l'instance a des enfants instance.
les détails de propriété de l'instance.
URL de base
https://apis.roblox.comLa ressource Instance
{
"path": "universes/123/places/123/instances/0123456789abcdef0123456789abcdef",
"hasChildren": true,
"engineInstance": {
"Id": "string",
"Parent": "string",
"Name": "string",
"Details": {
"Folder": {}
}
}
}Instance
Obtenir une instance
GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}
Obtient une instance et ses données de propriété.
La taille maximum des données de réponse supportée est de 500 000 octets.Si cette limite est dépassée, le retourné Operation sera terminé avec un résultat d'erreur qui a un code d'erreur de 422 .
universe.place.instance:read
RequêteParamètres du cheminL'ID de l'univers.
L'ID du lieu.
L'ID de l'instance.
RéponseRéponseInstanceMétadonnées
Cette méthode est asynchrone et retourne une Operation, qui représente l'état courant de l'opération. Il contient un chemin de terminaison que vous pouvez interroger pour obtenir la vraie réponse et les métadonnées applicables. Voir la documentation sur les opérations à long terme pour plus d’informations.
Les sections suivantes décrivent la réponse et les objets de métadonnées qui sont fournis lorsqu'une opération se termine.
Aucun
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
Mise à jour de l'instance
PATCH /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}
Mise à jour des données de propriété d'une instance.
Lors de la mise à jour de la propriété source d'une instance Script , la taille maximale de propriété supportée est de 200 000 octets après encodage UTF-8.
universe.place.instance:write
RequêteParamètres du cheminL'ID de l'univers.
L'ID du lieu.
L'ID de l'instance.
La liste des champs à mettre à jour. Cette chaîne est formatée comme un FieldMask.
RéponseRéponseInstanceMétadonnées
Cette méthode est asynchrone et retourne une Operation, qui représente l'état courant de l'opération. Il contient un chemin de terminaison que vous pouvez interroger pour obtenir la vraie réponse et les métadonnées applicables. Voir la documentation sur les opérations à long terme pour plus d’informations.
Les sections suivantes décrivent la réponse et les objets de métadonnées qui sont fournis lorsqu'une opération se termine.
Aucun
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 des enfants d'instance
GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren
Liste les enfants d'une instance.
La taille maximum des données de réponse supportée est de 500 000 octets.Si cette limite est dépassée, le retourné Operation sera terminé avec un résultat d'erreur qui a un code d'erreur de 422 .
universe.place.instance:read
RequêteParamètres du cheminL'ID de l'univers.
L'ID du lieu.
L'ID de l'instance.
Le nombre maximum d'instance enfant à retourner.Le service peut retourner moins que cette valeur.Si non spécifié, au maximum 200 enfants seront renvoyés.La valeur maximale est de 200 ; les valeurs au-dessus de 200 seront coercées à 200.
Un jeton de page, reçu d'un appel précédent ListInstanceChildrenRequest. Fournissez-le pour récupérer la page suivante.
Lors de la pagination, tous les autres paramètres fournis à ListInstanceChildrenRequest doivent correspondre à l'appel qui a fourni le jeton de page.
RéponseRéponseinstancesarray<Instance> nextPageTokenstring
Cette méthode est asynchrone et retourne une Operation, qui représente l'état courant de l'opération. Il contient un chemin de terminaison que vous pouvez interroger pour obtenir la vraie réponse et les métadonnées applicables. Voir la documentation sur les opérations à long terme pour plus d’informations.
Les sections suivantes décrivent la réponse et les objets de métadonnées qui sont fournis lorsqu'une opération se termine.
Renvoie une liste des enfants de l'instance.
Une liste d'instances enfants.
Un jeton, qui peut être envoyé comme page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas de pages suivantes.
Aucun
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}'