रेफ़रंस

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

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

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

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

इस्तेमाल का तरीका

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

पैरामीटर

पैरामीटर मौजूदगी प्रॉडक्ट के साथ इस्तेमाल किया गया ब्यौरा
-c,
‑‑config 		ज़रूरी है सभी (स्ट्रिंग) Apigee रिमोट सेवा की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, ज़्यादातर दूसरे कमांड पैरामीटर को हटाया जा सकता है. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. ‑‑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 पब्लिक क्लाउड (स्ट्रिंग) Public Cloud के लिए आपके Apigee Edge के लिए, कई तरीकों से पुष्टि करने वाला टोकन. सिर्फ़ तब ज़रूरी है, जब आपके Apigee Edge खाते पर MFA सेट अप किया गया हो.
‑‑opdk ज़रूरी है सिर्फ़ Edge प्राइवेट क्लाउड अगर निजी क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा.
-o,
‑‑organization 		ज़रूरी है सभी (स्ट्रिंग) एक Apigee संगठन. आपको संगठन का एडमिन होना चाहिए.
-p,
‑‑password 		ज़रूरी है
(सिर्फ़ बुनियादी पुष्टि के लिए)		 सिर्फ़ Edge सार्वजनिक और निजी क्लाउड (स्ट्रिंग) आपका Apigee पासवर्ड. आपके पास .netrc फ़ाइल में पासवर्ड डालने का विकल्प भी है. क्रेडेंशियल के लिए .netrc का इस्तेमाल करना भी देखें.
-r,
‑‑runtime 		ज़रूरी है सिर्फ़ Edge Private Cloud और Apigee हाइब्रिड (स्ट्रिंग) आपके Private Cloud या 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 रिमोट सेवा की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, ज़्यादातर दूसरे कमांड पैरामीटर को हटाया जा सकता है. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. ‑‑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 पब्लिक क्लाउड Public Cloud के लिए आपके Apigee Edge के लिए, कई तरीकों से पुष्टि करने वाला टोकन. सिर्फ़ तब ज़रूरी है, जब आपके Apigee Edge खाते पर MFA सेट अप किया गया हो.
-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 Private Cloud और Apigee हाइब्रिड (स्ट्रिंग) आपके Private Cloud या 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 होते हैं. अगर आपने Edge संगठन-एनवायरमेंट के लिए इन डिफ़ॉल्ट के अलावा दूसरे वर्चुअल होस्ट तय किए हैं, तो इस विकल्प का इस्तेमाल करें.

उदाहरण

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

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

पैरामीटर

पैरामीटर मौजूदगी प्रॉडक्ट के साथ इस्तेमाल किया गया ब्यौरा
‑‑adapter‑host सिर्फ़ Envoy टेंप्लेट के लिए ज़रूरी है सभी (स्ट्रिंग) अडैप्टर होस्टनेम (डिफ़ॉल्ट: localhost)
-c, ‑‑config ज़रूरी है सभी (स्ट्रिंग) Apigee रिमोट सेवा की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, ज़्यादातर दूसरे कमांड पैरामीटर को हटाया जा सकता है. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. ‑‑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 ज़रूरी नहीं, सिर्फ़ Envoy टेंप्लेट के लिए सभी (स्ट्रिंग) वह डायरेक्ट्री जिसमें अडैप्टर सर्विस के लिए इस्तेमाल की जाने वाली 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

टोकन से जुड़े निर्देश

आप API कुंजी का उपयोग करने के बजाय प्रमाणित API प्रॉक्सी कॉल करने के लिए 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 का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा. यह नीति, Public Cloud के लिए Apigee Edge के मैनेजमेंट और रनटाइम यूआरएल सेट करती है.
‑‑opdk ज़रूरी है सिर्फ़ Edge प्राइवेट क्लाउड अगर निजी क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा.
-o,
‑‑organization 		ज़रूरी है सभी (स्ट्रिंग) एक Apigee संगठन. आपको संगठन का एडमिन होना चाहिए.
-r,
‑‑runtime 		ज़रूरी है सिर्फ़ Edge Private Cloud और Apigee हाइब्रिड (स्ट्रिंग) आपके Private Cloud या 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 रिमोट सेवा की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, ज़्यादातर दूसरे कमांड पैरामीटर को हटाया जा सकता है. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. ‑‑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 Private Cloud और Apigee हाइब्रिड (स्ट्रिंग) आपके Private Cloud या 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 टोकन घुमाएं

जेडब्लयूटी जनरेट करने के कुछ समय बाद, आपको Apigee के एन्क्रिप्ट किए गए की-वैल्यू मैप (केवीएम) में सेव किए गए सार्वजनिक/निजी कुंजी के जोड़े को बदलना पड़ सकता है. कुंजी का नया जोड़ा जनरेट करने की इस प्रोसेस को की रोटेशन कहते हैं. कुंजियों को रोटेट करने पर, एक नया निजी/सार्वजनिक कुंजी का जोड़ा जनरेट होता है और आपके 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 का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा. यह नीति, Public Cloud के लिए Apigee Edge के मैनेजमेंट और रनटाइम यूआरएल सेट करती है.
‑‑opdk ज़रूरी है सिर्फ़ Edge प्राइवेट क्लाउड अगर निजी क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो आपको यह फ़्लैग सेट करना होगा.
-o,
‑‑organization 		ज़रूरी है सिर्फ़ Edge सार्वजनिक और निजी क्लाउड (स्ट्रिंग) एक Apigee संगठन. आपको संगठन का एडमिन होना चाहिए.
-r,
‑‑runtime 		ज़रूरी है सिर्फ़ Edge प्राइवेट क्लाउड (स्ट्रिंग) आपके Private Cloud या 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 रिमोट सेवा की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, ज़्यादातर दूसरे कमांड पैरामीटर को हटाया जा सकता है. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. ‑‑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 प्राइवेट क्लाउड पर: 
machine http://192.162.55.100
login jdoe@google.com
password abc123

‑‑config कमांड विकल्प का इस्तेमाल करना

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

उदाहरण के लिए, 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