REST Resource: projects.locations.instances

संसाधन: डेटाबेस इंस्टेंस

रीयलटाइम डेटाबेस उदाहरण का प्रतिनिधित्व। 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 पुनर्स्थापित करता है जिसे पहले हटाए जाने के लिए चिह्नित किया गया था।