रेफ़रंस

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

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

List bindings command

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

इस्तेमाल

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

पैरामीटर

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

इस्तेमाल

apigee-remote-service-cli provision [flags]

पैरामीटर

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

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

उदाहरण

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

उदाहरण: 

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 सिर्फ़ 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

टोकन कमांड

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

इस्तेमाल

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

पैरामीटर

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

वर्शन कमांड

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

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