एज माइक्रोगेटवे के लिए सीएलआई रेफ़रंस

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

खास जानकारी

Edge Microgateway CLI की मदद से, Edge Microgateway इंस्टेंस के सभी पहलुओं को कंट्रोल और मैनेज किया जा सकता है.

सर्टिफ़िकेट मैनेज करना

cert कमांड की मदद से, सार्वजनिक या निजी पासकोड के उस जोड़े को इंस्टॉल और मैनेज किया जा सकता है जिसका इस्तेमाल, ऐसे बियरर टोकन पर हस्ताक्षर करने के लिए किया जाता है. इन टोकन का इस्तेमाल क्लाइंट, Edge Microgateway के ज़रिए सुरक्षित कॉल करने के लिए करते हैं. कुंजियां, Apigee Edge पर सुरक्षित वॉल्ट में सेव की जाती हैं. Edge Microgateway, साइन किए गए बियरर टोकन की पुष्टि करने के लिए सार्वजनिक पासकोड का इस्तेमाल करता है. ये कुंजियां, edgemicro configure कमांड चलाने पर जनरेट होती हैं. इनके बारे में Edge Microgateway को सेट अप और कॉन्फ़िगर करना लेख में बताया गया है. अगर ज़रूरी हो, तो इन कुंजियों को फिर से जनरेट करने और मैनेज करने के लिए, यहां दी गई cert कमांड का इस्तेमाल किया जा सकता है. 

कोई सर्टिफ़िकेट इंस्टॉल करें

यह Apigee Edge की सुरक्षित स्टोर सेवा का इस्तेमाल करके, वॉल्ट में कुंजियां इंस्टॉल करता है. साथ ही, सार्वजनिक पासकोड को आउटपुट के तौर पर दिखाता है. कुंजी के जोड़े, किसी संगठन के लिए तय किए जाते हैं.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro cert install -o [organization] -e [environment] -u [username] -p [password] --force

पैरामीटर

उदाहरण

edgemicro cert install -o docs -e test -u jdoe@example.com -f

आउटपुट

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
password:
deleting vault
creating vault
adding private_key
adding public_key
installed cert

सर्टिफ़िकेट मिटाना

संगठन के लिए पासकोड का जोड़ा मिटाता है.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro cert delete -o [organization] -e [environment] -u [username] -p [password]

पैरामीटर

उदाहरण

edgemicro cert delete -o docs -e test -u jdoe@example.com 

आउटपुट

deleting vault
Vault deleted!

किसी सर्टिफ़िकेट की जांच करना

इस कुकी से यह पता चलता है कि आपके संगठन के पास इंस्टॉल किया गया सर्टिफ़िकेट है या नहीं.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro cert check -o [organization] -e [environment] -u [username] -p [password]

पैरामीटर

उदाहरण

edgemicro cert check -o docs -e test -u jdoe@example.com

Output (Success)

checked cert successfully

आउटपुट (विफल)

अगर सर्टिफ़िकेट मौजूद नहीं है, तो गड़बड़ी का मैसेज दिखता है.

सार्वजनिक पासकोड पाना

यह फ़ंक्शन, किसी संगठन के लिए सार्वजनिक पासकोड दिखाता है. इसके लिए, पुष्टि करने की ज़रूरत नहीं है.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro cert public-key -o [organization] -e [environment]

पैरामीटर

उदाहरण

edgemicro cert public-key -o docs -e test

आउटपुट (सैंपल)

-----BEGIN CERTIFICATE----- 

