订阅数据存储(测试版)
*此内容使用人工智能(Beta)翻译,可能包含错误。若要查看英文页面,请点按 此处。
本页包含用于处理订阅数据存储的参考文档。了解有关使用 API 的更多信息,请参阅 处理数据存储的 API 请求 和 使用指南。
OrderedDataStores
列表
返回从订阅数据存商店中列出的入口列表。
参数
目标订阅数据存商店的名称。
数据存储范围的名称。请参阅范围。
要返回传的最大入口数量。服务可能返回小于此值。默认值为 10。最大值为 100 ,任何输入超过 100 都被强制为 100 。
从以前的 List 调用收到的页面代币。提供这个以检索后续页面。当页面分页时,所有其他参数提供给 List 必须与提供页面代币的调用匹配。
枚举方向。默认排序为上升。输入一个 desc 后缀以下降。
返回传的输入的资格值范围。请参阅过滤。
请求
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries' \
--header 'x-api-key: <insert-api-key>'
答复
必要权限
调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息,请查看 【管理 API 密钥】(/cloud/auth/api-keys)。
请参阅限速。
Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. Learn more about rate limits.
创建
创建一个带有提供的内容值的新条目。
请求
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries?id=<id>' \
--header 'x-api-key: <insert-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"value": <long>
}'
答复
必要权限
调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息,请查看 【管理 API 密钥】(/cloud/auth/api-keys)。
请参阅限速。
Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. Learn more about rate limits.
获取
获取并返回指定的入口。
请求
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \
--header 'x-api-key: <insert-api-key>'
答复
必要权限
调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息,请查看 【管理 API 密钥】(/cloud/auth/api-keys)。
请参阅限速。
Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. Learn more about rate limits.
删除
删除指定的入口。
请求
curl --location --request DELETE 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \
--header 'x-api-key: <insert-api-key>'
答复
必要权限
调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息,请查看 【管理 API 密钥】(/cloud/auth/api-keys)。
请参阅限速。
Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. Learn more about rate limits.
更新
更新一个入口值并返回更新的入口。
请求
curl --location --request PATCH 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \
--header 'x-api-key: <insert-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"value": <long>
}'
答复
必要权限
调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息,请查看 【管理 API 密钥】(/cloud/auth/api-keys)。
请参阅限速。
Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. Learn more about rate limits.
增量
将键的值增加所提供的数量,并返回更新的入口。
已知问题:输入值可以超过有效范围,这可能会在后端持续存在。返回的值将卡在有效范围内。
请求
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>:increment' \
--header 'x-api-key: <insert-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"amount": <long>
}'
答复
必要权限
调用此端点需要以下 API 密钥权限。关于生成正确密钥的更多信息,请查看 【管理 API 密钥】(/cloud/auth/api-keys)。
请参阅限速。
Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. Learn more about rate limits.
对象
下列对象描述了接受或返回的有效载荷。请参阅每个单独的端点,以了解更多关于这些对象用途的信息。
CreateEntryRequest
创建一个带有提供的值的新条目。
属性
设置新入口的值。如果输入值超过了 int64 支持的最大值 9,223,372,036,854,775,807,请求以 400 错误返回失败。
Entry
代表一个入口。
属性
入口的名称
请求的资源路径。
入口的值。
IncrementEntryRequest
增量入口值。
属性
由入口值增加的数量。如果输入值超过了 int64 支持的最大值 9,223,372,036,854,775,807,请求以 400 错误返回失败。
ListEntriesResponse
父系列合中的入口列表。
属性
从指定范围的入口。
一个代币,可以发送为 page_token 来检索下一页。如果该字段被忽略,就没有后续页面。
UpdateEntryRequest
用新值更新提供的入口。
属性
用于更新入口的值。如果输入值超过了 int64 支持的最大值 9,223,372,036,854,775,807,请求以 400 错误返回失败。