रेफ़रंस

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

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

बाइंडिंग कमांड

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

बाइंडिंग जोड़ें

एपीआई प्रॉडक्ट से रिमोट सेवा के टारगेट बाइंडिंग को जोड़ता है.

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

Edge Public Cloud के लिए:

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

Edge के प्राइवेट क्लाउड के लिए:

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

जगह:

  • target_name, प्रॉडक्ट से जुड़ने के लिए रिमोट सेवा टारगेट का नाम है.
  • product_name उस प्रॉडक्ट का नाम है जिससे सेवा को बाध्य करना है.

झंडे

पैरामीटर टाइप ब्यौरा
-c, --config स्ट्रिंग (ज़रूरी है) Apigee रिमोट सेवा की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, ज़्यादातर दूसरे कमांड पैरामीटर को हटाया जा सकता है. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. --config विकल्प इस्तेमाल करना देखें.
-e, --env स्ट्रिंग (ज़रूरी है) आपके संगठन का एक एनवायरमेंट.
-h, --help कमांड पैरामीटर के लिए सहायता दिखाता है.
--insecure SSL का उपयोग करते समय असुरक्षित सर्वर कनेक्शन को अनुमति दें
--legacy अगर Apigee Edge Cloud का इस्तेमाल किया जा रहा है, तो यह फ़्लैग सेट करें. यह Edge Cloud के लिए, मैनेजमेंट और रनटाइम यूआरएल सेट करता है.
--mfa Apigee मल्टी-फ़ैक्टर ऑथराइज़ेशन टोकन (सिर्फ़ --legacy के साथ इस्तेमाल किया जाता है)
--opdk अगर प्राइवेट क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो यह फ़्लैग सेट करें.
-o, --org स्ट्रिंग (ज़रूरी है) एक Apigee संगठन. आपको संगठन का एडमिन होना चाहिए.
-p, --password स्ट्रिंग (सिर्फ़ बुनियादी तौर पर पुष्टि करने के लिए ज़रूरी) आपका Apigee पासवर्ड. आपके पास .netrc फ़ाइल में पासवर्ड डालने का विकल्प भी है. अगर ऐसा किया जाता है, तो आपको कमांड लाइन पर अपना पासवर्ड देने की ज़रूरत नहीं है. क्रेडेंशियल के लिए .netrc का इस्तेमाल करना भी देखें.
-r, --runtime स्ट्रिंग (सिर्फ़ प्राइवेट क्लाउड) से, आपके Private Cloud इंस्टेंस के लिए रनटाइम यूआरएल की जानकारी मिलती है.
-t, --token स्ट्रिंग (सिर्फ़ OAuth टोकन की पुष्टि करने के लिए ज़रूरी) OAuth या एसएएमएल टोकन, जिसे आपने Apigee खाते की जानकारी से जनरेट किया है. टोकन जनरेट करने के बारे में जानकारी के लिए, यह लेख पढ़ें: get_token का इस्तेमाल करना और एसएएमएल से मैनेजमेंट एपीआई को ऐक्सेस करना.
-u, --username स्ट्रिंग (सिर्फ़ बुनियादी पुष्टि के लिए ज़रूरी) आपका Apigee उपयोगकर्ता नाम (आम तौर पर एक ईमेल पता). आपके पास .netrc फ़ाइल में उपयोगकर्ता नाम डालने का विकल्प भी है. अगर आपने ऐसा किया है, तो आपको कमांड लाइन पर अपना उपयोगकर्ता नाम देने की ज़रूरत नहीं है. क्रेडेंशियल के लिए .netrc का इस्तेमाल करना भी देखें.
-v, --verbose (ज़रूरी नहीं) वर्बोस आउटपुट देता है.

उदाहरण

./apigee-remote-service-cli bindings add httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is now bound to: httpbin.org

सूची बाइंडिंग

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

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

Edge Public Cloud के लिए:

apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password]

Edge के प्राइवेट क्लाउड के लिए:

apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password] -r [runtime] 

पैरामीटर

