संदर्भ

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

apigee-remote-service-cli कमांड लाइन इंटरफ़ेस (सीएलआई) आपकी मदद करता है Envoy के लिए 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 Private Cloud के लिए:

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

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

पैरामीटर

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

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

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 एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन को अनुमति दें
--legacy अगर Apigee Edge Cloud का इस्तेमाल किया जा रहा है, तो यह फ़्लैग सेट करें. यह मैनेजमेंट और रनटाइम यूआरएल को सेट करता है इस्तेमाल करें.
--mfa Apigee के कई तरीकों से पुष्टि करने वाला टोकन (सिर्फ़ --legacy के साथ इस्तेमाल किया जाता है)
--opdk अगर प्राइवेट क्लाउड के लिए Apigee Edge का इस्तेमाल किया जा रहा है, तो यह फ़्लैग सेट करें.
-o, --org स्ट्रिंग (ज़रूरी है) Apigee संगठन. आपको संगठन का एडमिन होना ज़रूरी है.
-r, --runtime स्ट्रिंग (सिर्फ़ प्राइवेट क्लाउड) आपके प्राइवेट क्लाउड इंस्टेंस के लिए रनटाइम यूआरएल की जानकारी देता है.
-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 का इस्तेमाल किया जा रहा है, तो यह फ़्लैग सेट करें. यह मैनेजमेंट और रनटाइम यूआरएल को सेट करता है इस्तेमाल करें.
--mfa Apigee के कई तरीकों से पुष्टि करने वाला टोकन (सिर्फ़ --legacy के साथ इस्तेमाल किया जाता है)
-m, --management स्ट्रिंग अगर Apigee Private Cloud का इस्तेमाल किया जा रहा है, तो यह ज़रूरी है. आपके Apigee मैनेजमेंट का बेस यूआरएल. डिफ़ॉल्ट: https://api.enterprise.apigee.com
-n, --namespace स्ट्रिंग बताए गए नेमस्पेस में, Envoy ConfigMap के तौर पर कॉन्फ़िगरेशन को कॉन्फ़िगर करें. डिफ़ॉल्ट: apigee
--opdk स्ट्रिंग Apigee ओपीडीके.
-o, --organization स्ट्रिंग (ज़रूरी है) आपका Apigee संगठन. आपको संगठन का एडमिन होना ज़रूरी है.
-p, --password स्ट्रिंग आपका Apigee पासवर्ड, सिर्फ़ बुनियादी पुष्टि के लिए ज़रूरी है. आपके पास .netrc फ़ाइल में पासवर्ड डालने का विकल्प होता है. ऐसा करने पर, आपको कमांड लाइन पर अपना पासवर्ड डालने की ज़रूरत नहीं होगी. इन्हें भी देखें क्रेडेंशियल के लिए .netrc का इस्तेमाल करना.
--rotate-int int अगर n > 0, नई निजी कुंजी जनरेट करें और n सार्वजनिक कुंजियां रखें (सिर्फ़ हाइब्रिड)
-r, --runtime स्ट्रिंग (सिर्फ़ प्राइवेट क्लाउड) आपके प्राइवेट क्लाउड इंस्टेंस के लिए रनटाइम यूआरएल की जानकारी देता है.
-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 (वैकल्पिक) प्रावधान में उपयोग किए गए SSL प्रमाणपत्र से पहले के सालों की संख्या समय-सीमा खत्म. डिफ़ॉल्ट: 1

उदाहरण

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

अगर आप 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

टोकन कमांड

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

इस्तेमाल

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

उदाहरण

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

आउटपुट

certificate successfully rotated

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

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

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

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

apigee-remote-service-cli version

--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
  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