ErrorInfo

इसमें, स्ट्रक्चर्ड जानकारी के साथ गड़बड़ी की वजह बताई जाती है.

अगर "pubsub.googleapis.com" एपीआई चालू नहीं है, तो उससे संपर्क करने पर गड़बड़ी का उदाहरण:

{ "reason": "API_DISABLED"
  "domain": "googleapis.com"
  "metadata": {
    "resource": "projects/123",
    "service": "pubsub.googleapis.com"
  }
}

इस रिस्पॉन्स से पता चलता है कि pubsub.googleapis.com एपीआई चालू नहीं है.

किसी ऐसे इलाके में स्पैनर इंस्टेंस बनाने की कोशिश करने पर, गड़बड़ी का उदाहरण जहां यह स्टॉक में नहीं है:

{ "reason": "STOCKOUT"
  "domain": "spanner.googleapis.com",
  "metadata": {
    "availableRegions": "us-central1,us-east2"
  }
}
JSON काेड में दिखाना
{
  "reason": string,
  "domain": string,
  "metadata": {
    string: string,
    ...
  }
}
फ़ील्ड
reason

string

गड़बड़ी की वजह. यह एक कॉन्स्टैंट वैल्यू है, जिससे गड़बड़ी की असली वजह का पता चलता है. गड़बड़ी की वजहें, गड़बड़ियों के किसी खास डोमेन में यूनीक होती हैं. यह ज़्यादा से ज़्यादा 63 वर्णों की होनी चाहिए और [A-Z][A-Z0-9_]+[A-Z0-9] के रेगुलर एक्सप्रेशन से मेल खानी चाहिए. यह UPPER_SNAKE_CASE को दिखाता है.

domain

string

लॉजिकल ग्रुपिंग, जिससे "वजह" जुड़ी है. गड़बड़ी का डोमेन आम तौर पर, उस टूल या प्रॉडक्ट का रजिस्टर किया गया सेवा का नाम होता है जिससे गड़बड़ी होती है. उदाहरण के लिए: "pubsub.googleapis.com". अगर गड़बड़ी किसी सामान्य इन्फ़्रास्ट्रक्चर की वजह से होती है, तो गड़बड़ी का डोमेन एक ऐसी वैल्यू होनी चाहिए जो दुनिया भर में यूनीक हो और जिससे इन्फ़्रास्ट्रक्चर की पहचान हो. Google के एपीआई इन्फ़्रास्ट्रक्चर के लिए, गड़बड़ी का डोमेन "googleapis.com" होता है.

metadata

map (key: string, value: string)

इस गड़बड़ी के बारे में, स्ट्रक्चर्ड फ़ॉर्मैट में ज़्यादा जानकारी.

कुंजियां, [a-z][a-zA-Z0-9-_]+ के रेगुलर एक्सप्रेशन से मेल खानी चाहिए. हालांकि, इन्हें lowerCamelCase में होना चाहिए. साथ ही, इनकी लंबाई 64 वर्णों से ज़्यादा नहीं होनी चाहिए. जब किसी तय सीमा से ज़्यादा वैल्यू की पहचान की जाती है, तो यूनिट को वैल्यू में नहीं, बल्कि कुंजी में शामिल किया जाना चाहिए. उदाहरण के लिए, अगर क्लाइंट, एक (बैच) अनुरोध में बनाए जा सकने वाले इंस्टेंस की संख्या से ज़्यादा इंस्टेंस बनाता है, तो {"instanceLimit": "100/request"} के बजाय, {"instanceLimitPerRequest": "100"} दिखाया जाना चाहिए.

एक ऐसा ऑब्जेक्ट जिसमें "key": value पेयर की सूची शामिल हो. उदाहरण के लिए: { "name": "wrench", "mass": "1.3kg", "count": "3" }.