प्रमाणीकरण

Markdown के रूप में देखें

CLI का भेजा हर अनुरोध आपके प्रोजेक्ट की एक API कुंजी साथ ले जाता है। कुंजियाँ status200 login से एक बार सहेजें, हर एनवायरनमेंट के लिए एक कॉन्टेक्स्ट, या उन्हें फ़्लैग या एनवायरनमेंट वेरिएबल में किसी कमांड को दें, जैसा स्क्रिप्ट करती हैं। यह पेज हर तरीका दिखाता है, और यह भी कि कई तरीके होने पर कोई कमांड कौन-सा उपयोग करती है।

लॉग इन करेंएक API कुंजी और अपने Status200 का पता सहेजें।कॉन्टेक्स्टहर प्रोजेक्ट या एनवायरनमेंट के लिए सहेजा गया लॉगिन, और उनके बीच बदलना।कोई कमांड कौन-से क्रेडेंशियल उपयोग करती हैपहले फ़्लैग, फिर एनवायरनमेंट वेरिएबल, फिर कॉन्टेक्स्ट।समस्या निवारणक्रेडेंशियल नहीं मिले, अमान्य कुंजियाँ और अस्वीकृतियाँ।

शुरू करने से पहले

आपको अपने प्रोजेक्ट की एक API कुंजी चाहिए। इसे प्रोजेक्ट सेटिंग्स → उन्नत → API कुंजियाँ में API कुंजी बनाएँ से बनाएँ, और इसे वह एक्सेस दें जिसकी आपकी कमांड को ज़रूरत है: एक API कुंजी बनाएँ देखें। कुंजी वही करती है जिसकी उसकी अनुमतियाँ इजाज़त देती हैं, इसलिए जो कुंजी केवल रिकॉर्ड पढ़ सकती है, वह उन्हें सूचीबद्ध कर सकती है और पढ़ सकती है, पर बदल नहीं सकती।

Status200 Cloud पर, API कुंजियाँ तभी तक काम करती हैं जब तक प्रोजेक्ट Growth प्लान या उससे ऊपर है। उससे नीचे, हर कमांड प्लान का नाम बताने वाले संदेश के साथ API error (402) जवाब देती है, जब तक प्रोजेक्ट अपग्रेड न हो; उसके बाद वही कुंजी फिर काम करती है। अपने प्लान से नीचे API कुंजियाँ और SCIM देखें।

लॉग इन करें

status200 login एक API कुंजी और आपके Status200 का पता कॉन्टेक्स्ट के रूप में सहेजता है, और उसे मौजूदा कॉन्टेक्स्ट बनाता है:

Bash

status200 login <api-key> <instance-url> [--context-name <name>]

आर्ग्युमेंट या विकल्प	यह क्या है
`<api-key>`	आपके प्रोजेक्ट की एक API कुंजी
`<instance-url>`	आपके Status200 का पता: `https://status200.ru`, या आपके अपने सर्वर का, जैसे `https://status200.example.com`
`--context-name <name>`	वह नाम जिससे कॉन्टेक्स्ट सहेजा जाता है। डिफ़ॉल्ट: `default`

उदाहरण के लिए, production नाम का एक कॉन्टेक्स्ट:

Bash

status200 login <api-key> https://status200.ru --context-name production

यह Logged in successfully. Context "production" is now active. जवाब देता है। पते के अंत का स्लैश हटा दिया जाता है, और उसी नाम से फिर लॉग इन करने पर वह कॉन्टेक्स्ट बदल जाता है।

नोट

login कुंजी को Status200 से पूछे बिना सहेजता है। कुंजी काम करती है यह देखने के लिए कोई कमांड चलाएँ, जैसे status200 incident count।

कॉन्टेक्स्ट

