रेफ़रंस

आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इस पेज पर जाएं Apigee X दस्तावेज़.
जानकारी

apigee-remote-service-cli कमांड लाइन इंटरफ़ेस (सीएलआई) आपकी मदद करता है Envoy के लिए Apigee अडैप्टर का प्रावधान और उसे मैनेज करना.

लिस्ट बाइंडिंग कमांड

रिमोट सर्विस से जुड़े सभी एपीआई प्रॉडक्ट की सूची बनाएं.

इस्तेमाल

apigee-remote-service-cli bindings list [flags]

पैरामीटर

पैरामीटर मौजूदगी प्रॉडक्ट के साथ इस्तेमाल किया गया ब्यौरा
-c,
‑‑config
ज़रूरी है सभी (स्ट्रिंग) Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है सलाह: इस फ़्लैग की मदद से आप ज़्यादातर दूसरे कमांड पैरामीटर को छोड़ सकते हैं, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. देखें ‑‑config विकल्प का इस्तेमाल करके.
-e,
‑‑environment
ज़रूरी है सभी (स्ट्रिंग) आपके संगठन का एक एनवायरमेंट.
-h,
‑‑help
वैकल्पिक सभी कमांड पैरामीटर के लिए सहायता दिखाता है.
‑‑insecure वैकल्पिक सभी एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन को अनुमति दें.
‑‑legacy ज़रूरी है सिर्फ़ Edge पब्लिक क्लाउड अगर सार्वजनिक क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा. मैनेजमेंट और रनटाइम यूआरएल सेट करता है Public Cloud के लिए Apigee Edge.
-m,
‑‑management
ज़रूरी है सिर्फ़ Edge प्राइवेट क्लाउड (स्ट्रिंग) प्राइवेट क्लाउड इंस्टॉलेशन के लिए, आपके Apigee Edge के लिए मैनेजमेंट बेस यूआरएल. डिफ़ॉल्ट: https://api.enterprise.apigee.com
‑‑mfa ज़रूरी है सिर्फ़ Edge पब्लिक क्लाउड (स्ट्रिंग) सार्वजनिक क्लाउड के लिए आपके Apigee Edge के लिए, कई तरीकों से पुष्टि करने वाला टोकन. सिर्फ़ MFA ज़रूरी होने पर आपके Apigee Edge खाते पर सेट अप की गई हो.
‑‑opdk ज़रूरी है सिर्फ़ Edge प्राइवेट क्लाउड अगर प्राइवेट क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा.
-o,
‑‑organization
ज़रूरी है सभी (स्ट्रिंग) Apigee संगठन. आपको संगठन का एडमिन होना ज़रूरी है.
-p,
‑‑password
ज़रूरी
(सिर्फ़ बुनियादी पुष्टि)
सिर्फ़ Edge पब्लिक और प्राइवेट क्लाउड (स्ट्रिंग) आपका Apigee पासवर्ड. वैकल्पिक रूप से, यह बताया जा सकता है .netrc फ़ाइल में पासवर्ड. इन्हें भी देखें क्रेडेंशियल के लिए .netrc का इस्तेमाल करना.
-r,
‑‑runtime
ज़रूरी है Edge प्राइवेट क्लाउड और सिर्फ़ Apigee हाइब्रिड (स्ट्रिंग) आपके प्राइवेट क्लाउड या Apigee हाइब्रिड इंस्टेंस के लिए, रनटाइम यूआरएल के बारे में जानकारी देती है. यूआरएल https:// से शुरू होना चाहिए. उदाहरण के लिए: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
वैकल्पिक सिर्फ़ Edge प्राइवेट क्लाउड (स्ट्रिंग) mTLS कनेक्शन के लिए, क्लाइंट-साइड TLS सर्टिफ़िकेट, निजी पासकोड, और रूट CA की जानकारी देता है.
-t,
‑‑token
ज़रूरी है
(सिर्फ़ OAuth टोकन की पुष्टि करने के लिए)
सभी (स्ट्रिंग) OAuth या एसएएमएल टोकन, जिसे आपने जनरेट किया है आपके Apigee खाते की जानकारी से. दिए गए किसी भी अन्य क्रेडेंशियल को बदल देता है.
-u,
‑‑username
ज़रूरी
(सिर्फ़ बुनियादी पुष्टि)
सिर्फ़ Edge पब्लिक और प्राइवेट क्लाउड (स्ट्रिंग) आपका Apigee उपयोगकर्ता नाम (आम तौर पर, एक ईमेल पता). आपके पास .netrc फ़ाइल में उपयोगकर्ता नाम डालने का विकल्प भी होता है. अगर ऐसा किया जाता है, तो आपको कमांड लाइन पर अपना उपयोगकर्ता नाम देने की ज़रूरत नहीं है. यहां जाएं: साथ ही, क्रेडेंशियल के लिए .netrc का इस्तेमाल करना भी.
-v,
‑‑verbose
वैकल्पिक सभी (ज़रूरी नहीं) ज़्यादा शब्दों में जवाब दिया जाता है.

