标准数据存储

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

该页包含用于与标准数据存储工作的参考文档。了解有关使用 API 的更多信息，请参阅处理数据存储的 API 请求和使用指南。

Datastores

https://apis.roblox.com/datastores

相对于基础 URL 的路径，下列端点是可用的。

列出数据存储

GET /v1/universes/{universeId}/standard-datastores

返回体验数据存储的列表。

参数

universeId number

指向你想要访问的数据存1) 使用权 2）通行证 3）访问权限的体验标识。你可以在创建者面板上复制你的体验宇宙ID。

Path

必填

cursor string

提供要求下一组数据。见指针。

limit number

要回传的最大物品数。每次调用只读一个分区，因此在一个分区上没有目标时可以返回少于给定值。

prefix string

提供仅返回具有此前缀的数据存储。

请求

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "prefix=Player" \
-d "limit=5"

答复

200 - OK

返回： object

application/json

{
  "datastores": [
    {
      "name": "PlayerInventory",
      "createdTime": "2022-02-18T22:38:59.9244932Z"
    },
    {
      "name": "PlayerExperience",
      "createdTime": "2022-02-18T23:00:10.4773508Z"
    },
    {
      "name": "PlayerWeapons",
      "createdTime": "2022-02-18T23:00:22.3725681Z"
    },
    {
      "name": "PlayerArmor",
      "createdTime": "2022-02-18T22:59:33.8472882Z"
    },
    {
      "name": "PlayerHP",
      "createdTime": "2022-02-18T22:58:47.6904028Z"
    }
  ],
  "nextPageCursor": "..."
}

data array<object>

目标体验中的数据存储阵列。

nextPageCursor string

表示在请求的结果设置中有更多可用数据。请参阅鼠标。

必要权限

调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息，请查看【管理 API 密钥】(/cloud/auth/api-keys)。

列表资料库

Entries

https://apis.roblox.com/datastores

相对于基础 URL 的路径，下列端点是可用的。

列出入口

GET /v1/universes/{universeId}/standard-datastores/datastore/entries

返回数据存商店中的入口键列表。

参数

universeId number

指向你想要访问的数据存1) 使用权 2）通行证 3）访问权限的体验标识。你可以在创建者面板上复制你的体验宇宙ID。

Path

必填

datastoreName string

数据存商店的名称。

scope string

默认值为 global 。请参阅范围。

allScopes boolean

设置为真以返回所有范围的键。

prefix string

提供仅返回这个前缀的键。

cursor string

提供要求下一组数据。见指针。

limit number

要回传的最大物品数。每次调用只读一个分区，因此在一个分区上没有目标时可以返回少于给定值。

请求

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "prefix=" \
-d "limit=5"

答复

200 - OK

返回： object

application/json

{
  "keys": [
    {
      "key": "269323"
    }
  ],
  "nextPageCursor": "eyJ2ZXJzaW9uIjoxLCJjdXJzb3IiOiIzIyJ9"
}

keys array<string>

目标数据存商店中的一组入口键。

nextPageCursor string

表示在请求的结果设置中有更多可用数据。请参阅鼠标。

必要权限

调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息，请查看【管理 API 密钥】(/cloud/auth/api-keys)。

列出条目键

获取入口

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

返回与入口相关的值和元数据。

元数据可以在响应头像以关注中/正在关注找到：


content-md5: zuYxEhwuySMv0i8CitXImw==
roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01
roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-attributes: { "myAttribute": "myValue" }
roblox-entry-userids: [1, 2, 3]

| 标题 | 描述 | |---|---| | content-md5 | 内容的基于 64 位编码 MD5 检查总和。请参阅内容-MD5。| | roblox-entry-version | 返回的入口版本。| | roblox-entry-created-time | 入口创建的时间。| | roblox-entry-version-created-time | 这个特定版本创建的时间。| | roblox-entry-attributes | 带有入口标记的属性标签。序列化 JSON 地图对象。| | roblox-entry-userids | 以分号隔开的 Roblox 用户 ID 列表标记了入口。|