कॉन्टेक्स्ट एक सहेजा गया लॉगिन है: एक नाम, एक पता और एक API कुंजी। हर प्रोजेक्ट या एनवायरनमेंट के लिए एक सहेजें, फिर आगे की सभी कमांड के लिए, या किसी एक कमांड के लिए, एक चुनें।

हर एनवायरनमेंट के लिए एक कॉन्टेक्स्ट सहेजें
Bash
```
status200 login <production-api-key> https://status200.ru --context-name production
status200 login <staging-api-key> https://status200.example.com --context-name staging
```
हर लॉगिन अपने कॉन्टेक्स्ट को मौजूदा कॉन्टेक्स्ट बनाता है, इसलिए अब staging मौजूदा है।

उन्हें सूचीबद्ध करें

Bash

status200 context list

┌───┬────────────┬───────────────────────────────┐
│   │ Name       │ URL                           │
├───┼────────────┼───────────────────────────────┤
│   │ production │ https://status200.ru          │
├───┼────────────┼───────────────────────────────┤
│ * │ staging    │ https://status200.example.com │
└───┴────────────┴───────────────────────────────┘

* मौजूदा कॉन्टेक्स्ट को चिह्नित करता है। API कुंजियाँ कभी सूचीबद्ध नहीं होतीं।

दूसरे कॉन्टेक्स्ट पर जाएँ
Bash
```
status200 context use production
```
यह Switched to context "production". जवाब देता है और आगे की कमांड उसी का उपयोग करती हैं।
एक कमांड के लिए कॉन्टेक्स्ट उपयोग करें
Bash
```
status200 incident list --context staging
```
मौजूदा कॉन्टेक्स्ट जैसा था वैसा ही रहता है।

कमांड	यह क्या करती है
`status200 context list`	सहेजे कॉन्टेक्स्ट सूचीबद्ध करती है; `*` मौजूदा को चिह्नित करता है। `-o json` के साथ, हर कॉन्टेक्स्ट का `name`, `apiUrl` और `isCurrent`, उसकी कुंजी कभी नहीं
`status200 context use <name>`	किसी सहेजे कॉन्टेक्स्ट को मौजूदा बनाती है
`status200 context current`	मौजूदा कॉन्टेक्स्ट का नाम, URL और API कुंजी दिखाती है, कुंजी के पहले चार और आखिरी चार अक्षरों को छोड़कर सब छिपा होता है
`status200 context delete <name>`	सहेजा कॉन्टेक्स्ट हटाती है। अगर वह मौजूदा था, तो बचा हुआ पहला कॉन्टेक्स्ट मौजूदा बन जाता है

कोई कमांड कौन-से क्रेडेंशियल उपयोग करती है

कमांड को एक API कुंजी और एक URL चाहिए। वह दोनों में से हर एक को इन जगहों में से पहली ऐसी जगह से लेती है जहाँ वह मौजूद हो:

flowchart TB F["1. कमांड पर फ़्लैग: --api-key और --url"] --> E["2. एनवायरनमेंट वेरिएबल: STATUS200_API_KEY और STATUS200_URL"] E --> N["3. --context से चुना गया कॉन्टेक्स्ट"] N --> C["4. मौजूदा कॉन्टेक्स्ट"] C --> X["कहीं नहीं मिला: कमांड रुक जाती है"]

कमांड अपनी API कुंजी और URL कहाँ ढूँढती है

इसलिए आप इन्हें मिला सकते हैं: उदाहरण के लिए, एनवायरनमेंट वेरिएबल से API कुंजी और मौजूदा कॉन्टेक्स्ट का URL। एनवायरनमेंट वेरिएबल उन स्क्रिप्ट और CI जॉब के लिए ठीक हैं जिनके पास कोई सहेजा कॉन्टेक्स्ट नहीं होता:

Linux

Bash

export STATUS200_API_KEY=<api-key>
export STATUS200_URL=https://status200.ru
status200 incident list

macOS

Bash

export STATUS200_API_KEY=<api-key>
export STATUS200_URL=https://status200.ru
status200 incident list