उदाहरण

apigee-remote-service-cli bindings list -o myorg -e test -u user@example.com \
-c config.yaml -p abc123

आउटपुट का उदाहरण

PI Products
============
Bound
-----
envoy-test:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
httpbin:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
    /httpbin
    /

Unbound
-------
product-1:
  Quota: 100 requests every 1 hour
product-2:
  Quota: 1000 requests every 1 month
product-3:
product-4:

सहायता आदेश

apigee-remote-service-cli के सभी निर्देशों के लिए, ऑनलाइन मदद दी जाती है. बस टाइप करें:

apigee-remote-service-cli help

किसी भी निर्देश पर मदद पाने के लिए, यह टाइप करें:

apigee-remote-service-cli [command] help

उदाहरण के लिए:

apigee-remote-service-cli provision help

प्रॉविज़निंग का निर्देश

apigee-remote-service-cli provision निर्देश आपके Apigee में दो एपीआई प्रॉक्सी इंस्टॉल करता है Edge मैनेज करने के लिए, सर्टिफ़िकेट सेट अप किया जाता है, और ज़रूरी क्रेडेंशियल जनरेट किए जाते हैं Envoy के लिए Apigee अडैप्टर कॉन्फ़िगर करें.

इस्तेमाल

apigee-remote-service-cli provision [flags]

पैरामीटर

पैरामीटर मौजूदगी प्रॉडक्ट के साथ इस्तेमाल किया गया ब्यौरा
‑‑analytics-sa वैकल्पिक सिर्फ़ Apigee हाइब्रिड और Apigee X

(स्ट्रिंग) Google Cloud सेवा खाते की कुंजी फ़ाइल का पाथ बताने के लिए इस फ़्लैग का इस्तेमाल करें, जहां सेवा खाते को Apigee Analytics Agent की भूमिका मिली है. SA का इस्तेमाल किया जाता है अडैप्टर की मदद से, आंकड़ों का डेटा सीधे Apigee पर अपलोड किया जा सकता है. अगर Apigee हाइब्रिड का इस्तेमाल किया जा रहा है, तो इस विकल्प की मदद से, एक क्लस्टर में हाइब्रिड रनटाइम और अडैप्टर को इंस्टॉल किया जा सकता है अन्य क्लस्टर में.

