संदर्भ

Apigee Edge का दस्तावेज़ देखा जा रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी

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

List bindings command

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

इस्तेमाल

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

पैरामीटर

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

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

उदाहरण

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

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

उदाहरण

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

आउटपुट

पुष्टि हो जाने पर, आपको JST टोकन का ऐसा आउटपुट दिखेगा: 
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 रिमोट सेवा कॉन्फ़िगरेशन फ़ाइल का पाथ.
सलाह: इस फ़्लैग की मदद से, ज़्यादातर अन्य कमांड पैरामीटर को हटाया जा सकता है, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. ‑‑config विकल्प का इस्तेमाल करना देखें.
-e,
‑‑environment 		ज़रूरी है सभी (स्ट्रिंग) आपके संगठन का कोई एनवायरमेंट.
-f,
‑‑file 		ज़रूरी है सभी (स्ट्रिंग) टोकन फ़ाइल (डिफ़ॉल्ट: stdin का इस्तेमाल करें)
-h,
‑‑help 		वैकल्पिक सभी कमांड पैरामीटर के बारे में सहायता दिखाता है.
‑‑insecure वैकल्पिक सभी एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन को अनुमति दें.
‑‑legacy ज़रूरी है सिर्फ़ Edge पब्लिक क्लाउड अगर सार्वजनिक क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा. Apigee Edge for Public Cloud के लिए, मैनेजमेंट और रनटाइम यूआरएल सेट करता है.
‑‑opdk ज़रूरी है सिर्फ़ Edge Private Cloud अगर Private Cloud के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा.
-o,
‑‑organization 		ज़रूरी है सभी (स्ट्रिंग) Apigee का कोई संगठन. आपके पास संगठन के एडमिन की भूमिका होनी चाहिए.
-r,
‑‑runtime 		ज़रूरी है सिर्फ़ Edge Private Cloud और Apigee हाइब्रिड (स्ट्रिंग) आपके प्राइवेट क्लाउड या Apigee हाइब्रिड इंस्टेंस के लिए, रनटाइम यूआरएल के बारे में जानकारी देती है. यूआरएल https:// से शुरू होना चाहिए. उदाहरण के लिए: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		वैकल्पिक सिर्फ़ Edge Private Cloud (स्ट्रिंग) mTLS कनेक्शन के लिए, क्लाइंट-साइड TLS सर्टिफ़िकेट, निजी कुंजी, और रूट सीए की जानकारी देता है.
-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 संगठन/एनवायरमेंट में "istio" केवीएम में सेव हो जाता है. इसके अलावा, पुरानी सार्वजनिक कुंजी को उसकी ओरिजनल कुंजी आईडी वैल्यू के साथ रखा जाता है.

इस्तेमाल

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

पैरामीटर

पैरामीटर मौजूदगी प्रॉडक्ट के साथ इस्तेमाल किया जाता है ब्यौरा
-c,
‑‑config 		ज़रूरी है सभी (स्ट्रिंग) Apigee रिमोट सेवा कॉन्फ़िगरेशन फ़ाइल का पाथ.
सलाह: इस फ़्लैग की मदद से, ज़्यादातर अन्य कमांड पैरामीटर को छोड़ा जा सकता है, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से खींच सकता है. ‑‑config विकल्प का इस्तेमाल करना देखें.
-e,
‑‑environment 		ज़रूरी है सभी (स्ट्रिंग) आपके संगठन का एक एनवायरमेंट.
-h,
‑‑help 		वैकल्पिक सिर्फ़ Edge सार्वजनिक और प्राइवेट क्लाउड कमांड पैरामीटर के बारे में सहायता दिखाता है.
--k, --key ज़रूरी है सिर्फ़ Edge के सार्वजनिक और निजी क्लाउड के लिए (स्ट्रिंग) प्रोविज़न पासकोड.
‑‑insecure वैकल्पिक सिर्फ़ Edge के सार्वजनिक और निजी क्लाउड के लिए एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन की अनुमति दें.
‑‑legacy ज़रूरी है सिर्फ़ Edge पब्लिक क्लाउड अगर सार्वजनिक क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा. Apigee Edge for Public Cloud के लिए, मैनेजमेंट और रनटाइम यूआरएल सेट करता है.
‑‑opdk ज़रूरी है सिर्फ़ Edge Private Cloud अगर Private Cloud के लिए 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 Private Cloud (स्ट्रिंग) mTLS कनेक्शन के लिए, क्लाइंट-साइड TLS सर्टिफ़िकेट, निजी कुंजी, और रूट सीए की जानकारी देता है.
--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 रिमोट सेवा कॉन्फ़िगरेशन फ़ाइल का पाथ.
सलाह: इस फ़्लैग की मदद से, ज़्यादातर अन्य कमांड पैरामीटर को छोड़ा जा सकता है, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से खींच सकता है. ‑‑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 का इस्तेमाल करना

अगर आप Edge Public Cloud का इस्तेमाल कर रहे हैं और आपके पास मशीन api.enterprise.apigee.com के लिए एंट्री है, तो apigee-remote-service-cli आपकी होम डायरेक्ट्री में मौजूद .netrc फ़ाइल से username और password (ज़रूरत पड़ने पर बुनियादी पुष्टि के लिए) को अपने-आप चुन लेता है. अगर आप 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