Windows

PowerShell

$env:STATUS200_API_KEY = "<api-key>"
$env:STATUS200_URL = "https://status200.ru"
status200 incident list

एक कमांड के लिए, फ़्लैग बाकी सब से पहले आते हैं:

Bash

status200 --api-key <api-key> --url https://status200.ru incident list

चेतावनी

फ़्लैग के रूप में दी गई कुंजी आपकी shell हिस्ट्री में पहुँच जाती है, और मशीन के दूसरे उपयोगकर्ता उसे प्रोसेस सूची में देख सकते हैं। साझा मशीन पर, इसकी जगह कॉन्टेक्स्ट या एनवायरनमेंट वेरिएबल उपयोग करें।

देखें कि CLI क्या उपयोग करेगा

status200 whoami वह URL और API कुंजी दिखाता है जिनका अगली कमांड उपयोग करेगी, और वह कॉन्टेक्स्ट जिससे वे आती हैं:

Bash

status200 whoami

URL:     https://status200.ru
API Key: 4f1c****0a13
Context: production

कुंजी के केवल पहले चार और आखिरी चार अक्षर दिखाए जाते हैं। Context पंक्ति तभी दिखती है जब URL और कुंजी उसी कॉन्टेक्स्ट के अपने हों, न कि ऐसे मान जिन्हें किसी फ़्लैग या एनवायरनमेंट वेरिएबल ने बदल दिया हो। whoami Status200 को कॉल किए बिना आपकी सेटिंग्स पढ़ता है: यह दिखाता है कि कमांड क्या भेजेगी, यह नहीं कि Status200 उसे स्वीकार करता है या नहीं। कुछ भी सहेजा या सेट न होने पर, यह जवाब देता है:

Not authenticated. Run `status200 login` to authenticate.

कॉन्फ़िगरेशन फ़ाइल

status200 login कॉन्टेक्स्ट को आपके होम फ़ोल्डर में ~/.oneuptime/config.json में सहेजता है (Windows पर %USERPROFILE%\.oneuptime\config.json)। CLI इसे ऐसे बनाता है कि केवल आपका उपयोगकर्ता इसे पढ़ और लिख सके (मोड 0600):

~/.oneuptime/config.jsonJSON

{
  "currentContext": "production",
  "contexts": {
    "production": {
      "name": "production",
      "apiUrl": "https://status200.ru",
      "apiKey": "<api-key>"
    },
    "staging": {
      "name": "staging",
      "apiUrl": "https://status200.example.com",
      "apiKey": "<api-key>"
    }
  }
}

फ़ाइल API कुंजियों को ज्यों का त्यों रखती है: इसे साझा फ़ोल्डरों, बैकअप और रिपॉज़िटरी से दूर रखें। किसी एक कॉन्टेक्स्ट से लॉग आउट करने के लिए, उसे status200 context delete <name> से हटाएँ; सभी से लॉग आउट करने के लिए, फ़ाइल हटाएँ। जो कुंजी लीक हो गई हो सकती है, वह तब तक मान्य रहती है जब तक आप उसे Status200 में, प्रोजेक्ट सेटिंग्स → उन्नत → API कुंजियाँ में, हटा नहीं देते।

आउटपुट प्रारूप और सूची का आकार यहाँ सहेजे नहीं जाते: हर कमांड को -o और --limit दें।

समस्या निवारण

"No credentials found" संदेश

Authentication error: No credentials found. का मतलब है कि किसी फ़्लैग, एनवायरनमेंट वेरिएबल या सहेजे कॉन्टेक्स्ट ने कमांड को उसकी API कुंजी और URL नहीं दिए। status200 login चलाएँ, या STATUS200_API_KEY और STATUS200_URL दोनों सेट करें। कमांड कोड 2 के साथ बाहर निकलती है।

"API error (400): Invalid API Key" संदेश