-c,
‑‑config
ज़रूरी है सभी (स्ट्रिंग) Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है सलाह: इस फ़्लैग की मदद से आप ज़्यादातर दूसरे कमांड पैरामीटर को छोड़ सकते हैं, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. देखें ‑‑config विकल्प का इस्तेमाल करके.
-e,
‑‑environment
ज़रूरी है सभी (स्ट्रिंग) आपके संगठन का एक एनवायरमेंट.
-f, ‑‑force-proxy-install वैकल्पिक सभी (ज़रूरी नहीं) अगर ऐसा है, तो remote-service प्रॉक्सी को हर हाल में फिर से इंस्टॉल किया जाता है आपके संगठन में पहले से इंस्टॉल है.
-h,
‑‑help
वैकल्पिक सभी कमांड पैरामीटर के लिए सहायता दिखाता है.
‑‑insecure वैकल्पिक सभी एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन को अनुमति दें.
‑‑legacy ज़रूरी है सिर्फ़ Edge पब्लिक क्लाउड अगर सार्वजनिक क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा. मैनेजमेंट और रनटाइम यूआरएल सेट करता है Public Cloud के लिए Apigee Edge.
-m,
‑‑management
ज़रूरी है सिर्फ़ Edge प्राइवेट क्लाउड (स्ट्रिंग) प्राइवेट क्लाउड इंस्टॉलेशन के लिए, आपके Apigee Edge के लिए मैनेजमेंट बेस यूआरएल. डिफ़ॉल्ट: https://api.enterprise.apigee.com
‑‑mfa ज़रूरी है सिर्फ़ Edge पब्लिक क्लाउड सार्वजनिक क्लाउड के लिए आपके Apigee Edge के लिए, कई तरीकों से पुष्टि करने वाला टोकन. सिर्फ़ MFA ज़रूरी होने पर आपके Apigee Edge खाते पर सेट अप की गई हो.
-n, ‑‑namespace वैकल्पिक सभी (स्ट्रिंग) दिए गए नेमस्पेस में, Envoy ConfigMap के तौर पर कॉन्फ़िगरेशन को कॉन्फ़िगर करें. डिफ़ॉल्ट: apigee
‑‑opdk ज़रूरी है सिर्फ़ Edge प्राइवेट क्लाउड अगर प्राइवेट क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा.
-o,
‑‑organization
ज़रूरी है सभी (स्ट्रिंग) Apigee संगठन. प्रावधान करने के लिए, आपको संगठन का एडमिन होना ज़रूरी है.
-p,
‑‑password
ज़रूरी
(सिर्फ़ बुनियादी पुष्टि)
सिर्फ़ Edge पब्लिक और प्राइवेट क्लाउड (स्ट्रिंग) आपका Apigee पासवर्ड. वैकल्पिक रूप से, यह बताया जा सकता है
.netrc फ़ाइल में दिया गया पासवर्ड. अगर ऐसा किया जाता है, तो आपको कमांड लाइन पर अपना पासवर्ड डालें. इन्हें भी देखें क्रेडेंशियल के लिए .netrc का इस्तेमाल करना.
‑‑rotate-int वैकल्पिक सिर्फ़ Apigee हाइब्रिड (पूरी संख्या) अगर n > 0, नई निजी कुंजी जनरेट करें और n सार्वजनिक कुंजियां रखें (सिर्फ़ हाइब्रिड)
-r,
‑‑runtime
ज़रूरी है Edge प्राइवेट क्लाउड और सिर्फ़ Apigee हाइब्रिड (स्ट्रिंग) आपके प्राइवेट क्लाउड या Apigee हाइब्रिड इंस्टेंस के लिए, रनटाइम यूआरएल के बारे में जानकारी देती है. यूआरएल https:// से शुरू होना चाहिए. उदाहरण के लिए: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
वैकल्पिक सिर्फ़ Edge प्राइवेट क्लाउड (स्ट्रिंग) mTLS कनेक्शन के लिए, क्लाइंट-साइड TLS सर्टिफ़िकेट, निजी पासकोड, और रूट CA की जानकारी देता है.
-t,
‑‑token
ज़रूरी है
(सिर्फ़ OAuth टोकन की पुष्टि करने के लिए)
सभी (स्ट्रिंग) OAuth या एसएएमएल टोकन, जिसे आपने जनरेट किया है आपके Apigee खाते की जानकारी से. दिए गए किसी भी अन्य क्रेडेंशियल को बदल देता है.
-u,
‑‑username
ज़रूरी
(सिर्फ़ बुनियादी पुष्टि)
सिर्फ़ Edge पब्लिक और प्राइवेट क्लाउड (स्ट्रिंग) आपका Apigee उपयोगकर्ता नाम (आम तौर पर, एक ईमेल पता). आपके पास .netrc फ़ाइल में उपयोगकर्ता नाम डालने का विकल्प भी होता है. यहां जाएं: साथ ही, क्रेडेंशियल के लिए .netrc का इस्तेमाल करना भी.
-v,
‑‑verbose
वैकल्पिक सभी (ज़रूरी नहीं) ज़्यादा शब्दों में जवाब दिया जाता है.
‑‑virtual-hosts वैकल्पिक सिर्फ़ Edge प्राइवेट क्लाउड (स्ट्रिंग) डिफ़ॉल्ट वर्चुअल होस्ट को बदल देती है, जो कि default,secure होते हैं. इस विकल्प का इस्तेमाल तब करें, जब आपके एज संगठन के एनवायरमेंट के लिए, डिफ़ॉल्ट के अलावा वर्चुअल होस्ट तय किए गए हों.

उदाहरण

