REST Resource: projects.locations.instances

资源:DatabaseInstance

Realtime Database 实例的表示形式。如需详细了解如何与 DatabaseInstance 的内容交互,请访问:https://firebase.google.com/docs/database/rest/start

JSON 表示法
{
  "name": string,
  "project": string,
  "databaseUrl": string,
  "type": enum (DatabaseInstanceType),
  "state": enum (State)
}
字段
name

string

数据库实例的完全限定资源名称,格式为:projects/{project-number}/locations/{location-id}/instances/{database-id}

project

string

仅限输出。此实例所属项目的资源名称。例如:projects/{project-number}

databaseUrl

string

仅限输出。仅限输出。数据库的全局唯一主机名。

type

enum (DatabaseInstanceType)

不可变。数据库实例类型。创建时,只允许使用 USER_DATABASE,这也是系统省略时的默认设置。

state

enum (State)

仅限输出。数据库的生命周期状态。只读。

数据库实例类型

数据库实例的可能类型。

枚举
DATABASE_INSTANCE_TYPE_UNSPECIFIED 未知状态,可能是后端错误导致的。仅用于区分未设置的值。
DEFAULT_DATABASE 创建项目时预配的默认数据库。
USER_DATABASE 用户创建的数据库。

状态

数据库生命周期状态。

枚举
LIFECYCLE_STATE_UNSPECIFIED 未指定的状态,可能是后端错误导致的。仅用于区分未设置的值。
ACTIVE 正常和活跃状态。
DISABLED 数据库处于停用状态。您日后可以将其重新启用。
DELETED 数据库处于已删除状态。

方法

create

请求创建新的 DatabaseInstance

delete

标记要删除的 DatabaseInstance

disable

停用 DatabaseInstance

get

获取由指定资源名称标识的 DatabaseInstance

list

列出与指定的父级项目关联的每个 DatabaseInstance

reenable

启用 DatabaseInstance

undelete

恢复之前标记为要删除的 DatabaseInstance