MIICpDCCAYwCCQCKpXWGum9uTjANBgkq9w0BAQsFADAUMRIwEAYDVQQDEwls
b2NhbGhvc3cNMTYxMTAyMjAxNTA2WhcNMTYxMTAzMjAxNTA2WjAUMRIwEAYD
VQQDEwlsb2Nvc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDD
ETr/ne/gP47+9LgjLvBJjpbFVdaeUabZZ3wbA7sSIVnnNXWt3yPklrWSfIh+
L2+dq4k+YunsQE2+dwPdXA2x8DPGvqGcCdWPxnpZ7ix5Akbs8i/J+Ue0pXT4
jkpWbaDDftGL2tcxwP45yI+slpDYvmWRps07TFXkAPjGEHYPvCT9/v/35GkL
0h4v0S+XfpcjS5c47o7CIWlkgEM5GBosQUb17kuVR48392vGFPsnCP34iNe7
zguhiCXYg2zkOcj/N3AE4xKIhCz0QcewULy08GltWMmyjJ/30zs8P41JqoA4
RwfeEZ8RenN3rJQim1ppAAEwDQYJKoZIhvcNAQELBQADggEBAHcORIfc+ySe
2FMmqicNe6Wt5V/5zOaBMLsGQdqGOHB5cQc79sMBrk680KVhrwHXZ2nBIkVe
UEL+2qLY1VLfswBNAvcNwV9U4TwHq4eIANiD751oJK1tHmM/ujThQkwNf96o
6I7Ws+wfpGO3ppJCttRbtnATIxrwsCHN4i5lbW/tJSL7t/Zf6T1B+YSJU9AF
xuvLq22cCqyYJQdmKq2vVS55WRZdllm+mRtJrv7MLM9gfDPRxVlwrBz/eQHy
Fv+dwzxcvQjkz03RNhZUodzuD34DPJoYeK++rItsddwQ26KTahH80yYTAFzY
x9gfPf1/+qo=? 

-----END CERTIFICATE-----

Apigee Edge Cloud के लिए Edge Microgateway को कॉन्फ़िगर करना

इस कुकी की मदद से, Edge Microgateway को Apigee Edge Cloud इंस्टेंस के साथ काम करने की अनुमति मिलती है. यह Edge पर ज़रूरी पुष्टि करने वाली प्रॉक्सी को डिप्लॉय करने, पुष्टि करने वाले टोकन जनरेट करने, और कॉन्फ़िगरेशन फ़ाइलों को अपडेट करने के लिए, कमांड के क्रम को रैप करता है और उन्हें लागू करता है. काम करने वाले पूरे उदाहरण के लिए, Edge Microgateway को सेट अप और कॉन्फ़िगर करना लेख पढ़ें.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro configure -o [organization] -e [environment] -u [username] -p [password]

पैरामीटर

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

यह कमांड, कॉन्फ़िगरेशन की जानकारी को ~/.edgemicro/org-env-config.yaml में सेव करती है.

उदाहरण

edgemicro configure -o docs -e test -u jdoe@example.com

आउटपुट

सर्टिफ़िकेट जनरेट होने के बाद, यह कमांड कुंजियों का एक सेट दिखाती है. Edge Microgateway शुरू करते समय, आपको इन कुंजियों का इस्तेमाल करना होगा.

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

कुंजियां जनरेट की जा रही हैं

genkeys कमांड, कुंजी और सीक्रेट जोड़ा जनरेट करती है. इसका इस्तेमाल Edge Microgateway, Apigee Edge पर एसिंक्रोनस तरीके से आंकड़ों का डेटा पोस्ट करते समय खुद की पुष्टि करने के लिए करता है.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro genkeys -o [organization] -e [environment] -u [username] -p [password]

पैरामीटर

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

यह कमांड पूरी होने पर, तीन आइटम दिखते हैं. पहला एक यूआरएल है, जिसे आपको कॉन्फ़िगरेशन फ़ाइल में डालना होगा. अन्य दो, मुख्य जोड़ी हैं. Edge Microgateway इंस्टेंस शुरू करते समय इनकी ज़रूरत होती है.

• बूटस्ट्रैप यूआरएल: यह यूआरएल, Apigee Edge की उस सेवा की ओर ले जाता है जो Edge Microgateway इंस्टेंस को Apigee Edge पर Analytics डेटा भेजने की सुविधा देती है. आपको उस यूआरएल को Edge Microgateway की कॉन्फ़िगरेशन फ़ाइल में कॉपी करना होगा: ~/.edgemicro/org-env-config.yaml.
• key: कुंजी. इस कुंजी और सीक्रेट की ज़रूरत, Edge Microgateway का इंस्टेंस शुरू करने के लिए इस्तेमाल की जाने वाली सीएलआई कमांड के इनपुट के तौर पर होती है.
• secret: सीक्रेट.

उदाहरण

edgemicro genkeys -o docs -e test -u jdoe@example.com

आउटपुट (सैंपल)

सर्टिफ़िकेट जनरेट होने के बाद, यह कमांड कुंजियों का एक सेट दिखाती है. Edge Microgateway शुरू करते समय, आपको इन कुंजियों का इस्तेमाल करना होगा.

configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1
Please copy the following property to the edge micro agent config
  bootstrap: https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/jdoe/environment/test

