*Ta zawartość została przetłumaczona przy użyciu narzędzi AI (w wersji beta) i może zawierać błędy. Aby wyświetlić tę stronę w języku angielskim, kliknij tutaj.

Instance

Reprezentuje instancję modelu danych.

Atrybuty

pathstring

Ścieżka zasobów instancji.

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

hasChildrenboolean
Tylko dane wyjściowe

czy instancja ma jakieś dzieci instancji.

engineInstanceobject

szczegóły właściwości instancji.

Podstawowy adres URL
https://apis.roblox.com
Zasób Instance
{

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

  "hasChildren": true,

  "engineInstance": {

    "Id": "string",

    "Parent": "string",

    "Name": "string",

    "Details": {

      "Folder": {}

    }

  }

}

Instance

Zdobądź instancję
Beta

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

Zdobywa instancję i jej dane o właściwościach.

Maksymalny rozmiar danych odpowiedzi wspieranych jest 500,000 bajtów.Jeśli ten limit zostanie przekroczony, zwrócony Operation zostanie ukończony wynikiem błędu, który ma kod błędu 422.

Zakresy
universe.place.instance:read
ŻądanieParametry ścieżki
universe_idstring
Wymagane

ID wszechświata.

place_idstring
Wymagane

ID miejsca.

instance_idstring
Wymagane

ID instancji.

Odpowiedź:

Jest to metoda asynchroniczna, która zwraca deskryptor „Operation”, odpowiadający bieżącemu stanowi operacji. Zawiera punkt końcowy, który można wybrać przy użyciu funkcji poll, aby otrzymać rzeczywistą odpowiedź i nadające się do użycia metadane. Więcej informacji na temat operacji długotrwałych zawiera dokumentacja.

W poniższych sekcjach opisano odpowiedzi i obiekty w postaci metadanych, które zostają podane po ukończeniu operacji.

Odpowiedź:InstanceMetadane

Brak

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

Aktualizacja instancji
Beta

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

Aktualizuje dane o właściwości instancji.

Aktualizując właściwość źródła instancji Script, maksymalny rozmiar właściwości wspierany po kodowaniu UTF-8 wynosi 200 000 bajtów.

Zakresy
universe.place.instance:write
ŻądanieParametry ścieżki
universe_idstring
Wymagane

ID wszechświata.

place_idstring
Wymagane

ID miejsca.

instance_idstring
Wymagane

ID instancji.

Parametry zapytania
updateMaskstring

Lista pól do aktualizacji. Ten ciąg jest sformatowany jako FieldMask.

Treść żądaniaInstance
Odpowiedź:

Jest to metoda asynchroniczna, która zwraca deskryptor „Operation”, odpowiadający bieżącemu stanowi operacji. Zawiera punkt końcowy, który można wybrać przy użyciu funkcji poll, aby otrzymać rzeczywistą odpowiedź i nadające się do użycia metadane. Więcej informacji na temat operacji długotrwałych zawiera dokumentacja.

W poniższych sekcjach opisano odpowiedzi i obiekty w postaci metadanych, które zostają podane po ukończeniu operacji.

Odpowiedź:InstanceMetadane

Brak

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 dzieci instancji
Beta

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

Wylicza dzieci instancji.

Maksymalny rozmiar danych odpowiedzi wspieranych jest 500,000 bajtów.Jeśli ten limit zostanie przekroczony, zwrócony Operation zostanie ukończony wynikiem błędu, który ma kod błędu 422.

Zakresy
universe.place.instance:read
ŻądanieParametry ścieżki
universe_idstring
Wymagane

ID wszechświata.

place_idstring
Wymagane

ID miejsca.

instance_idstring
Wymagane

ID instancji.

Parametry zapytania
maxPageSizenumber

Maksymalna liczba instancji dziecka do zwrotu.Usługa może zwrócić mniej niż tę wartość.Jeśli nie zostanie określone, zostanie zwróconych maksymalnie 200 dzieci.Maksymalna wartość wynosi 200; wartości powyżej 200 zostaną zmuszone do 200.

pageTokenstring

Żeton strony otrzymany z poprzedniego wezwania ListInstanceChildrenRequest. Dostarcz to, aby odzyskać następną stronę.

Podczas paginowania wszystkie pozostałe parametry dostarczone do ListInstanceChildrenRequest muszą pasować do wezwania, które dostarczyło token strony.

Odpowiedź:

Jest to metoda asynchroniczna, która zwraca deskryptor „Operation”, odpowiadający bieżącemu stanowi operacji. Zawiera punkt końcowy, który można wybrać przy użyciu funkcji poll, aby otrzymać rzeczywistą odpowiedź i nadające się do użycia metadane. Więcej informacji na temat operacji długotrwałych zawiera dokumentacja.

W poniższych sekcjach opisano odpowiedzi i obiekty w postaci metadanych, które zostają podane po ukończeniu operacji.

Odpowiedź:

Zwraca listę dzieci instancji.

instancesarray<Instance>

Lista instancji dzieci.

nextPageTokenstring

Token, który można wysłać jako page_token aby odzyskać następną stronę. Jeśli to pole zostanie pominięte, nie ma następnych stron.

Metadane

Brak

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