जैसा कि नीचे दिए गए उदाहरण में बताया गया है, किसी फ़ाइल में provision कमांड के आउटपुट को कैप्चर करना ज़रूरी है. इसी फ़ाइल का इस्तेमाल किया जाता है Envoy ऑपरेशन के लिए अन्य Apigee अडैप्टर के इनपुट के तौर पर.

उदाहरण:

apigee-remote-service-cli provision --legacy --mfa $MFA --username $USER --password $PASSWORD \
--organization $ORG --environment $ENV > config.yaml

सैंपल कमांड

सैंपल कॉन्फ़िगरेशन फ़ाइलें बनाता और उनकी सूची बनाता है.

कॉन्फ़िगरेशन फ़ाइलों का सैंपल बनाएं

नेटिव Envoy और Istio डिप्लॉयमेंट के लिए सैंपल कॉन्फ़िगरेशन फ़ाइलें बनाता है.

इस्तेमाल

apigee-remote-service-cli samples create [flags]

ब्यौरा

इस निर्देश के लिए, इनपुट के तौर पर एक मान्य config.yaml फ़ाइल होनी चाहिए. यह इनपुट फ़ाइल वह फ़ाइल है जिसे प्रॉविज़निंग से जनरेट होता है. डिफ़ॉल्ट रूप से, सैंपल फ़ाइलें ./samples नाम की डायरेक्ट्री में आउटपुट होती हैं. निर्देश आपके लिए यह डायरेक्ट्री बनाएगा.

अगर नेटिव Envoy का इस्तेमाल किया जा रहा है, तो कमांड, टारगेट सर्विस होस्ट और उसका क्लस्टर. यह Envoy प्रॉक्सी से रिमोट सेवा पर कस्टम एसएसएल कनेक्शन भी सेट करता है अगर tls.key और tls.crt वाला फ़ोल्डर --tls के ज़रिए दिया गया है, तो क्लस्टर.

अगर आप Istio का इस्तेमाल कर रहे हैं, जहां Envoy प्रॉक्सी साइडकार की तरह काम करता है. अगर टारगेट की जानकारी नहीं दी गई है, httpbin उदाहरण जनरेट होगा. वरना, विज्ञापनों को प्रोसेस करने की तैयारी आपकी टारगेट सेवाओं के डिप्लॉयमेंट से जुड़ी कॉन्फ़िगरेशन फ़ाइलें.

पैरामीटर

पैरामीटर मौजूदगी प्रॉडक्ट के साथ इस्तेमाल किया गया ब्यौरा
‑‑adapter‑host केवल Envoy टेम्प्लेट के लिए आवश्यक है सभी (स्ट्रिंग) अडैप्टर होस्टनेम (डिफ़ॉल्ट: localhost)
-c, ‑‑config ज़रूरी है सभी (स्ट्रिंग) Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है सलाह: इस फ़्लैग की मदद से आप ज़्यादातर दूसरे कमांड पैरामीटर को छोड़ सकते हैं, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. देखें ‑‑config विकल्प का इस्तेमाल करके.
-f, ‑‑force वैकल्पिक सभी मौजूदा डायरेक्ट्री को हर हाल में ओवरराइट करें.
-h, ‑‑help वैकल्पिक सभी कमांड पैरामीटर के लिए सहायता दिखाता है.
‑‑host केवल Envoy टेम्प्लेट के लिए आवश्यक है सभी (स्ट्रिंग) टारगेट सेवा होस्ट (डिफ़ॉल्ट httpbin.org)
-n, ‑‑name ज़रूरी है सभी (स्ट्रिंग) टारगेट सेवा का नाम (डिफ़ॉल्ट httpbin.org)
‑‑out वैकल्पिक सभी (स्ट्रिंग) वह डायरेक्ट्री जिसमें सैंपल कॉन्फ़िगरेशन फ़ाइलें बनानी हैं.
डिफ़ॉल्ट: ./samples
‑‑tag सिर्फ़ Istio टेंप्लेट के लिए ज़रूरी है सभी (स्ट्रिंग) Envoy अडैप्टर इमेज का वर्शन टैग. डिफ़ॉल्ट: v2.0.0
-t, ‑‑template ज़रूरी है सभी (स्ट्रिंग) Envoy या Istio टेंप्लेट का नाम. टेंप्लेट की उपलब्ध सूची देखने के लिए, निर्देश दें apigee-remote-service samples templates.
‑‑tls वैकल्पिक, सिर्फ़ एंवॉयी टेंप्लेट के लिए सभी (स्ट्रिंग) tls.key और tls.crt फ़ाइलों वाली डायरेक्ट्री का इस्तेमाल अडैप्टर सेवा के लिए किया जाता है.

