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

DataStore

Representa um lojade dados.

Atributos

pathstring

O caminho de recursos do lojade dados.

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

createTimestring
Apenas saída

O timestamp quando o armazenamento de dados foi criado. Esta cadeia de caracteres é formatada como um Timestamp.

idstring
Apenas saída

O ID do armazenamento de dados. Corresponde ao último segmento do caminho.

URL base

https://apis.roblox.com
O recurso DataStore

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

DataStore

List Data Stores
Beta

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

Retorna uma lista de armazenamentos de dados.

Escopos
universe-datastores.control:list
SolicitaçãoParâmetros de endereço
universe_idstring
Obrigatório

O ID do universo.

Parâmetros da consulta
maxPageSizenumber

O número máximo de armazenamentos de dados a retornar.O serviço pode retornar menos que esse valor.Se não especificado, no máximo 10 armazenamentos de dados são retornados.O valor máximo é 100 e valores mais altos são definidos como 100.

pageTokenstring

Um token de página, recebido de uma chamada anterior, para recuperar uma página posterior.

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

filterstring

Este campo pode ser definido para filtrar os recursos retornados.

O campo filter suporta um subconjunto muito pequeno de CEL:

  • Apenas o campo id é suportado.
  • Apenas a função startsWith está disponível; nenhum outro operador ou construções são suportados.

Exemplo de filtro: id.startsWith("foo").

Resposta

Uma lista de armazenamentos de dados na coleçõespai.

dataStoresarray<DataStore>

Os DataStores do Universo especificado.

nextPageTokenstring

Um token que você pode enviar como um parâmetro pageToken para recuperar a próxima página. Se este campo for omitido, não há páginas subsequentes.

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

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

DataStore

Snapshot Data Stores
Beta

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

Faz um novo instantâneo dos armazenamentos de dados em uma experiência.

Após um instantâneo, a próxima escrita para cada chave na experiência criará um backup versionado dos dados anteriores, independentemente do tempo da última escrita.

De fato, todos os dados ativos no momento do instantâneo são garantidos de estar disponíveis como um backup versionado por pelo menos 30 dias.

Os instantâneos podem ser tirados uma vez por dia UTC, por experiência.Se o mais recente instantâneo foi capturado dentro do mesmo dia UTC, esta operação é uma sem operação e o tempo do mais recente instantâneo será retornado.

Para mais informações sobre o uso de instantâneos, consulte o guia Armazenamento de Dados.

Escopos
universe-datastores.control:snapshot
SolicitaçãoParâmetros de endereço
universe_idstring
Obrigatório

O ID do universo.

Requisitar corpo
Resposta

Retorna se um novo instantâneo foi feito e o tempo do instantâneo mais recente após a operação (independente de se um novo instantâneo foi feito).

newSnapshotTakenboolean

Se um novo instantâneo foi capturado por essa operação. (Apenas um instantâneo pode ser capturado por experiência por dia UTC.).

latestSnapshotTimestring

O momento do mais recente instantâneo após a operação (independente de se um novo instantâneo foi criado). Este tempo é sempre retornado em UTC. Esta cadeia de caracteres é formatada como um 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 '{}'
Resposta

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