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

DataStore

Rappresenta un deposito di dati.

Attributi

pathstring

Il percorso delle risorse del data store.

Formato: universes/{universe_id}/data-stores/{data_store_id}.

createTimestring
Solo output

L'timestamp quando il data store è stato creato. Questa stringa è formattata come Timestamp.

idstring
Solo output

L'ID del data store. Corrisponde all'ultimo segmento del percorso.

URL di base

https://apis.roblox.com
Risorsa DataStore

{
"path": "universes/123/data-stores/some-data-store",
"createTime": "2023-07-05T12:34:56Z",
"id": "string"
}

DataStore

Lista negozi di dati
Beta

GET /cloud/v2/universes/{universe_id}/data-stores

Restituisce un elenco di depositi di dati.

Campi
universe-datastores.control:list
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

Parametri query
maxPageSizenumber

Il numero massimo di archivi di dati da restituire.Il servizio potrebbe restituire meno di questo valore.Se non specificato, vengono restituiti al massimo 10 archivi di dati.Il valore massimo è 100 e i valori più alti sono impostati su 100.

pageTokenstring

Un token di pagina, ricevuto da una chiamata precedente, per recuperare una pagina successiva.

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

filterstring

Questo campo può essere impostato per filtrare le risorse restituite.

Il campo filter supporta un sottinsieme molto piccolo di CEL:

  • Solo il campo id è supportato.
  • Solo la funzione startsWith è disponibile; non sono supportati altri operatori né costrutti.

Filtro di esempio: id.startsWith("foo").

Risposta

Un elenco di DataStore nella collezione padre.

dataStoresarray<DataStore>

I DataStore dall'Universo specificato.

nextPageTokenstring

Un token che puoi inviare come parametro pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non ci sono pagine successive.

GET /cloud/v2/universes/{universe_id}/data-stores

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores?maxPageSize=10&pageToken={string}&filter={string}' \
-H 'x-api-key: {your-api-key}'
Risposta

{
"dataStores": [
{
"path": "universes/123/data-stores/some-data-store",
"createTime": "2023-07-05T12:34:56Z",
"id": "string"
}
],
"nextPageToken": "string"
}

DataStore

Magazzini di dati di snapshot
Beta

POST /cloud/v2/universes/{universe_id}/data-stores:snapshot

Fornisce un nuovo snapshot dei data store in un'esperienza.

Dopo uno snapshot, il prossimo write a ogni chiave nell'esperienza creerà un backup versionato dei dati precedenti, indipendentemente dall'ora dell'ultimo write.

In effetti, tutti i dati attuali al momento dello snapshot sono garantiti di essere disponibili come backup versionato per almeno 30 giorni.

Gli snapshot possono essere presi una volta al giorno UTC, per esperienza.Se l'ultimo snapshot è stato eseguito all'interno dello stesso giorno UTC, questa operazione è una no-op e verrà restituito il tempo dell'ultimo snapshot.

Per ulteriori informazioni sull'utilizzo degli snapshot, vedi la guida del motore Data Store.

Campi
universe-datastores.control:snapshot
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

Corpo della richiesta
Risposta

Restituisce se è stato eseguito un nuovo snapshot e l'ora dell'ultimo snapshot dopo l'operazione (indipendentemente dal fatto che sia stato eseguito un nuovo snapshot).

newSnapshotTakenboolean

Se è stato eseguito un nuovo snapshot da questa operazione. (Solo un snapshot può essere eseguito per esperienza per giorno UTC.).

latestSnapshotTimestring

L'ora dell'ultimo snapshot dopo l'operazione (indipendentemente dal fatto che sia stato creato un nuovo snapshot). Questo tempo viene sempre restituito in UTC. Questa stringa è formattata come Timestamp.

POST /cloud/v2/universes/{universe_id}/data-stores:snapshot

curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores:snapshot' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{}'
Risposta

{
"newSnapshotTaken": true,
"latestSnapshotTime": "2023-07-05T12:34:56Z"
}