उदाहरण

apigee-remote-service-cli samples create -c ./config.yaml

उपलब्ध टेंप्लेट के विकल्पों की सूची बनाएं

samples के लिए, --templates पैरामीटर के साथ इस्तेमाल के लिए उपलब्ध टेंप्लेट की सूची बनाता है आदेश.

इस्तेमाल

apigee-remote-service-cli samples templates

पैरामीटर

कोई नहीं.

उदाहरण

apigee-remote-service-cli samples templates
Supported templates (native is deprecated):
  envoy-1.15
  envoy-1.16
  envoy-1.17
  istio-1.7
  istio-1.8
  istio-1.9

टोकन कमांड

किसी एपीआई पासकोड के बजाय, पुष्टि किए गए एपीआई प्रॉक्सी कॉल करने के लिए, JWT टोकन का इस्तेमाल किया जा सकता है. टोकन कमांड की मदद से, इस काम के लिए JWT टोकन बनाए जा सकते हैं, उनकी जांच की जा सकती है, और उन्हें घुमाया जा सकता है.

कोई JWT टोकन बनाएं

किसी रिमोट सर्विस टारगेट पर पुष्टि किए गए एपीआई प्रॉक्सी कॉल करने के लिए, JWT टोकन का इस्तेमाल किया जा सकता है. यहां जाएं: साथ ही, JWT पर आधारित पुष्टि करने की सुविधा का इस्तेमाल करके.

इस्तेमाल

apigee-remote-service-cli token create [flags]

पैरामीटर

पैरामीटर मौजूदगी प्रॉडक्ट के साथ इस्तेमाल किया गया ब्यौरा
-c,
‑‑config
ज़रूरी है सभी (स्ट्रिंग) Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है सलाह: इस फ़्लैग की मदद से आप ज़्यादातर दूसरे कमांड पैरामीटर को छोड़ सकते हैं, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. देखें ‑‑config विकल्प का इस्तेमाल करके.
-e,
‑‑environment
ज़रूरी है सभी (स्ट्रिंग) आपके संगठन का एक एनवायरमेंट.
-h,
‑‑help
वैकल्पिक सभी कमांड पैरामीटर के लिए सहायता दिखाता है.
--i, --id ज़रूरी है सभी (स्ट्रिंग) Apigee डेवलपर ऐप्लिकेशन में मौजूद कुंजी क्रेडेंशियल, जैसा कि यहां बताया गया है एपीआई पासकोड पाने का तरीका.
‑‑insecure वैकल्पिक सभी एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन को अनुमति दें.
‑‑legacy ज़रूरी है सिर्फ़ Edge पब्लिक क्लाउड अगर सार्वजनिक क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा. मैनेजमेंट और रनटाइम यूआरएल सेट करता है Public Cloud के लिए Apigee Edge.
‑‑opdk ज़रूरी है सिर्फ़ Edge प्राइवेट क्लाउड अगर प्राइवेट क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा.
-o,
‑‑organization
ज़रूरी है सभी (स्ट्रिंग) Apigee संगठन. आपको संगठन का एडमिन होना ज़रूरी है.
-r,
‑‑runtime
ज़रूरी है Edge प्राइवेट क्लाउड और सिर्फ़ Apigee हाइब्रिड (स्ट्रिंग) आपके प्राइवेट क्लाउड या Apigee हाइब्रिड इंस्टेंस के लिए, रनटाइम यूआरएल के बारे में जानकारी देती है. यूआरएल https:// से शुरू होना चाहिए. उदाहरण के लिए: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret ज़रूरी है सभी (स्ट्रिंग) Apigee डेवलपर ऐप्लिकेशन में मौजूद सीक्रेट क्रेडेंशियल, जैसा कि यहां बताया गया है एपीआई पासकोड पाने का तरीका.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
वैकल्पिक सिर्फ़ Edge प्राइवेट क्लाउड (स्ट्रिंग) mTLS कनेक्शन के लिए, क्लाइंट-साइड TLS सर्टिफ़िकेट, निजी पासकोड, और रूट CA की जानकारी देता है.
-v,
‑‑verbose
वैकल्पिक सभी (ज़रूरी नहीं) ज़्यादा शब्दों में जवाब दिया जाता है.