参数

universeId number

指向你想要访问的数据存1) 使用权 2）通行证 3）访问权限的体验标识。你可以在创建者面板上复制你的体验宇宙ID。

Path

必填

datastoreName string

数据存商店的名称。

entryKey string

用于识别入口的关键。

scope string

默认值为 global 。请参阅范围。

请求

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323"

答复

200 - OK

成功检索到入口。

返回： object

204 - No Content

必要权限

调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息，请查看【管理 API 密钥】(/cloud/auth/api-keys)。

读取条目

设置输入

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

设置与入口相关的值、元数据和用户ID。

参数

universeId number

指向你想要访问的数据存1) 使用权 2）通行证 3）访问权限的体验标识。你可以在创建者面板上复制你的体验宇宙ID。

Path

必填

datastoreName string

数据存商店的名称。

entryKey string

用于识别入口的关键。

matchVersion string

仅提供更新，如果当前版本与此匹配。

exclusiveCreate boolean

仅创建入口，如果它不存在。

scope string

默认值为 global 。请参阅范围。

roblox-entry-attributes string

与新版本的入口相关的属性。由 JSON 地图对象序列化。如果未提供，现有属性将被清除。

Header

roblox-entry-userids string

分开列出标有入口的 Roblox 用户 ID 列表。如果未提供，现有用户 ID 将被清除。

Header

content-md5 string

基于 Base64 编码的内容 MD5 检查总和。请参阅内容-MD5 。

Header

请求

curl

curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry?datastoreName=Coins&entryKey=269323" \
--header "x-api-key: ${API_KEY}" \
--header "content-md5: IGPBYI1uC6+AJJxC4r5YBA==" \
--header "content-type: application/json" \
--header "roblox-entry-userids: [269323]" \
--header "roblox-entry-attributes: {}" \
--d "value"

答复

200 - OK

返回： object

version string

资格证书的版本名称。

deleted boolean

指示入口是否已被删除。

contentLength number

内容的长度。

createdTime string

版本在 ISO 时间格式中创建的时间戳。

objectCreatedTime string

数据存储在 ISO 时间格式中创建的时间戳。

必要权限

调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息，请查看【管理 API 密钥】(/cloud/auth/api-keys)。

创建条目
更新条目

删除入口

DELETE /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

通过创建墓碑版本标记入口为已删除。入口永久删除后 30 天。

参数

universeId number

指向你想要访问的数据存1) 使用权 2）通行证 3）访问权限的体验标识。你可以在创建者面板上复制你的体验宇宙ID。

Path

必填

datastoreName string

数据存商店的名称。

entryKey string

用于识别入口的关键。

scope string

默认值为 global 。请参阅范围。

请求

curl

curl --include --location --request DELETE "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323"

答复

204 - No Content

必要权限

调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息，请查看【管理 API 密钥】(/cloud/auth/api-keys)。

删除条目

增量输入

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/increment

增加给定数量的入口值或创建一个新的入口值与该数量。返回入口和元数据。

元数据可以在响应头像以关注中/正在关注找到：


content-md5: zuYxEhwuySMv0i8CitXImw==
roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01
roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-attributes: { "myAttribute": "myValue" }
roblox-entry-userids: [1, 2, 3]

参数

universeId number

指向你想要访问的数据存1) 使用权 2）通行证 3）访问权限的体验标识。你可以在创建者面板上复制你的体验宇宙ID。

Path

必填

datastoreName string

数据存商店的名称。

entryKey string

用于识别入口的关键。

incrementBy number

入口应增加的数量，或如果不存在，起始值。

scope string

默认值为 global 。请参阅范围。

roblox-entry-attributes string

与新版本的入口相关的属性。由 JSON 地图对象序列化。如果未提供，现有属性将被清除。

Header

roblox-entry-userids string

