REST Resource: projects.locations.instances

リソース: データベースインスタンス

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を復元します。