उदाहरण

apigee-remote-service-cli token create -o myorg -e test -i YUmlZAcBKNsTAelJqPZFl3sh58ObATX9 \
-s icTARgaKHqvUH1dq -c config.yaml

आउटपुट

कामयाब होने पर, आपको नीचे दिए गए जैसा एक जेएसटी टोकन आउटपुट दिखेगा:
eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q

JWT टोकन की जांच करें

इस निर्देश की मदद से, किसी JWT टोकन की जांच की जा सकती है. टोकन की जांच करना भी देखें.

इस्तेमाल

apigee-remote-service-cli token inspect [flags]

पैरामीटर

पैरामीटर

पैरामीटर मौजूदगी प्रॉडक्ट के साथ इस्तेमाल किया गया ब्यौरा
-c,
‑‑config
ज़रूरी है सभी (स्ट्रिंग) Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है सलाह: इस फ़्लैग की मदद से आप ज़्यादातर दूसरे कमांड पैरामीटर को छोड़ सकते हैं, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. देखें ‑‑config विकल्प का इस्तेमाल करके.
-e,
‑‑environment
ज़रूरी है सभी (स्ट्रिंग) आपके संगठन का एक एनवायरमेंट.
-f,
‑‑file
ज़रूरी है सभी (स्ट्रिंग) टोकन फ़ाइल (डिफ़ॉल्ट: stdin का इस्तेमाल करें)
-h,
‑‑help
वैकल्पिक सभी कमांड पैरामीटर के लिए सहायता दिखाता है.
‑‑insecure वैकल्पिक सभी एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन को अनुमति दें.
‑‑legacy ज़रूरी है सिर्फ़ Edge पब्लिक क्लाउड अगर सार्वजनिक क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा. मैनेजमेंट और रनटाइम यूआरएल सेट करता है Public Cloud के लिए Apigee Edge.
‑‑opdk ज़रूरी है सिर्फ़ Edge प्राइवेट क्लाउड अगर प्राइवेट क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा.
-o,
‑‑organization
ज़रूरी है सभी (स्ट्रिंग) Apigee संगठन. आपको संगठन का एडमिन होना ज़रूरी है.
-r,
‑‑runtime
ज़रूरी है Edge प्राइवेट क्लाउड और सिर्फ़ Apigee हाइब्रिड (स्ट्रिंग) आपके प्राइवेट क्लाउड या Apigee हाइब्रिड इंस्टेंस के लिए, रनटाइम यूआरएल के बारे में जानकारी देती है. यूआरएल https:// से शुरू होना चाहिए. उदाहरण के लिए: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
वैकल्पिक सिर्फ़ Edge प्राइवेट क्लाउड (स्ट्रिंग) mTLS कनेक्शन के लिए, क्लाइंट-साइड TLS सर्टिफ़िकेट, निजी पासकोड, और रूट CA की जानकारी देता है.
-v,
‑‑verbose
वैकल्पिक सभी (ज़रूरी नहीं) ज़्यादा शब्दों में जवाब दिया जाता है.

उदाहरण

apigee-remote-service-cli token inspect -c config.yaml <<< $TOKEN

आउटपुट

सफल होने पर, आपको इस तरह का आउटपुट दिखेगा:
{
	"aud": [
		"remote-service-client"
	],
	"exp": 1591741549,
	"iat": 1591740649,
	"iss": "https://apigee-docs-test.apigee.net/remote-service/token",
	"jti": "99325d2e-6440-4278-9f7f-b252a1a79e53",
	"nbf": 1591740649,
	"access_token": "VfzpXzBGAQ07po0bPMKY4JgQjus",
	"api_product_list": [
		"httpbin"
	],
	"application_name": "httpbin",
	"client_id": "GYDGHy5TRpV8AejXCOlreP7dPVepA8H",
	"developer_email": "user@example.com",
	"scope": ""
}
verifying...
token ok.

JWT टोकन घुमाएं

JWT जनरेट करने के बाद, आपको सार्वजनिक/निजी पासकोड में बदलाव करना पड़ सकता है Apigee के ज़रिए एन्क्रिप्ट (सुरक्षित) किए गए की-वैल्यू मैप (KVM) में सेव किया गया पेयर. जनरेट करने की यह प्रोसेस तो कुंजी का नया जोड़ा, 'की रोटेशन' कहा जाता है. कुंजियों को घुमाने पर, एक नया निजी/सार्वजनिक कुंजी का जोड़ा जनरेट और सेव किया जाता है. आपके Apigee संगठन/परिवेश में केवीएम. साथ ही, पुरानी सार्वजनिक कुंजी, उसके मूल कुंजी आईडी की वैल्यू के साथ बनी रहती है.