पैरामीटर टाइप ब्यौरा
-c, --config स्ट्रिंग (ज़रूरी है) Apigee रिमोट सेवा की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, ज़्यादातर दूसरे कमांड पैरामीटर को हटाया जा सकता है. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. --config विकल्प का इस्तेमाल करना देखें..
-e, --env स्ट्रिंग (ज़रूरी है) आपके संगठन का एक एनवायरमेंट.
-h, --help कमांड पैरामीटर के लिए सहायता दिखाता है.
--insecure SSL का उपयोग करते समय असुरक्षित सर्वर कनेक्शन को अनुमति दें
--legacy अगर Apigee Edge Cloud का इस्तेमाल किया जा रहा है, तो यह फ़्लैग सेट करें. यह Edge Cloud के लिए, मैनेजमेंट और रनटाइम यूआरएल सेट करता है.
--mfa Apigee मल्टी-फ़ैक्टर ऑथराइज़ेशन टोकन (सिर्फ़ --legacy के साथ इस्तेमाल किया जाता है)
--opdk अगर प्राइवेट क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो यह फ़्लैग सेट करें.
-o, --org स्ट्रिंग (ज़रूरी है) एक Apigee संगठन. आपको संगठन का एडमिन होना चाहिए.
-p, --password स्ट्रिंग (सिर्फ़ बुनियादी तौर पर पुष्टि करने के लिए ज़रूरी) आपका Apigee पासवर्ड. आपके पास .netrc फ़ाइल में पासवर्ड डालने का विकल्प भी है. अगर ऐसा किया जाता है, तो आपको कमांड लाइन पर अपना पासवर्ड देने की ज़रूरत नहीं है. क्रेडेंशियल के लिए .netrc का इस्तेमाल करना भी देखें.
-r, --runtime स्ट्रिंग (सिर्फ़ प्राइवेट क्लाउड) से, आपके Private Cloud इंस्टेंस के लिए रनटाइम यूआरएल की जानकारी मिलती है.
-t, --token स्ट्रिंग (सिर्फ़ OAuth टोकन की पुष्टि करने के लिए ज़रूरी) OAuth या एसएएमएल टोकन, जिसे आपने Apigee खाते की जानकारी से जनरेट किया है. टोकन जनरेट करने के बारे में जानकारी के लिए, यह लेख पढ़ें: get_token का इस्तेमाल करना और एसएएमएल से मैनेजमेंट एपीआई को ऐक्सेस करना.
-u, --username स्ट्रिंग (सिर्फ़ बुनियादी पुष्टि के लिए ज़रूरी) आपका 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:

बाइंडिंग को हटाना

एपीआई प्रॉडक्ट से, Envoy के लिए रिमोट सर्विस की बाइंडिंग हटाएं.

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

Edge Public Cloud के लिए:

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

Edge के प्राइवेट क्लाउड के लिए:

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

जगह:

  • target_name, उस रिमोट सेवा टारगेट का नाम है जिसे प्रॉडक्ट से हटाया जाना है.
  • product_name उस प्रॉडक्ट का नाम है जिससे टारगेट को हटाया जाना है.

पैरामीटर