कुंजी Status200 की API कुंजी नहीं है, उसकी अवधि समाप्त हो गई है, या उसे रीसेट किया गया था। उसे प्रोजेक्ट सेटिंग्स → उन्नत → API कुंजियाँ में उसके पेज से फिर कॉपी करें, जहाँ उसकी समाप्त होता है वाली तारीख भी है, और उसी कॉन्टेक्स्ट नाम से फिर लॉग इन करें। कमांड कोड 2 के साथ बाहर निकलती है।

"API error (402): API keys need the Growth plan" संदेश

Status200 Cloud पर, प्रोजेक्ट Growth प्लान से नीचे है, इसलिए उसकी API कुंजियों ने काम करना बंद कर दिया। प्रोजेक्ट अपग्रेड करें, और वही कुंजी फिर काम करती है: CLI में कुछ बदलने की ज़रूरत नहीं।

"API error (422): You do not have permissions" संदेश

कुंजी की अनुमतियाँ वहाँ तक नहीं पहुँचतीं जो कमांड माँगती है। प्रोजेक्ट सेटिंग्स → उन्नत → API कुंजियाँ में कुंजी के पेज पर उसे कोई भूमिका या अनुमति दें: संदेश उन अनुमतियों के नाम बताता है जिनसे अनुरोध आगे जा सकेगा।

"Context "staging" does not exist" संदेश

उस नाम का कोई कॉन्टेक्स्ट सहेजा नहीं गया है। status200 context list मौजूद नाम दिखाता है।

whoami कॉन्टेक्स्ट से अलग URL या कुंजी दिखाता है

कोई एनवायरनमेंट वेरिएबल या फ़्लैग कॉन्टेक्स्ट के मान को बदल देता है। env | grep ONEUPTIME सेट किए गए वेरिएबल दिखाता है, और unset STATUS200_API_KEY STATUS200_URL आपको आपके कॉन्टेक्स्ट पर वापस ले जाता है।

पते पर अनुरोध विफल हुआ

Error: Request failed to https://... का मतलब है कि CLI उस पते पर Status200 तक नहीं पहुँच सका। status200 whoami से URL जाँचें: यह वही पता है जिस पर आप Status200 खोलते हैं, https:// के साथ, जैसे https://status200.ru।

अगले कदम

संसाधन संचालनरिकॉर्ड सूचीबद्ध करें, पढ़ें, बनाएँ, बदलें, हटाएँ और गिनें।स्क्रिप्टिंग और CI/CDपाइपलाइन को उसकी कुंजी एनवायरनमेंट वेरिएबल में दें।Status200 API संदर्भAPI कुंजी क्या कर सकती है, और हर जवाब का क्या मतलब है।

शुरू करने से पहले#

लॉग इन करें#

कॉन्टेक्स्ट#

हर एनवायरनमेंट के लिए एक कॉन्टेक्स्ट सहेजें#

उन्हें सूचीबद्ध करें#

दूसरे कॉन्टेक्स्ट पर जाएँ#

एक कमांड के लिए कॉन्टेक्स्ट उपयोग करें#

कोई कमांड कौन-से क्रेडेंशियल उपयोग करती है#

देखें कि CLI क्या उपयोग करेगा#

कॉन्फ़िगरेशन फ़ाइल#

समस्या निवारण#

अगले कदम#

शुरू करने से पहले

लॉग इन करें

कॉन्टेक्स्ट

हर एनवायरनमेंट के लिए एक कॉन्टेक्स्ट सहेजें

उन्हें सूचीबद्ध करें

दूसरे कॉन्टेक्स्ट पर जाएँ

एक कमांड के लिए कॉन्टेक्स्ट उपयोग करें

कोई कमांड कौन-से क्रेडेंशियल उपयोग करती है

देखें कि CLI क्या उपयोग करेगा

कॉन्फ़िगरेशन फ़ाइल

समस्या निवारण

अगले कदम