इस्तेमाल

apigee-remote-service-cli token rotate-cert [flags]

पैरामीटर

पैरामीटर मौजूदगी प्रॉडक्ट के साथ इस्तेमाल किया गया ब्यौरा
-c,
‑‑config
ज़रूरी है सभी (स्ट्रिंग) Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है सलाह: इस फ़्लैग की मदद से आप ज़्यादातर दूसरे कमांड पैरामीटर को छोड़ सकते हैं, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. देखें ‑‑config विकल्प का इस्तेमाल करके.
-e,
‑‑environment
ज़रूरी है सभी (स्ट्रिंग) आपके संगठन का एक एनवायरमेंट.
-h,
‑‑help
वैकल्पिक सिर्फ़ Edge पब्लिक और प्राइवेट क्लाउड कमांड पैरामीटर के लिए सहायता दिखाता है.
--k, --key ज़रूरी है सिर्फ़ Edge पब्लिक और प्राइवेट क्लाउड (स्ट्रिंग) प्रावधान कुंजी.
‑‑insecure वैकल्पिक सिर्फ़ Edge पब्लिक और प्राइवेट क्लाउड एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन को अनुमति दें.
‑‑legacy ज़रूरी है सिर्फ़ Edge पब्लिक क्लाउड अगर सार्वजनिक क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा. मैनेजमेंट और रनटाइम यूआरएल सेट करता है Public Cloud के लिए Apigee Edge.
‑‑opdk ज़रूरी है सिर्फ़ Edge प्राइवेट क्लाउड अगर प्राइवेट क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा.
-o,
‑‑organization
ज़रूरी है सिर्फ़ Edge पब्लिक और प्राइवेट क्लाउड (स्ट्रिंग) Apigee संगठन. आपको संगठन का एडमिन होना ज़रूरी है.
-r,
‑‑runtime
ज़रूरी है सिर्फ़ Edge प्राइवेट क्लाउड (स्ट्रिंग) आपके प्राइवेट क्लाउड या Apigee हाइब्रिड इंस्टेंस के लिए, रनटाइम यूआरएल के बारे में जानकारी देती है. यूआरएल https:// से शुरू होना चाहिए. उदाहरण के लिए: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret ज़रूरी है सभी (स्ट्रिंग) प्रावधान सीक्रेट.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca
वैकल्पिक सिर्फ़ Edge प्राइवेट क्लाउड (स्ट्रिंग) mTLS कनेक्शन के लिए, क्लाइंट-साइड TLS सर्टिफ़िकेट, निजी पासकोड, और रूट CA की जानकारी देता है.
--t, ‑‑truncate ज़रूरी है सभी (पूरी संख्या) JWKS में रखे जाने वाले सर्टिफ़िकेट की संख्या (डिफ़ॉल्ट 2).
-v,
‑‑verbose
वैकल्पिक सभी (ज़रूरी नहीं) ज़्यादा शब्दों में जवाब दिया जाता है.

उदाहरण

apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test \
-k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 \
-s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08

आउटपुट

certificate successfully rotated

इंटरनल टोकन बनाएं

रिमोट-सर्विस एपीआई कॉल को अनुमति देने के लिए, JWT टोकन बनाएं.

इस्तेमाल

apigee-remote-service-cli token internal [flags]

पैरामीटर

पैरामीटर