पैरामीटर टाइप ब्यौरा
-c, --config स्ट्रिंग (ज़रूरी है) Apigee रिमोट सेवा की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, ज़्यादातर दूसरे कमांड पैरामीटर को हटाया जा सकता है. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. --config विकल्प इस्तेमाल करना देखें.
-e, --env स्ट्रिंग (ज़रूरी है) आपके संगठन का एक एनवायरमेंट.
-h, --help कमांड पैरामीटर के लिए सहायता दिखाता है.
--insecure SSL का उपयोग करते समय असुरक्षित सर्वर कनेक्शन को अनुमति दें
--legacy अगर Apigee Edge Cloud का इस्तेमाल किया जा रहा है, तो यह फ़्लैग सेट करें. यह Edge Cloud के लिए, मैनेजमेंट और रनटाइम यूआरएल सेट करता है.
--mfa Apigee मल्टी-फ़ैक्टर ऑथराइज़ेशन टोकन (सिर्फ़ --legacy के साथ इस्तेमाल किया जाता है)
--opdk अगर प्राइवेट क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो यह फ़्लैग सेट करें.
-o, --org स्ट्रिंग (ज़रूरी है) एक Apigee संगठन. आपको संगठन का एडमिन होना चाहिए.
-p, --password स्ट्रिंग (सिर्फ़ बुनियादी तौर पर पुष्टि करने के लिए ज़रूरी) आपका Apigee पासवर्ड. आपके पास .netrc फ़ाइल में पासवर्ड डालने का विकल्प भी है. अगर ऐसा किया जाता है, तो आपको कमांड लाइन पर अपना पासवर्ड देने की ज़रूरत नहीं है. क्रेडेंशियल के लिए .netrc का इस्तेमाल करना भी देखें.
-r, --runtime स्ट्रिंग (सिर्फ़ प्राइवेट क्लाउड) से, आपके Private Cloud इंस्टेंस के लिए रनटाइम यूआरएल की जानकारी मिलती है.
-t, --token स्ट्रिंग (सिर्फ़ OAuth टोकन की पुष्टि करने के लिए ज़रूरी) OAuth या एसएएमएल टोकन, जिसे आपने Apigee खाते की जानकारी से जनरेट किया है. टोकन जनरेट करने के बारे में जानकारी के लिए, यह लेख पढ़ें: get_token का इस्तेमाल करना और एसएएमएल से मैनेजमेंट एपीआई को ऐक्सेस करना.
-u, --username स्ट्रिंग (सिर्फ़ बुनियादी पुष्टि के लिए ज़रूरी) आपका Apigee उपयोगकर्ता नाम (आम तौर पर एक ईमेल पता). आपके पास .netrc फ़ाइल में उपयोगकर्ता नाम डालने का विकल्प भी है. अगर आपने ऐसा किया है, तो आपको कमांड लाइन पर अपना उपयोगकर्ता नाम देने की ज़रूरत नहीं है. क्रेडेंशियल के लिए .netrc का इस्तेमाल करना भी देखें.
-v, --verbose (ज़रूरी नहीं) वर्बोस आउटपुट देता है.

उदाहरण

./apigee-remote-service-cli bindings remove httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is no longer bound to: httpbin.org

बाइंडिंग की पुष्टि करना

पुष्टि करें कि बताए गए बाउंड एपीआई प्रॉडक्ट और उससे जुड़े डेवलपर ऐप्लिकेशन में भी रिमोट सेवा वाला प्रॉडक्ट हो. अगर आपने एपीआई प्रॉडक्ट का नाम नहीं दिया है, तो यह निर्देश उन सभी प्रॉडक्ट की जांच करता है जो उस प्रॉडक्ट के लिए बने हैं.

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

Edge Public Cloud के लिए:

apigee-remote-service-cli bindings verify [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

Edge के प्राइवेट क्लाउड के लिए:

apigee-remote-service-cli bindings verify [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

जहां product_name ज़रूरी नहीं है. अगर प्रॉडक्ट का नाम नहीं बताया जाता है, तो जोड़े गए सभी प्रॉडक्ट पर सही का निशान लगा होता है.

पैरामीटर

पैरामीटर टाइप ब्यौरा
-c, --config स्ट्रिंग (ज़रूरी है) Apigee रिमोट सेवा की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, ज़्यादातर दूसरे कमांड पैरामीटर को हटाया जा सकता है. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. --config विकल्प इस्तेमाल करना देखें.
-e, --env स्ट्रिंग (ज़रूरी है) आपके संगठन का एक एनवायरमेंट.
-h, --help कमांड पैरामीटर के लिए सहायता दिखाता है.
--insecure SSL का उपयोग करते समय असुरक्षित सर्वर कनेक्शन को अनुमति दें
--legacy अगर Apigee Edge Cloud का इस्तेमाल किया जा रहा है, तो यह फ़्लैग सेट करें. यह Edge Cloud के लिए, मैनेजमेंट और रनटाइम यूआरएल सेट करता है.
--mfa Apigee मल्टी-फ़ैक्टर ऑथराइज़ेशन टोकन (सिर्फ़ --legacy के साथ इस्तेमाल किया जाता है)
--opdk अगर प्राइवेट क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो यह फ़्लैग सेट करें.
-o, --org स्ट्रिंग (ज़रूरी है) एक Apigee संगठन. आपको संगठन का एडमिन होना चाहिए.
-r, --runtime स्ट्रिंग (सिर्फ़ प्राइवेट क्लाउड) से, आपके Private Cloud इंस्टेंस के लिए रनटाइम यूआरएल की जानकारी मिलती है.
-t, --token स्ट्रिंग (सिर्फ़ OAuth टोकन की पुष्टि करने के लिए ज़रूरी) OAuth या एसएएमएल टोकन, जिसे आपने Apigee खाते की जानकारी से जनरेट किया है. टोकन जनरेट करने के बारे में जानकारी के लिए, यह लेख पढ़ें: get_token का इस्तेमाल करना और एसएएमएल से मैनेजमेंट एपीआई को ऐक्सेस करना.
-v, --verbose (ज़रूरी नहीं) वर्बोस आउटपुट देता है.

उदाहरण

./apigee-remote-service-cli bindings verify my-product -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
  app my-app associated with product my-product is verified

सहायता निर्देश

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 अडैप्टर को कॉन्फ़िगर करना होगा.

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

अगर आप Edge Public Cloud का इस्तेमाल कर रहे हैं, तो:

apigee-remote-service-cli provision -o $ORG -e $ENV -u $USERNAME -p $PASSWORD

अगर आप Edge Private Cloud का इस्तेमाल कर रहे हैं, तो:

apigee-remote-service-cli provision --opdk -o $ORG -e $ENV -u $USERNAME --management $MGMT_SERVER_URL --runtime $RUNTIME_URL -p $PASSWORD

पैरामीटर

पैरामीटर टाइप ब्यौरा
--analytics-sa स्ट्रिंग यह फ़्लैग, Google Cloud इंस्टॉलेशन पर सिर्फ़ Apigee हाइब्रिड और Apigee के लिए उपलब्ध है.

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

-c, --config स्ट्रिंग Apigee रिमोट सर्विस की कॉन्फ़िगरेशन फ़ाइल का पाथ. --config विकल्प का इस्तेमाल करना भी देखें.
-e, --environment स्ट्रिंग (ज़रूरी है) आपके संगठन का एक एनवायरमेंट.
-f, --force-proxy-install (ज़रूरी नहीं) अगर आपके संगठन में remote-service प्रॉक्सी पहले से इंस्टॉल है, तो इसे हर हाल में फिर से इंस्टॉल करने के लिए कहा जाता है.
-h, --help कमांड पैरामीटर के लिए सहायता दिखाता है.
-k, --key स्ट्रिंग इस नीति से, apigee-remote-service-cli provision कमांड से मिलने वाली कुंजी के बारे में पता चलता है.
--legacy अगर Apigee Edge Cloud का इस्तेमाल किया जा रहा है, तो यह फ़्लैग सेट करें. यह Edge Cloud के लिए, मैनेजमेंट और रनटाइम यूआरएल सेट करता है.
--mfa Apigee मल्टी-फ़ैक्टर ऑथराइज़ेशन टोकन (सिर्फ़ --legacy के साथ इस्तेमाल किया जाता है)
-m, --management स्ट्रिंग (अगर आप Apigee Private Cloud का इस्तेमाल करते हैं) आपका Apigee मैनेजमेंट बेस यूआरएल. डिफ़ॉल्ट: https://api.enterprise.apigee.com
-n, --namespace स्ट्रिंग तय किए गए नेमस्पेस में, कॉन्फ़िगरेशन को Envoy ConfigMap के तौर पर एमिट करें. डिफ़ॉल्ट: apigee
--opdk स्ट्रिंग Apigee OPDK.
-o, --organization स्ट्रिंग (ज़रूरी है) आपका Apigee संगठन. आपको संगठन का एडमिन होना चाहिए.
-p, --password स्ट्रिंग (सिर्फ़ बुनियादी तौर पर पुष्टि करने के लिए ज़रूरी) आपका Apigee पासवर्ड. आपके पास .netrc फ़ाइल में पासवर्ड डालने का विकल्प भी है. अगर ऐसा किया जाता है, तो आपको कमांड लाइन पर अपना पासवर्ड देने की ज़रूरत नहीं है. क्रेडेंशियल के लिए .netrc का इस्तेमाल करना भी देखें.
--rotate-int int अगर n > 0 है, तो नई निजी कुंजी जनरेट करें और n सार्वजनिक कुंजियां (सिर्फ़ हाइब्रिड) रखें
-r, --runtime स्ट्रिंग (सिर्फ़ प्राइवेट क्लाउड) से, आपके Private Cloud इंस्टेंस के लिए रनटाइम यूआरएल की जानकारी मिलती है.
-s, --secret स्ट्रिंग apigee-remote-service-cli provision कमांड से मिला सीक्रेट तय करता है.
--strength int (ज़रूरी नहीं) अडैप्टर को सेट अप करने में इस्तेमाल किए गए एसएसएल सर्टिफ़िकेट के लिए, एन्क्रिप्ट (सुरक्षित) करने का तरीका तय करता है. डिफ़ॉल्ट 2048
-t, --token स्ट्रिंग (सिर्फ़ हाइब्रिड) Apigee OAuth या एसएएमएल टोकन.
-u, --username स्ट्रिंग (सिर्फ़ बुनियादी पुष्टि के लिए ज़रूरी) आपका Apigee उपयोगकर्ता नाम (आम तौर पर एक ईमेल पता). आपके पास .netrc फ़ाइल में उपयोगकर्ता नाम डालने का विकल्प भी है. क्रेडेंशियल के लिए .netrc का इस्तेमाल करना भी देखें.
-v, --verbose (ज़रूरी नहीं) वर्बोस आउटपुट देता है.
--virtual-hosts स्ट्रिंग डिफ़ॉल्ट वर्चुअल होस्ट को बदलता है, जो default,secure हैं. अगर आपने Edge संगठन-एनवायरमेंट के लिए इन डिफ़ॉल्ट के अलावा दूसरे वर्चुअल होस्ट तय किए हैं, तो इस विकल्प का इस्तेमाल करें. वर्चुअल होस्ट के बारे में जानने के लिए, Edge का दस्तावेज़ देखें.
--years int (ज़रूरी नहीं) प्रावधान में इस्तेमाल किए गए एसएसएल सर्टिफ़िकेट की समयसीमा खत्म होने के साल की संख्या. डिफ़ॉल्ट: 1

उदाहरण

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

Edge Public Cloud का उदाहरण:

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 उदाहरण जनरेट किया जाएगा. अगर ऐसा नहीं है, तो अपनी टारगेट सेवाओं के डिप्लॉयमेंट से जुड़ी कॉन्फ़िगरेशन फ़ाइलें तैयार करने की ज़िम्मेदारी आपकी है.

पैरामीटर

पैरामीटर टाइप ब्यौरा
-c, --config स्ट्रिंग (ज़रूरी है) Apigee रिमोट सर्विस की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, ज़्यादातर दूसरे कमांड पैरामीटर को हटाया जा सकता है. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. --config विकल्प इस्तेमाल करना देखें.
-f, --force मौजूदा डायरेक्ट्री को हर हाल में ओवरराइट करें.
-h, --help कमांड पैरामीटर के लिए सहायता दिखाता है.
--host टारगेट सर्विस होस्ट (डिफ़ॉल्ट "httpbin.org")
-n, --name टारगेट सेवा का नाम (डिफ़ॉल्ट "httpbin")
--out वह डायरेक्ट्री जिसमें कॉन्फ़िगरेशन फ़ाइलों का सैंपल बनाना है. डिफ़ॉल्ट: ./samples
-t, --template

टेंप्लेट का नाम. अगर Istio डिप्लॉयमेंट (सिर्फ़ हाइब्रिड) किया जा रहा है, तो उपलब्ध Istio विकल्पों में से कोई एक चुनें. नेटिव Envoy डिप्लॉयमेंट के लिए, नेटिव विकल्प का इस्तेमाल करें. आपके लिए ये विकल्प उपलब्ध हैं:

  • istio-1.6 (डिफ़ॉल्ट)
  • istio-1.7
  • native
--tls वह डायरेक्ट्री जिसमें TLS कुंजी और crt फ़ाइलों को सेव किया जाता है.

उदाहरण

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

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

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

JWT टोकन बनाएं

किसी रिमोट सर्विस टारगेट के लिए पुष्टि किए गए एपीआई प्रॉक्सी कॉल करने के लिए, आप JWT टोकन का इस्तेमाल कर सकते हैं. JWT के हिसाब से पुष्टि करने की सुविधा इस्तेमाल करना भी देखें.

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

Edge Public Cloud के लिए:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -o [org] -e [env]
Edge Private Cloud के लिए:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]

पैरामीटर

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

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

Edge Public Cloud के लिए:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file]
Edge Private Cloud के लिए:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]