The following credentials are required to start edge micro
  key: db39324077989c75eac34c13d285772ea8e3b982b957b3f52916f3048511443f
  secret: 5bf8da39de0056f88fdd5f25a8602d22f312c1c8c870580a5fef55ac6637b7ae

finished

Apigee Edge Private Cloud के लिए Edge Microgateway को कॉन्फ़िगर करना

यह कुकी, Edge Microgateway को Apigee Edge Private Cloud इंस्टॉलेशन के साथ काम करने के लिए कॉन्फ़िगर करती है.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro private configure -o [organization] -e [environment] -u [username] -p [password]

पैरामीटर

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

यह कमांड, कॉन्फ़िगरेशन की जानकारी को ~/.edgemicro/org-env-config.yaml में सेव करती है.

उदाहरण

edgemicro private configure -o docs -e test -u jdoe@example.com -r http://192.162.55.100:9002 -m http://192.162.55.100:8080

आउटपुट

सर्टिफ़िकेट जनरेट होने के बाद, यह कमांड कुंजियों का एक सेट दिखाती है. Edge Microgateway शुरू करते समय, आपको इन कुंजियों का इस्तेमाल करना होगा.

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

Edge Microgateway शुरू किया जा रहा है

Edge Microgateway शुरू करने से पहले, आपको सबसे पहले edgemicro configure (Public Cloud) या edgemicro private configure (Private Cloud) कमांड चलानी होगी. configure कमांड, कुंजी और सीक्रेट वैल्यू दिखाती है. Edge Microgateway को शुरू करने के लिए इनकी ज़रूरत होती है.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro start -o [organization] -e [environment] -k [public-key] -s [secret-key]

पैरामीटर

पोर्ट सेट करना

start कमांड की मदद से, कॉन्फ़िगरेशन फ़ाइल में दिए गए पोर्ट को बदलने के लिए पोर्ट नंबर तय किया जा सकता है. PORT एनवायरमेंट वैरिएबल का इस्तेमाल करके, पोर्ट नंबर भी तय किया जा सकता है. उदाहरण के लिए:

edgemicro start -o docs -e test -k abc123 -s xyz456 -p 2 --port 8002

या

export PORT=8002 
edgemicro start -o org -e test -k key -s secret -p 2

अगर पोर्ट का इस्तेमाल किया जा रहा है, तो Edge Microgateway गड़बड़ी का मैसेज दिखाता है.

क्लस्टरिंग के बारे में जानकारी

Edge Microgateway, क्लस्टरिंग की सुविधा चालू करने के लिए Node.js क्लस्टर मॉड्यूल का इस्तेमाल करता है. क्लस्टरिंग की मदद से, Edge Microgateway मल्टी-कोर सिस्टम का फ़ायदा उठा सकता है. ज़्यादा जानकारी के लिए, यह Node.js दस्तावेज़ देखें. 

उदाहरण

edgemicro start -o docs -e test -k abc123 -s xyz456

आउटपुट का उदाहरण:

...

PROCESS PID : 54709
installed plugin from analytics
installed plugin from analytics
installed plugin from oauth
installed plugin from oauth
installed plugin from analytics
installed plugin from oauth
5a86b570-a142-11e6-aa1f-6730e9065d6c edge micro listening on port 8000
5a86dc80-a142-11e6-962c-43d9cc723190 edge micro listening on port 8000
5a8751b0-a142-11e6-8241-cf1c517c91eb edge micro listening on port 8000
installed plugin from analytics
installed plugin from oauth
5a924e30-a142-11e6-8740-2944162ce275 edge micro listening on port 8000

टोकन मैनेज करना

token कमांड की मदद से, हस्ताक्षर किए गए OAuth2 ऐक्सेस टोकन हासिल किए जा सकते हैं. साथ ही, उन्हें डिकोड और पुष्टि की जा सकती है. OAuth2 ऐक्सेस टोकन की मदद से, एपीआई कॉल को सुरक्षित करना लेख भी पढ़ें. 

किसी टोकन को डिकोड करना

यह हस्ताक्षर किए गए और एन्कोड किए गए बियरर टोकन को, सामान्य टेक्स्ट वाले JSON JWT (Java Web Token) में डिकोड करता है. टोकन से, Apigee Edge डेवलपर ऐप्लिकेशन के बारे में जानकारी मिलती है. इस ऐप्लिकेशन ने टोकन बनाने के लिए इस्तेमाल की गई कुंजियां दी हैं. इसमें ऐप्लिकेशन का नाम, client_id, प्रॉडक्ट की सूची वगैरह शामिल है.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro token decode -f [filename]

