*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

Instance

Representa uma instância de modelo de dados.

Atributos

pathstring

O caminho de recursos da instância.

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

hasChildrenboolean
Apenas saída

se a instância tem alguma instância filha.

engineInstanceobject

os detalhes da propriedade da instância.

URL base
https://apis.roblox.com
O recurso Instance
{

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

  "hasChildren": true,

  "engineInstance": {

    "Id": "string",

    "Parent": "string",

    "Name": "string",

    "Details": {

      "Folder": {}

    }

  }

}

Instance

Obter Instância
Beta

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

Obtém uma instância e seus dados de propriedade.

O tamanho máximo de dados de resposta suportado é 500.000 bytes.Se esse limite for excedido, o retornado Operation será concluído com um resultado de erro que tem um código de erro de 422 .

Escopos
universe.place.instance:read
SolicitaçãoParâmetros de endereço
universe_idstring
Obrigatório

O ID do universo.

place_idstring
Obrigatório

O ID do local.

instance_idstring
Obrigatório

O ID da instância.

Resposta

Este método é assíncrono e retorna uma "Operação", que representa o estado atual da operação. Ele contém um caminho de endpoint que você pode solicitar para obter a resposta real e os metadados aplicáveis. Veja o documentation em operações de longo prazo para obter mais informações.

As seções a seguir descrevem os objetos de resposta e metadados que são fornecidos quando uma operação se completa.

RespostaInstanceMetadados

Nenhum

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

Atualizar Instância
Beta

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

Atualiza os dados de propriedade de uma instância.

Ao atualizar a propriedade de origem de uma instância Script atual, o tamanho máximo de propriedade suportado é de 200.000 bytes após a codificação UTF-8.

Escopos
universe.place.instance:write
SolicitaçãoParâmetros de endereço
universe_idstring
Obrigatório

O ID do universo.

place_idstring
Obrigatório

O ID do local.

instance_idstring
Obrigatório

O ID da instância.

Parâmetros da consulta
updateMaskstring

A lista de campos para atualizar. Esta cadeia de caracteres está formatada como um FieldMask.

Requisitar corpoInstance
Resposta

Este método é assíncrono e retorna uma "Operação", que representa o estado atual da operação. Ele contém um caminho de endpoint que você pode solicitar para obter a resposta real e os metadados aplicáveis. Veja o documentation em operações de longo prazo para obter mais informações.

As seções a seguir descrevem os objetos de resposta e metadados que são fornecidos quando uma operação se completa.

RespostaInstanceMetadados

Nenhum

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

Listar Filhos de Instância
Beta

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

Lista os filhos de uma instância.

O tamanho máximo de dados de resposta suportado é 500.000 bytes.Se esse limite for excedido, o retornado Operation será concluído com um resultado de erro que tem um código de erro de 422 .

Escopos
universe.place.instance:read
SolicitaçãoParâmetros de endereço
universe_idstring
Obrigatório

O ID do universo.

place_idstring
Obrigatório

O ID do local.

instance_idstring
Obrigatório

O ID da instância.

Parâmetros da consulta
maxPageSizenumber

O número máximo de instâncias filhas a retornar.O serviço pode retornar menos que esse valor.Se não especificado, no máximo 200 crianças serão retornadas.O valor máximo é 200; valores acima de 200 serão coagidos a 200.

pageTokenstring

Um token de página, recebido de uma chamada anterior ListInstanceChildrenRequest . Forneça isso para recuperar a página subseqüente.

Ao paginar, todos os outros parâmetros fornecidos a ListInstanceChildrenRequest devem corresponder à chamada que forneceu o token da página.

Resposta

Este método é assíncrono e retorna uma "Operação", que representa o estado atual da operação. Ele contém um caminho de endpoint que você pode solicitar para obter a resposta real e os metadados aplicáveis. Veja o documentation em operações de longo prazo para obter mais informações.

As seções a seguir descrevem os objetos de resposta e metadados que são fornecidos quando uma operação se completa.

Resposta

Retorna uma lista dos filhos da instância.

instancesarray<Instance>

Uma lista de instâncias filhas.

nextPageTokenstring

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se este campo for omitido, não há páginas subsequentes.

Metadados

Nenhum

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