पैरामीटर

पैरामीटर टाइप ब्यौरा
-c, --config स्ट्रिंग (ज़रूरी है) Apigee रिमोट सेवा की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, ज़्यादातर दूसरे कमांड पैरामीटर को हटाया जा सकता है. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. --config विकल्प इस्तेमाल करना देखें.
-e, --env स्ट्रिंग (ज़रूरी है) आपके संगठन का एक एनवायरमेंट.
-h, --help कमांड पैरामीटर के लिए सहायता दिखाता है.
--insecure एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन को अनुमति दें.
-o, --org स्ट्रिंग (ज़रूरी है) एक Apigee संगठन. आपको संगठन का एडमिन होना चाहिए.
-r, --runtime स्ट्रिंग (सिर्फ़ प्राइवेट क्लाउड) से, आपके Private Cloud इंस्टेंस के लिए रनटाइम यूआरएल की जानकारी मिलती है.
-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 Edge के एन्क्रिप्ट (सुरक्षित) किए गए की-वैल्यू मैप (केवीएम) में सेव किए गए सार्वजनिक/निजी कुंजी के जोड़े को बदलना पड़े. कुंजी का नया जोड़ा जनरेट करने की इस प्रोसेस को की रोटेशन कहते हैं. कुंजियों को रोटेट करने पर, एक नया निजी/सार्वजनिक कुंजी का जोड़ा जनरेट होता है और आपके Apigee Edge के संगठन/एनवायरमेंट के "istio" केवीएम में सेव हो जाता है. इसके अलावा, पुरानी सार्वजनिक कुंजी को उसके मूल आईडी की वैल्यू के साथ बनाए रखा जाता है.

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