पैरामीटर

उदाहरण

edgemicro token decode -f token.jwt

आउटपुट (नमूना)

{ header: { typ: 'JWT', alg: 'RS256' },

  payload:
   { application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',
     client_id: 'O9ZQRZKnn1rdgcKQgsABSMdOsKS',
     scopes: [],
     api_product_list: [ 'MicroTest' ],
     iat: 1436280566,
     exp: 1436282365 },
  signature: '' }

टोकन जनरेट करना

यह फ़ंक्शन, हस्ताक्षर किया गया बियरर टोकन जनरेट करता है. इस टोकन की मदद से क्लाइंट ऐप्लिकेशन, Edge Microgateway को पुष्टि की गई एपीआई कॉल कर सकते हैं. यह टोकन, OAuth 2.0 के मुताबिक JSON वेब टोकन (JWT) है. इसके लिए, Apigee Edge पर रजिस्टर किए गए डेवलपर ऐप्लिकेशन से, उपभोक्ता कुंजी (क्लाइंट आईडी) और उपभोक्ता सीक्रेट (क्लाइंट सीक्रेट) की वैल्यू इनपुट के तौर पर ज़रूरी होती हैं. OAuth2 ऐक्सेस टोकन की मदद से, एपीआई कॉल को सुरक्षित करना लेख भी पढ़ें.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro token get -o [org] -e [env] -i [client_id] -s [client_secret]

पैरामीटर

उदाहरण

edgemicro token get -o docs -e test -i 5UzOwAXGoOeo60aew94PPG5MAZE3aJp -s 6vahKFGS9a3qMLwz

आउटपुट (नमूना)

