通过从现有备份进行恢复来创建新数据库。
新数据库必须与现有备份位于同一云端区域或多区域位置。其行为类似于 [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase],不同之处在于,系统会使用现有备份中的数据库类型、索引配置和文档创建新数据库,而不是创建新的空数据库。
long-running operation
可用于跟踪恢复进度,其中 Operation 的 metadata
字段类型为 RestoreDatabaseMetadata
。如果恢复成功,response
类型为 Database
。在 LRO 完成之前,新数据库不可读写。
HTTP 请求
POST https://firestore.googleapis.com/v1/{parent=projects/*}/databases:restore
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
parent |
必需。要在其中恢复数据库的项目。格式为 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "databaseId": string, // Union field |
字段 | |
---|---|
databaseId |
必需。要用于数据库的 ID,该 ID 将成为数据库资源名称的最后一个组成部分。此数据库 ID 不得与现有数据库关联。 此值应为 4-63 个字符。有效字符为 /[a-z][0-9]-/,其中第一个字符是一个字母,最后一个字符是一个字母或数字。不得为类似 UUID 的 /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/。 “(默认)”数据库 ID 也有效。 |
联合字段
|
|
backup |
要从中恢复的备份。必须与父级属于同一项目。 格式为: |
响应正文
如果成功,则响应正文包含一个 Operation
实例。
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
如需了解详情,请参阅身份验证概览。