与入口标签匹配的 Roblox 用户 ID 列表，分号隔开。如果未提供，将清除现有用户 ID。

Header

请求

curl

curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/increment" \
--header "x-api-key: ${API_KEY}" \
--header 'content-length: 0' \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323" \
-d "incrementBy=3"

答复

200 - OK

返回增量后的入口最新版本。

返回： object

204 - No Content

必要权限

调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息，请查看【管理 API 密钥】(/cloud/auth/api-keys)。

创建条目
更新条目

获取入口版本

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions/version

返回特定版本的入口的值和元数据。

元数据可以在响应头像以关注中/正在关注找到：


content-md5: zuYxEhwuySMv0i8CitXImw==
roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01
roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-attributes: { "myAttribute": "myValue" }
roblox-entry-userids: [1, 2, 3]

参数

universeId number

指向你想要访问的数据存1) 使用权 2）通行证 3）访问权限的体验标识。你可以在创建者面板上复制你的体验宇宙ID。

Path

必填

datastoreName string

数据存商店的名称。

entryKey string

用于识别入口的关键。

versionId string

要检查的版本。

scope string

默认值为 global 。请参阅范围。

请求

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions/version" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323" \
-d "versionId=08D9E6A3F2188CFF.0000000003.08D9E6DE485A7680.01"

答复

200 - OK

成功检索到入口。

返回： object

必要权限

调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息，请查看【管理 API 密钥】(/cloud/auth/api-keys)。

读取版本

限制

每个 API 密钥：每个 IP 地址每 60 秒有 5000 次请求

列出入口版本

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions

返回一个入口的版本列表。

参数

universeId number

指向你想要访问的数据存1) 使用权 2）通行证 3）访问权限的体验标识。你可以在创建者面板上复制你的体验宇宙ID。

Path

必填

datastoreName string

数据存商店的名称。

entryKey string

用于识别入口的关键。

scope string

默认值为 global 。请参阅范围。

cursor string

提供要求下一组数据(见鼠标 )。

startTime string

提供不包含比此时间戳更早的版本。

endTime string

提供不包含比此时间戳晚的版本。

sortOrder string

要么 Ascending (先前版本先行)，要么 Descending (后续版本先行)。

limit number

要回传的最大物品数。每次调用只读一个分区，因此在一个分区上没有目标时可以返回少于给定值。

请求

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323" \
-d "limit=5"

答复

200 - OK

返回： object

version string

资格证书的版本名称。

deleted boolean

指示入口是否已被删除。

contentLength number

内容的长度。

createdTime string

版本在 ISO 时间格式中创建的时间戳。

objectCreatedTime string

数据存储在 ISO 时间格式中创建的时间戳。

其他状态码

必要权限

调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息，请查看【管理 API 密钥】(/cloud/auth/api-keys)。

列表版本

对象

下列对象描述了接受或返回的有效载荷。请参阅每个单独的端点，以了解更多关于这些对象用途的信息。

DataStore

带有名称和创建时间的数据存储对象。

属性

name string

数据存商店的名称。

createdTime string

数据存储在 ISO 时间格式中创建的时间戳。

EntryVersion

由 List Entry Versions 方法返回的入口版本对象。

属性

version string

资格证书的版本名称。

deleted boolean

指示入口是否已被删除。

contentLength number

内容的长度。

createdTime string

版本在 ISO 时间格式中创建的时间戳。

objectCreatedTime string

数据存储在 ISO 时间格式中创建的时间戳。

标准数据存储

Datastores

列出数据存储

参数

请求

答复

必要权限

Entries

列出入口

参数

请求

答复

必要权限

获取入口

参数

请求

答复

必要权限

设置输入

参数

请求

答复

必要权限

删除入口

参数

请求

答复

必要权限

增量输入

参数

请求

答复

必要权限

获取入口版本

参数

请求

答复

必要权限

限制

列出入口版本

参数

请求

答复

必要权限

对象

DataStore

属性

EntryVersion

属性

在此页面