पैरामीटर मौजूदगी प्रॉडक्ट के साथ इस्तेमाल किया गया ब्यौरा
-c,
‑‑config
ज़रूरी है सिर्फ़ Apigee हाइब्रिड (स्ट्रिंग) Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है सलाह: इस फ़्लैग की मदद से आप ज़्यादातर दूसरे कमांड पैरामीटर को छोड़ सकते हैं, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. देखें ‑‑config विकल्प का इस्तेमाल करके.
-d,
‑‑duration
ज़रूरी है सिर्फ़ Apigee हाइब्रिड (स्ट्रिंग) बनाए जाने के दौरान अंदरूनी JWT का मान्य समय (डिफ़ॉल्ट: 10m0s (10 मिनट)).
-e,
‑‑environment
ज़रूरी है सिर्फ़ Apigee हाइब्रिड (स्ट्रिंग) आपके संगठन का एक एनवायरमेंट.
-h,
‑‑help
वैकल्पिक सिर्फ़ Apigee हाइब्रिड कमांड पैरामीटर के लिए सहायता दिखाता है.
‑‑insecure वैकल्पिक सिर्फ़ Apigee हाइब्रिड एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन को अनुमति दें.
-o,
‑‑organization
ज़रूरी है सिर्फ़ Apigee हाइब्रिड (स्ट्रिंग) Apigee संगठन. आपको संगठन का एडमिन होना ज़रूरी है.
-r,
‑‑runtime
ज़रूरी है सिर्फ़ Apigee हाइब्रिड (स्ट्रिंग) आपके Apigee हाइब्रिड इंस्टेंस के लिए, रनटाइम यूआरएल की जानकारी देती है. यूआरएल https:// से शुरू होना चाहिए. उदाहरण के लिए: https://apitest.apigee-hybrid-docs.net
-v,
‑‑verbose
वैकल्पिक सिर्फ़ Apigee हाइब्रिड (ज़रूरी नहीं) ज़्यादा शब्दों में जवाब दिया जाता है.

वर्शन निर्देश

सीएलआई वर्शन प्रिंट करें.

apigee-remote-service-cli version

क्रेडेंशियल के लिए .netrc का इस्तेमाल करना

apigee-remote-service-cli अपने-आप username चुनता है और .netrc से password (जहां ज़रूरी हो, बुनियादी पुष्टि करने के लिए) अगर आप Edge Public Cloud पर हैं और आपके पास मशीन api.enterprise.apigee.com. अगर आप Apigee Private Cloud का इस्तेमाल करते हैं, तो मशीन की वैल्यू, आपके management यूआरएल की वैल्यू से मेल खाती है. उदाहरण के लिए: http://192.162.55.100). उदाहरण के लिए, Edge Public Cloud पर:
machine api.enterprise.apigee.com
login jdoe@google.com
password abc123
उदाहरण के लिए, Edge Private Cloud पर:
machine http://192.162.55.100
login jdoe@google.com
password abc123

‑‑config निर्देश विकल्प का इस्तेमाल किया जा रहा है

‑‑config विकल्प से जगह की जानकारी मिलती है provision कमांड से जनरेट की गई कॉन्फ़िगरेशन फ़ाइल का. इस विकल्प का एक मददगार फ़ायदा यह है कि की मदद से ज़्यादातर ऐसे कमांड पैरामीटर को स्किप किया जा सकता है जो सीएलआई, कॉन्फ़िगरेशन फ़ाइल से लेता है. इन विकल्पों में ये शामिल हैं:
  • संगठन
  • वातावरण
  • रनटाइम
  • मैनेजमेंट
  • असुरक्षित
  • नाम स्थान
  • लेगसी
  • opdk

उदाहरण के लिए, provision कमांड को इस तरह से एक्ज़ीक्यूट किया जा सकता है:

apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml

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

इस सेक्शन में कॉन्फ़िगरेशन फ़ाइल का एक उदाहरण दिया गया है, जिसमें सभी विकल्प मौजूद हैं.

global:
  temp_dir: /tmp/apigee-istio
  keep_alive_max_connection_age: 10m
  api_address: :5000
  metrics_address: :5001
  tls:
    cert_file: tls.crt
    key_file: tls.key
tenant:
  internal_api: https://istioservices.apigee.net/edgemicro
  remote_service_api: https://org-test.apigee.net/remote-service
  org_name: org
  env_name: env
  key: mykey
  secret: mysecret
  client_timeout: 30s
  tls:
    ca_file: /opt/apigee/tls/ca.crt
    cert_file: /opt/apigee/tls/tls.crt
    key_file: /opt/apigee/tls/tls.key
    allow_unverified_ssl_cert: false
products:
  refresh_rate: 2m
analytics:
  legacy_endpoint: false
  file_limit: 1024
  send_channel_size: 10
  collection_interval: 10s
auth:
  api_key_claim: claim
  api_key_cache_duration: 30m
  api_key_header: x-api-key
  api_header: :authority
  allow_unauthorized: false
  jwt_provider_key: https://org-test.apigee.net/remote-token/token
  append_metadata_headers: true