{ token: 'eyJ0eXAiOiJKV1JhbGciOiJSUzI1NiJ9Glvbl9uYW1lIjoiNWNiMGY0NTV6TV3
EtOWMzOC00YmJjLWIzNzEtZGMxZTQzOGMxIiwiY2xpZW50X2lkIjoiNVV6T3dBWEdvSU9lbz
YwYWV3OTRQN0c1TUFaRTNhSnAiLCJzY2MiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIkVkZ2
VNaWNyb1Rlc3RQcm9kdWN0Il0sImlhdCI3ODEyMzQ2MSwiZXhwIjoxNDc4MTI1MjYwfQ.Dx5
f5U7PXm8koNGmFX4N6VrxKMJnpndKgoJ5zWSJvBZ6Ccvhlpd85ipIIA5S2A5nx4obYWp_rpY
RJpIGYwyxP6Oq2j0rxnVjdCC4qyYMgthZjhKgEBVBe3s1ndP72GP2vV6PsSA9RQ2-yzsy9r0
TzhAZ3NJTxT1tS0XKqKngE-OhR3fJHVLAzdMDT0AmS9H0Z2NAJtQOuK6RTpCjG9B6Bc48AEM
sj7QSM-1LWiQ8LdY8k_BoC06qsTI7bCQGWwTuqL-ismbcx2bxovUxSemZIaoROfuF-dCZHG3
2aTP75WxBvvNgBBvPvQtPzbeSOtEaww' }

टोकन पाने के लिए एचटीटीपी अनुरोध करना

टोकन पाने के लिए, रॉ एचटीटीपी अनुरोध भी किया जा सकता है. यहां curl का एक उदाहरण दिया गया है. यूआरएल में, अपने संगठन और एनवायरमेंट के नाम बदलें. साथ ही, client_id और client_secret पैरामीटर के लिए, उपभोक्ता आईडी और उपभोक्ता सीक्रेट की वैल्यू बदलें:

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

टोकन की पुष्टि करना

यह फ़ंक्शन, हस्ताक्षर किए गए बियरर टोकन की पुष्टि करता है. इसके लिए, यह दिए गए संगठन और एनवायरमेंट के लिए Apigee Edge पर सेव की गई सार्वजनिक कुंजी का इस्तेमाल करता है.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro token verify -o [org] -e [env] -f [filename]

पैरामीटर

उदाहरण

edgemicro token get -o docs -e test -f token.jwt

मान्य टोकन के लिए सैंपल आउटपुट

{ application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

अमान्य टोकन के लिए सैंपल आउटपुट

{ [JsonWebTokenError: invalid token] name: 'JsonWebTokenError', message: 'invalid token' }

समयसीमा खत्म हो चुके टोकन के लिए सैंपल आउटपुट

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

  expiredAt: Tue Jul 07 2015 09:19:25 GMT-0600 (MDT) }

सीधे तौर पर बियरर टोकन पाना

Apigee Edge पर टोकन एंडपॉइंट को एचटीटीपी अनुरोध भेजकर, सीधे तौर पर बियरर टोकन पाए जा सकते हैं. असल टोकन एंडपॉइंट, उस प्रॉक्सी में लागू किया जाता है जिसे deploy-edge-service सीएलआई कमांड के साथ डिप्लॉय किया जाता है.

यहां curl का एक उदाहरण दिया गया है. यूआरएल में, अपनी संस्था और एनवायरमेंट के नाम डालें. साथ ही, Apigee Edge पर डेवलपर ऐप्लिकेशन से मिले Consumer Id और Consumer Secret की वैल्यू को client_id और client_secret पैरामीटर के लिए डालें:

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

आउटपुट का उदाहरण:

HTTP/1.1 200 OK

X-Powered-By: Express

Cache-Control: no-store

Pragma: no-cache

Content-Type: application/json; charset=utf-8

Content-Length: 640

ETag: W/"280-ze/g/k+c9taqp110vjYQ"

Date: Fri, 17 07 2015 15:49:24 GMT

Connection: keep-alive

"<long string of numbers and letters>"

Edge Microgateway के नए कॉन्फ़िगरेशन को शुरू किया जा रहा है

Edge Microgateway को पहली बार इंस्टॉल करने के बाद, इस कमांड को एक बार चलाएं. यह डिफ़ॉल्ट कॉन्फ़िगरेशन फ़ाइल बनाता है: ~/.edgemicro/default.yaml.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro init 

पैरामीटर

उदाहरण

edgemicro init

Output (Success)

config initialized to /MyHome/.edgemicro/default.yaml

Edge Microgateway के कॉन्फ़िगरेशन की पुष्टि करना

इस कुकी से यह पुष्टि होती है कि Edge Microgateway को सही तरीके से कॉन्फ़िगर किया गया है.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro verify -o [organization] -e [environment] -k [public-key] -s [secret-key]

पैरामीटर

उदाहरण

edgemicro verify -o docs -e test -k abc123 -s xyz456

Output (Success)

logging to /var/tmp/edgemicro-My-Machine.local-a0c48610-a148-11e6-8466-93f081b05988
installed plugin from analytics
installed plugin from oauth
a0c48610-a148-11e6-8466-93f081b05988 edge micro listening on port 8000
verifying analytics negative case: OK
verifying bootstrap url availability:OK
verifying jwt_public_key availability: OK
verifying products availability: OK
verifying quota with configured products: OK
verifying analytics with payload: OK
verification complete

माइक्रोगेटवे क्लस्टर की स्थिति देखना

जोड़ा गया: v2.2.4-beta

Edge Microgateway, डिफ़ॉल्ट रूप से क्लस्टर मोड में शुरू होता है. क्लस्टर का स्टेटस देखने के लिए, इस निर्देश का इस्तेमाल किया जा सकता है.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro status

पैरामीटर

उदाहरण

edgemicro status

Output (Success)

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
edgemicro is running with 4 workers

माइक्रोगेटवे क्लस्टर को बंद करना

जोड़ा गया: v2.2.4-beta

इस कमांड से Edge Microgateway क्लस्टर बंद हो जाता है.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro stop

पैरामीटर

उदाहरण

edgemicro stop

Output (Success)

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
Stop Completed Successfully

माइक्रोगेटवे क्लस्टर को फिर से लोड करना

जोड़ा गया: v2.2.4-beta

कॉन्फ़िगरेशन में बदलाव करने के बाद, बिना किसी रुकावट के रीस्टार्ट करने की सुविधा देता है. यह कुकी, नए कॉन्फ़िगरेशन को पुल करके Edge Microgateway को फिर से लोड करती है.

इस्तेमाल किए जाने से जुड़ी जानकारी

edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]

पैरामीटर

उदाहरण

edgemicro reload -o docs -e test -k abc123 -s xyz456

Output (Success)

...

Reload Completed Successfully