अगर आप Edge Public Cloud का इस्तेमाल कर रहे हैं, तो:
apigee-remote-service-cli token rotate-cert -c [config_file] -o [organization] -e [environment] -k [provision_key] -s [provision_secret] --kid [new_key_id]
अगर आप Edge प्राइवेट क्लाउड का इस्तेमाल कर रहे हैं:
apigee-remote-service-cli token rotate-cert -o [organization] -e [environment] -u [username] -p [password] -k [provision_key] -s [provision_secret] --kid [new_key_id]

पैरामीटर

पैरामीटर टाइप ब्यौरा
-c, --config स्ट्रिंग (ज़रूरी है) Apigee रिमोट सेवा की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, ज़्यादातर दूसरे कमांड पैरामीटर को हटाया जा सकता है. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से ले सकता है. --config विकल्प इस्तेमाल करना देखें.
-e, --env स्ट्रिंग (ज़रूरी है) आपके संगठन का एक एनवायरमेंट.
-h, --help कमांड पैरामीटर के लिए सहायता दिखाता है.
--insecure SSL का उपयोग करते समय असुरक्षित सर्वर कनेक्शन को अनुमति दें
--truncate int jwks में रखे जाने वाले सर्टिफ़िकेट की संख्या (डिफ़ॉल्ट 2)
-o, --org स्ट्रिंग (ज़रूरी है) एक Apigee संगठन. आपको संगठन का एडमिन होना चाहिए.
-r, --runtime स्ट्रिंग (सिर्फ़ प्राइवेट क्लाउड) से, आपके Private Cloud इंस्टेंस के लिए रनटाइम यूआरएल की जानकारी मिलती है.
-v, --verbose (ज़रूरी नहीं) वर्बोस आउटपुट देता है.

उदाहरण

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

आउटपुट

certificate successfully rotated

क्रेडेंशियल के लिए .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

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

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

apigee-remote-service-cli version

--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
  allow_unverified_ssl_cert: false
products:
  refresh_rate: 2m
analytics:
  legacy_endpoint: false
  file_limit: 1024
  send_channel_size: 10
  collection_interval: 10s
  fluentd_endpoint: apigee-udca-myorg-test.apigee.svc.cluster.local:20001
  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
auth:
  api_key_claim: claim
  api_key_cache_duration: 30m
  api_key_header: x-api-key
  api_target_header: :authority
  reject_unauthorized: true
  jwks_poll_interval: 0s