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

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

खास जानकारी

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

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

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

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

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

आउटपुट (सफल)

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 माइक्रोगेटवे को कॉन्फ़िगर करना

Apigee Edge क्लाउड इंस्टेंस के साथ काम करने के लिए, Edge Microgateway को चालू करता है. यह 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!

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

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

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

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

पैरामीटर

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

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

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

उदाहरण

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 के निजी क्लाउड के लिए Edge माइक्रोगेटवे कॉन्फ़िगर करना

Apigee Edge के निजी क्लाउड इंस्टॉलेशन के साथ काम करने के लिए, Edge माइक्रोगेटवे को कॉन्फ़िगर करता है.

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

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 को शुरू करने से पहले, आपको पहले Edgemicro कॉन्फ़िगर (Public Cloud) या Edgemicro निजी कॉन्फ़िगर (प्राइवेट क्लाउड) चलाना होगा. कॉन्फ़िगर करने का निर्देश, 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 माइक्रोगेटवे, मल्टी-कोर सिस्टम का फ़ायदा ले सकता है. ज़्यादा जानकारी के लिए, यह 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' }

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

टोकन पाने के लिए, एचटीटीपी अनुरोध भी किया जा सकता है. यहां कर्ल का एक उदाहरण दिया गया है. बस यूआरएल में अपने संगठन और एनवायरमेंट के नामों को बदल दें और उपभोक्ता आईडी और ग्राहक की गोपनीय वैल्यू को 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 पर, टोकन एंडपॉइंट के लिए एचटीटीपी अनुरोध करके, सीधे तौर पर बेयरर टोकन पाने का विकल्प चुना जा सकता है. असल टोकन एंडपॉइंट को उस प्रॉक्सी में लागू किया जाता है जिसे डिप्लॉय-एज-सेवा सीएलआई कमांड के साथ डिप्लॉय किया गया है.

यहां कर्ल का एक उदाहरण दिया गया है. बस, यूआरएल में अपने संगठन और एनवायरमेंट के नाम बदलें और Apigee Edge पर डेवलपर ऐप्लिकेशन से मिली उपभोक्ता आईडी और उपभोक्ता की सीक्रेट वैल्यू को 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

आउटपुट (सफल)

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

Edge माइक्रोगेटवे कॉन्फ़िगरेशन की पुष्टि की जा रही है

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

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

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

पैरामीटर

उदाहरण

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

आउटपुट (सफल)

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-बीटा

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

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

edgemicro status

पैरामीटर

उदाहरण

edgemicro status

आउटपुट (सफल)

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

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

जोड़ा गया: v2.2.4-बीटा

Edge माइक्रोगेटवे क्लस्टर को बंद करता है.

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

edgemicro stop

पैरामीटर

उदाहरण

edgemicro stop

आउटपुट (सफल)

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

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

जोड़ा गया: v2.2.4-बीटा

कॉन्फ़िगरेशन में बदलाव के बाद, ज़ीरो-डाउनटाइम रीस्टार्ट देता है. नया कॉन्फ़िगरेशन इस्तेमाल करके, Edge माइक्रोगेटवे को फिर से लोड करता है.

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

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

पैरामीटर

उदाहरण

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

आउटपुट (सफल)

...

Reload Completed Successfully