*此内容使用人工智能(Beta)翻译,可能包含错误。若要查看英文页面,请点按 此处

DataStore

代表数据存储。

属性

pathstring

数据存储的资源路径。

格式:universes/{universe_id}/data-stores/{data_store_id}.

createTimestring
仅输出

数据存储创建时的时戳。. 此字符串格式为 FieldMask

idstring
仅输出

数据存储的ID。与路径的最后一部分匹配。.

基本网址

https://apis.roblox.com
DataStore 资源

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

DataStore

列出数据存储
Beta

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

返回一列数据存储。

范围
universe-datastores.control:list
请求路径参数
universe_idstring
必填

宇宙ID。.

查询参数
maxPageSizenumber

要返回的最大数据存储数量。服务可能返回小于此值。如果未指定,最多返回 10 个数据存储。最大值为 100,更高值设置为 100。.

pageTokenstring

从前一次调用收到的页面代币,用于检索后续页面。

当页面分页时,所有其他参数提供给后续调用的必须与提供页面代币的调用匹配。.

filterstring

该字段可以设置以便筛选返回的资源。

filter 字段支持一个非常小的子集 Cel:

  • 仅支持 id 字段。
  • 只有 startsWith 函数可用;没有其他操作者或插件支持。

示例过滤器:id.startsWith("foo").

答复

父集合中数据存储列表。

dataStoresarray<DataStore>

指定宇宙的数据存储。.

nextPageTokenstring

您可以将其作为pageToken参数发送的代币来检索下一页。如果该字段被忽略,就没有后续页面。.

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

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

DataStore

快照数据存储
Beta

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

在体验中捕获新的数据存储镜像。

在快照之后,下一次写入体验中的每个键将创建一个版本备份的以前数据,无论最后一次写入的时间。

实际上,在快照时当前所有数据的可用性都得到保证,至少在 30 天内作为版本备份可用。

每个 UTC 日期可以拍摄一次截图,每个体验。如果最新的快照在同一天的 UTC 时间内进行,这个操作是无操作的,最新快照的时间将返回。

了解有关使用快照的更多信息,请参阅数据存储引擎指南。

范围
universe-datastores.control:snapshot
请求路径参数
universe_idstring
必填

宇宙ID。.

请求正文
答复

返回是否采取了新的截图,操作后最新截图的时间(无论是否采取了新的截图)。

newSnapshotTakenboolean

这次操作是否导致了新的快照。(每个 UTC 日期只能导出一个快照。).

latestSnapshotTimestring

操作后最新的快照时间(无论是否创建了新快照)。这个时间总是以 UTC 返回。. 此字符串格式为 FieldMask

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 '{}'
答复

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