مرجع واجهة سطر الأوامر (CLI) لـ Edge Microgateway

أنت تعرض مستندات Apigee Edge.
انتقل إلى مستندات Apigee X. معلومات

Edge Microgateway الإصدار 3.3.x

نظرة عامة

يتيح لك واجهة سطر الأوامر Microgateway التحكم في جميع جوانب بوابة Edge Microgateway وإدارتها مثال.

إدارة الشهادات

تتيح لك أوامر cert تثبيت مفتاحَي التشفير العام والخاص وإدارتهما. يُستخدم لتوقيع رموز الحامل المميزة التي يستخدمها العملاء لإجراء مكالمات آمنة من خلال Edge مدخل مصغّر. يتم تخزين المفاتيح على Apigee Edge في خريطة مشفّرة لقيم المفاتيح (KVM). تستخدم بوابة Edge Microgateway مفتاح عام لإثبات صحة رموز الحامل الموقَّعة. يتم إنشاء هذه المفاتيح عند تشغيل Edgemicro. تهيئة الأمر، كما هو موضح في قسم إعداد وإعداد Edge Microgateway يمكنك استخدام أوامر cert الموضّحة هنا. إذا لزم الأمر، لإعادة إنشاء هذه المفاتيح وإدارتها

تثبيت شهادة

تثبِّت المفاتيح في خريطة قيم مفتاح مشفّرة (KVM) وتعرض ملف المفتاح العام كإخراج. يتم تحديد أزواج المفاتيح في مؤسسة محدّدة.

الاستخدام

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

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت لها Edge Microgateway.
-e, --env بيئة ضبطت لها بوابة Edge Microgateway.
-u, --username اسم مستخدم Apigee. يجب أن تكون مشرف المؤسسة لما تم تحديده التنظيم.
-p, --password (اختياري) كلمة مرورك. سيُطلب منك في حال عدم تقديم هذه المَعلمة في سطر الأوامر.
-f, --force (اختياري) في حال تخزين مفتاح من قبل في KVM المشفر، يمكنك فرض استبداله.
-h, --help معلومات استخدام الإخراج

مثال

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

الناتج

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
password:
deleting vault
creating vault
adding private_key
adding public_key
installed cert

حذف شهادة

يؤدي هذا الإجراء إلى حذف مفتاحَي التشفير لمؤسسة.

الاستخدام

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

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت لها Edge Microgateway.
-e, --env بيئة ضبطت لها بوابة Edge Microgateway.
-u, --username اسم مستخدم Apigee. يجب أن تكون مشرف المؤسسة لما تم تحديده التنظيم.
-p, --password (اختياري) كلمة مرورك. سيُطلب منك في حال عدم تقديم هذه المَعلمة في سطر الأوامر.
-h, --help معلومات استخدام الإخراج

مثال

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]

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت لها Edge Microgateway.
-e, --env بيئة ضبطت لها بوابة Edge Microgateway.
-u, --username اسم مستخدم Apigee. يجب أن تكون مشرف المؤسسة لما تم تحديده التنظيم.
-p, --password (اختياري) كلمة مرورك. سيُطلب منك في حال عدم تقديم هذه المَعلمة في سطر الأوامر.
-h, --help معلومات استخدام الإخراج

مثال

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

الناتج (بنجاح)

checked cert successfully

الناتج (تعذُّر)

إذا لم تكن الشهادة موجودة، سيتم عرض خطأ.

الحصول على المفتاح العام

تعرض المفتاح العام للمؤسسة المحددة. لا يتطلب المصادقة.

الاستخدام

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

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت لها Edge Microgateway.
-e, --env بيئة ضبطت لها بوابة Edge Microgateway.
-h, --help معلومات استخدام الإخراج

مثال

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

إعداد بوابة Edge Microgateway في Apigee Edge Cloud

يعمل على تفعيل Edge Microgateway للعمل مع مثيل Apigee Edge Cloud. التفاف وتنفيذ سلسلة من الأوامر لنشر الخادم الوكيل المطلوب للمصادقة على Edge وإنشاء المصادقة والرموز المميزة، وتحديث ملفات التكوين. للاطلاع على مثال عمل كامل، راجع إعداد وإعداد Edge Microgateway

الاستخدام

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

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت لها Edge Microgateway.
-e, --env بيئة ضبطت لها بوابة Edge Microgateway.
-u, --username اسم مستخدم Apigee. يجب أن تكون مشرف المؤسسة لما تم تحديده التنظيم.
-p, --password (اختياري) كلمة مرورك. سيُطلب منك في حال عدم تقديم هذه المَعلمة في سطر الأوامر.
-r, --url (اختياري) تحدِّد هذه السياسة الاسم المستعار للمضيف الافتراضي الخاص بمؤسستك:environment. يمكنك الاطّلاع على وثائق Edge للتعرف على المضيفات الظاهرية. الإعداد التلقائي: org-env.apigee.net
-c, --configDir (اختياري) يحدد المسار إلى ملف إعداد Edge Microgateway. بشكل افتراضي، يكون ملف الإعداد في ./config/config.yaml. (تمت الإضافة الإصدار 2.4.x)
-x, --proxyName (اختياري) يتم ضبط المسار الأساسي للخادم الوكيل edgemicro-auth. إذا كانت تم نشر الخادم الوكيل edgemicro-auth ضمن مسار مختلف عن المسار التلقائي، /edgemicro-auth، تتيح لك هذه الميزة ضبط المسار الجديد في Edge مدخل مصغّر. يكون المسار الأساسي تلقائيًا هو /edgemicro-auth. (مضاف) v2.4.x)
-t, --token (اختياري) يسمح لك باستخدام رمز OAuth المميز للمصادقة بدلاً من اسم المستخدم/كلمة المرور. راجِع أيضًا طلبات بيانات من واجهة برمجة التطبيقات الآمنة باستخدام رمز الدخول OAuth2. مثال:

edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts (اختياري) لإلغاء المضيفات الافتراضية الافتراضية، وهي "default,secure". استخدم هذا الخيار إذا كانت لديك مضيفات افتراضية محددة لموقعك Edge organisation:environment آخر غير هذه الإعدادات التلقائية. اطلع على وثائق Edge والتعرف على المضيفات الظاهرية.
-d, --debug (اختياري) يتم تقديم معلومات تصحيح الأخطاء.
-h, --help معلومات استخدام الإخراج

ملاحظات الاستخدام

يخزن هذا الأمر معلومات التهيئة في /.edgemicro/org-env-config.yaml تقريبًا.

مثال

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

الناتج

بعد نجاح الأمر، يعرض الأمر مجموعة من المفاتيح التي تحتاج إلى استخدامها عند بدء تشغيل Edge مدخل مصغّر.

...

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]

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت لها Edge Microgateway.
-e, --env بيئة ضبطت لها بوابة Edge Microgateway.
-u, --username اسم مستخدم Apigee. يجب أن تكون مشرف المؤسسة لما تم تحديده التنظيم.
-p, --password (اختياري) كلمة مرورك. سيُطلب منك في حال عدم تقديم هذه المَعلمة في سطر الأوامر.
-t, --token (اختياري) يسمح لك باستخدام رمز OAuth المميز للمصادقة بدلاً من اسم المستخدم/كلمة المرور. راجِع أيضًا طلبات بيانات من واجهة برمجة التطبيقات الآمنة باستخدام رمز الدخول OAuth2. مثال:

edgemicro genkeys -o docs -e test -t <your token>
-h, --help معلومات استخدام الإخراج

ملاحظات الاستخدام

بعد النجاح، يعرض الأمر ثلاثة عناصر. الأول هو عنوان URL الذي يجب وضعه ملف التهيئة. الاثنين الآخران هما زوج مفاتيح مطلوبين عند تشغيل Edge. مثيل المدخل المصغّر.

  • عنوان URL لـ Bootstapp: يشير عنوان URL هذا إلى خدمة Apigee Edge التي تتيح مثيل Edge Microgateway لإرسال بيانات الإحصاءات إلى Apigee Edge عليك نسخ عنوان URL هذا. في ملف إعداد Edge Microgateway: ~/.edgemicro/org-env-config.yaml.
  • key: المفتاح. هذا المفتاح والسر مطلوبان كإدخال في واجهة سطر الأوامر المستخدم لبدء مثيل Edge Microgateway.
  • secret: السر.

مثال

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

الناتج (نموذج)

بعد نجاح الأمر، يعرض الأمر مجموعة من المفاتيح التي تحتاج إلى استخدامها عند بدء تشغيل Edge مدخل مصغّر.

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

إعداد بوابة Edge الصغيرة في Apigee Edge Private Cloud

تعمل هذه السياسة على ضبط Edge Microgateway للعمل مع تثبيت Apigee Edge Private Cloud.

الاستخدام

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

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت لها Edge Microgateway.
-e, --env بيئة ضبطت لها بوابة Edge Microgateway.
-u, --username اسم مستخدم Apigee. يجب أن تكون مشرف المؤسسة لما تم تحديده التنظيم.
-p, --password (اختياري) كلمة مرورك. سيُطلب منك في حال عدم تقديم هذه المَعلمة في سطر الأوامر.
-r, --runtime-url تُحدِّد هذه السياسة عنوان URL لبيئة التشغيل لمثيل السحابة الإلكترونية الخاص.
-m, --mgmt-url عنوان URL لخادم الإدارة لمثيل السحابة الإلكترونية الخاص بك.
-v, --virtualHosts قائمة مفصولة بفواصل للمضيفات الافتراضية لمؤسستك:بيئتك. الإعداد التلقائي "default,secure".
-c, --configDir (اختياري) يحدد المسار إلى ملف إعداد Edge Microgateway. بشكل افتراضي، يكون ملف الإعداد في ./config/config.yaml. (تمت الإضافة الإصدار 2.4.x)
-t, --token (اختياري) يسمح لك باستخدام رمز OAuth المميز للمصادقة بدلاً من اسم المستخدم/كلمة المرور. راجِع أيضًا طلبات بيانات من واجهة برمجة التطبيقات الآمنة باستخدام رمز الدخول OAuth2. مثال:

edgemicro configure -o docs -e test -t <your token>
-d, --debug (اختياري) يتم تقديم معلومات تصحيح الأخطاء.
-h, --help معلومات استخدام الإخراج

ملاحظات الاستخدام

يخزن هذا الأمر معلومات التهيئة في /.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 مدخل مصغّر.

...

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

edgemicro configuration complete!

بداية بوابة Edge الصغيرة

قبل بدء Edge Microgateway، يجب أولاً تشغيل إعداد Edgemicro. (السحابة الإلكترونية العامة) أو الإعداد الخاص في edgemicro (السحابة الإلكترونية الخاصة). تهيئة يؤدي الأمر إلى إرجاع قيم المفتاح والسرية المطلوبة لبدء بوابة Edge Microgateway.

الاستخدام

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

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت لها Edge Microgateway.
-e, --env بيئة ضبطت لها بوابة Edge Microgateway.
-k, --key قيمة المفتاح التي يتم عرضها عند تشغيل "edgemicro configure" الأمر.
-s, --secret القيمة السرية التي يتم عرضها عند تشغيل "edgemicro configure" الأمر.
-p, --processes (اختياري) عدد العمليات المراد البدء فيها. الإعداد التلقائي: عدد النوى في .
-d, --pluginDir (اختياري) المسار المطلق لدليل المكوّن الإضافي.
-r, --port (اختياري) لإلغاء رقم المنفذ المحدّد في ملف واحد (/.edgemicro/org-env-config.yaml) تقريبًا. القيمة التلقائية: 8000
-c, --cluster

(اختياري) يؤدي إلى تشغيل بوابة Edge Microgateway في وضع المجموعة.

ملاحظة: اعتبارًا من الإصدار 2.3.1، تمت إزالة هذا الخيار. في الإصدار 2.3.1 والإصدارات الأحدث، يبدأ Edge Micro دائمًا في وضع المجموعة.
-c, --configDir (اختياري) يحدد المسار إلى ملف إعداد Edge Microgateway. بشكل افتراضي، يكون ملف الإعداد في ./config/config.yaml. (تمت الإضافة الإصدار 2.4.x)
-u, --configUrl (اختياري) يحدد نقطة نهاية يتم من خلالها تنزيل إعدادات Edge Microgateway الملف. (تمت إضافة الإصدار 2.5.x)
-d, --debug (اختياري) يتم تقديم معلومات تصحيح الأخطاء.
-h, --help معلومات استخدام الإخراج

ضبط المنفذ

يتيح لك الأمر 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

عينة الناتج:

...

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
info: jwk_public_keys download from null returned 200 undefined
info: jwt_public_key download from https://docs-test.apigee.net/edgemicro-auth/publicKey returned 200 OK
info: products download from https://docs-test.apigee.net/edgemicro-auth/products returned 200 OK
info: config download from https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test returned 200 OK
PROCESS PID : 17991

إدارة الرموز المميزة

تتيح لك أوامر token الحصول على بروتوكول OAuth2 الموقَّع وفك ترميزه والتحقُّق منه. الرموز المميزة. راجع أيضًا طلبات البيانات الآمنة من واجهة برمجة التطبيقات باستخدام رمز الدخول OAuth2

فك ترميز رمز مميّز

فك ترميز رمز حامل مُوقَّع ومشفّر إلى رمز JSON JWT بالنص العادي (رمز Java للويب) التمثيل المناسب. ينقل الرمز المميز معلومات حول تطبيق مطوّري برامج Apigee Edge الذي قدم المستخدمة لإنشاء الرمز المميز، بما في ذلك اسم التطبيق، وclient_id، وقائمة المنتجات، وغيرها.

الاستخدام

edgemicro token decode -f [filename]

المعلّمات

المعلمات الوصف
-f, --file اسم ملف يحتوي على رمز JWT المميز لفك ترميزه
-h, --help معلومات استخدام الإخراج

مثال

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. الرمز المميّز هو رمز JSON المميّز للويب (JWT) المتوافق مع OAuth 2.0. يتطلب الأمر أدخل قيم مفتاح العميل (معرِّف العميل) وسر العميل (سر العميل) من ملف مطوّر البرامج على Apigee Edge. راجع أيضًا طلبات البيانات الآمنة من واجهة برمجة التطبيقات باستخدام رمز الدخول OAuth2

الاستخدام

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

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت لها Edge Microgateway.
-e, --env بيئة ضبطت لها بوابة Edge Microgateway.
-1, --key معرِّف العميل الوارد من تطبيق المطوِّر المرتبط ببطاقة Microgateway الخادم الوكيل.
-s, --secret سر العميل (Client Secret) المتوفّر في تطبيق المطوِّر المرتبط ببطاقة Microgateway الخادم الوكيل.
-h, --help معلومات استخدام الإخراج

مثال

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

يمكنك أيضًا إنشاء JWT باستخدام واجهة برمجة تطبيقات الإدارة:

curl -i -X POST "http://$ORG-$ENV.apigee.net/edgemicro-auth/token" \
  -H "Content-Type: application/json" \
  -d '{
    "$CLIENT_ID": "your consumer key",
    "$CLIENT_SECRET": "your consumer secret",
    "grant_type": "client_credentials"
  }'

المكان:

  • $ORG هو اسم مؤسسة Edge (يجب أن تكون مشرف مؤسسة).
  • $ENV هي بيئة في مؤسستك (مثل "test" أو "prod").
  • $CLIENT_ID هو رقم تعريف المستهلك في تطبيق المطوِّر الذي أنشأته سابقًا.
  • "$CLIENT_SECRET" هو سر المستهلك في تطبيق المطوّر الذي أنشأته. مسبقًا.

إثبات صحة رمز مميّز

التحقُّق من رمز الحامل المُوقَّع مقابل المفتاح العام المخزن في Apigee Edge للنطاق المحدَّد التنظيم والبيئة.

الاستخدام

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

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت لها Edge Microgateway.
-e, --env بيئة ضبطت لها بوابة Edge Microgateway.
-f, --file اسم ملف يحتوي على JWT المطلوب التحقّق منه
-h, --help معلومات استخدام الإخراج

مثال

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

جارٍ إعداد ضبط بوابة Microgateway جديدة على Edge

شغّل هذا الأمر مرة واحدة بعد تثبيت Edge Microgateway لأول مرة. تنشئ لغة تلقائية جديدة ملف الإعداد: ~/.edgemicro/default.yaml.

الاستخدام

edgemicro init

المعلّمات

المعلمات الوصف
-c, --configDir (اختياري) يحدد المسار إلى ملف إعداد Edge Microgateway. بشكل افتراضي، يكون ملف الإعداد في ./config/config.yaml. (تمت الإضافة الإصدار 2.4.x)
-h, --help معلومات استخدام الإخراج

مثال

edgemicro init

الناتج (بنجاح)

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

الناتج (بنجاح)

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

التحقق من حالة مجموعة المدخل الدقيق

بشكل افتراضي، تبدأ بوابة Edge Microgateway في وضع المجموعة. يمكنك استخدام هذا الأمر للتحقق من حالة المجموعة العنقودية.

الاستخدام

edgemicro status

المعلّمات

المعلمات الوصف
-h, --help معلومات استخدام الإخراج

مثال

edgemicro status

الناتج (بنجاح)

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
edgemicro is running with 8 workers

إيقاف مجموعة المدخل الصغير

يؤدي هذا الاختصار إلى إيقاف مجموعة Edge Microgateway.

الاستخدام

edgemicro stop

المعلّمات

المعلمات الوصف
-h, --help معلومات استخدام الإخراج

مثال

edgemicro stop

الناتج (بنجاح)

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
Stop Completed Successfully

إعادة تحميل مجموعة المدخل الصغير

تتيح هذه السياسة إعادة تشغيل الجهاز بعد تغيير الإعدادات. يعيد تحميل بوابة Edge Microgateway عبر سحب تهيئة جديدة.

الاستخدام

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

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت لها Edge Microgateway.
-e, --env بيئة ضبطت لها بوابة Edge Microgateway.
-k, --key قيمة المفتاح التي يتم عرضها عند تشغيل "edgemicro configure" الأمر.
-s, --secret القيمة السرية التي يتم عرضها عند تشغيل "edgemicro configure" الأمر.
-h, --help معلومات استخدام الإخراج

مثال

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

الناتج (بنجاح)

...

Reload Completed Successfully

جارٍ ترقية الخادم الوكيل لمصادقة Edgemicro

لاستخدام ميزة تدوير المفاتيح، يجب أن تكون لديك ترقية. الخادم الوكيل مصادقة Edgemicro وتم نشره في مؤسسة Apigee Edge. (تمت إضافة الإصدار 2.5.x)

ملاحظة: في حال ضبط مثيل Edge Micro الحالي من قبل 2.5.2، فيجب ترقية هذا الخادم الوكيل إذا كنت تريد استخدام تغيير المفاتيح. ما عليك سوى إجراء هذه الترقية مرة واحدة.

الاستخدام

edgemicro upgradeauth -o [organization] -e [environment] -u [username]

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت لها Edge Microgateway.
-e, --env بيئة ضبطت لها بوابة Edge Microgateway.
-u, --username اسم مستخدم Apigee. يجب أن تكون مشرف المؤسسة لما تم تحديده التنظيم.
-p, --password (اختياري) كلمة مرورك. سيُطلب منك في حال عدم تقديم هذه المَعلمة في سطر الأوامر.
-v, --virtualhost (اختياري) المضيف الافتراضي للخادم الوكيل
-b, --baseuri (اختياري) معرّف الموارد المنتظم (URI) الأساسي لمؤسستك في Apigee Edge. الإعداد التلقائي هو القاعدة معرّف الموارد المنتظم (URI) لعمليات نشر Apigee Cloud هو api.enterprise.apigee.com. بالنسبة إلى عمليات النشر داخل المؤسسة وقد يختلف عنوان URL الأساسي.

مثال

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

الناتج (بنجاح)

بعد نجاح الأمر، يعرض الأمر مخرجات مشابهة للنتائج التالية:

Going to create revision 2 of API edgemicro-auth
Using /Users/jdoe/npm/lib/node_modules/edgemicro/node_modules/microgateway-edgeauth/apiproxy/edgemicro-auth.xml as the root file
Creating revision 2 of API edgemicro-auth
Uploading java resource micro-gateway-products-javacallout-2.0.0.jar
Uploading jsc resource generate-verify-jwt.js
Uploading jsc resource send-public-key.js
Uploading jsc resource set-jwt-variables.js
Uploading jsc resource set-response.js
Uploading node resource index.js
Uploading node resource node_modules_apigee-access.zip
Uploading node resource node_modules_base64url.zip
Uploading node resource node_modules_buffer-equal-constant-time.zip
Uploading node resource node_modules_ecdsa-sig-formatter.zip
Uploading node resource node_modules_jsrsasign.zip
Uploading node resource node_modules_jwa.zip
Uploading node resource node_modules_jws.zip
Uploading node resource node_modules_safe-buffer.zip
Uploading node resource package.json
Uploading policy Access-App-Info-2.xml
Uploading policy Access-App-Info.xml
Uploading policy AccessTokenRequest.xml
Uploading policy Add-Custom-Claims.xml
Uploading policy Create-OAuth-Request.xml
Uploading policy Create-Refresh-Request.xml
Uploading policy Extract-API-Key.xml
Uploading policy Extract-OAuth-Params.xml
Uploading policy Extract-Refresh-Params.xml
Uploading policy Get-Private-Key.xml
Uploading policy Get-Public-Key.xml
Uploading policy Get-Public-Keys.xml
Uploading policy JavaCallout.xml
Uploading policy Products-to-JSON-2.xml
Uploading policy Products-to-JSON.xml
Uploading policy Raise-Fault-Unknown-Request.xml
Uploading policy RefreshAccessToken.xml
Uploading policy Send-Public-Key.xml
Uploading policy Set-JWT-Variables.xml
Uploading policy Set-Response.xml
Uploading policy Verify-API-Key.xml
Uploading target TargetEndpoint-1
Uploading proxy default
Deploying revision 2 of edgemicro-auth to test
Deployment on test successful
edgemicro-auth proxy upgraded

ترقية خريطة القيم الرئيسية (KVM)

استخدِم الأمر edgemicro upgradekvm لترقية KVM في Apigee التنظيم. تلزم ترقية KVM إذا كنت تريد استخدام تدوير المفتاح.

الاستخدام

Edge for Public Cloud: 

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

Edge for Private Cloud: 

edgemicro private upgradekvm -o [organization] -e [environment] -k [key] -s [secret] -p 'https://[hostname]/edgemicro-auth'

المعلّمات

المعلمات الوصف
-o, --org مؤسسة Apigee التي ضبطت لها Edge Microgateway.
-e, --env بيئة ضبطت لها بوابة Edge Microgateway.
-k, --key قيمة المفتاح التي يتم عرضها عند تشغيل "edgemicro configure" الأمر.
-s, --secret القيمة السرية التي يتم عرضها عند تشغيل "edgemicro configure" الأمر.
-p, --proxyuri معرّف الموارد المنتظم (URI) للخادم الوكيل Edgemicro_auth

Edge Public Cloud: اختياري.
Edge Private Cloud: مطلوبة.

مثال على Edge Public Cloud: 

 -p 'https://[org]-[env].apigee.net/edgemicro-auth'

مثال على Edge Private Cloud: 

-p 'https://[hostname]/edgemicro-auth'

مثال

edgemicro upgradekvm -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

الناتج (بنجاح)

بعد نجاح الأمر، يعرض الأمر مخرجات مشابهة للنتائج التالية:

current nodejs version is v12.5.0
current edgemicro version is 3.1.5
password:
Checking for certificate...
Certificate found!
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT6yVoT/h6pvkPlkUUtv
Hgs7MbDPcWxto7dZqJBwQ4oOQ0IJ2P4XGigc3kYUyPp5lFHg1ssP9+0onRpqn6Lq
z7N5iaTSv5YXb26bU2kSOl4hbwcljIzauAnBzQ13VaQ5SoflRxMGSZmTqZeu5jkQ
3JZ7F6k2bCar5sk1k84vd4WXcCVyngFlrMtlux5z0vOU56QYZFvvKYl/wOHNPLLB
Js54531CV1ZfhV3nDDq9Lh5D1C/oQVlm1Lc7BJoEUmKeFATmSsi50c14ScsmdtJ1
HqC/brSXCd185P6ifu2RH7IHKzNfcD4NlfAVmDScng4w5RxBan2avbmAJrokQ4b5
WQIDAQAB
-----END PUBLIC KEY-----
KVM update complete

تدوير المفاتيح

استخدام الأمر edgemicro rotatekey لتغيير أزواج المفاتيح العامة/الخاصة التي استُخدمت لإنشاء رموز JWT المميزة المستخدمة في أمان OAuth على Edge Microgateway.

لمزيد من المعلومات، راجع تدوير مفاتيح JWT

الاستخدام

Edge for Public Cloud: 

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

Edge for Private Cloud: 

edgemicro private rotatekey -o [organization] -e [environment] -k [key] -s [secret] -r '[hostname]/edgemicro-auth/rotateKey'

المعلّمات

المعلمات الوصف
-o, --org (مطلوب) مؤسسة Apigee التي ضبطت لها Edge Microgateway.
-e, --env (مطلوب) بيئة تم فيها تهيئة Edge Microgateway.
-k, --key قيمة المفتاح التي يتم عرضها عند تشغيل "edgemicro configure" الأمر.
-s, --secret القيمة السرية التي يتم عرضها عند تشغيل "edgemicro configure" الأمر.
-p المسار إلى مفتاح خاص مخصّص لاستخدامه في Apigee Edge (تمت الإضافة 3.1.6)
-c المسار إلى شهادة مخصَّصة ليتم استخدامه من خلال Apigee Edge (تمت الإضافة 3.1.6)
-n, --nbf

ضبط المهلة بالدقائق لكي يصبح المفتاح الخاص الجديد ساريًا. هذا النمط حيث يتيح التأخير وقتًا لتحديث مثيلات المدخل الدقيق مع الجمهور الجديد المفتاح. من الممارسات الجيدة ضبط المهلة لتكون أكثر من إعداد ضبط config_change_poll_internal، وهي 10 دقائق افتراضيًا. لمزيد من المعلومات، راجع تهيئة "ليس قبل" تأخير. (تمت الإضافة 3.1.6)

ملاحظة: إذا كنت تستخدم هذا الخيار مع إصدارات edgemicro-auth الأقدم من الإصدار الموزع باستخدام Edge Microgateway 3.1.6، يتم تجاهل العلامة.

-i, --kid (اختياري) رقم تعريف يُستخدَم لمطابقة مفتاح معيّن. تستخدم Edge Microgateway هذه القيمة الاختيار من بين مجموعة من المفاتيح أثناء تدوير المفاتيح. إذا حُذفت هذه المَعلمة (يُنصح بذلك)، ينشئ Edge Microgateway مفتاحًا مستندًا إلى الطابع الزمني. لمزيد من المعلومات، راجع القسم 4.5 من مواصفات مفتاح الويب JSON.
-r, --rotatekeyuri تدوير معرِّف الموارد المنتظم (URI) للمفتاح.

Edge Public Cloud: اختياري.
Edge Private Cloud: مطلوبة.

مثال على Public Cloud: 

-r 'https://[org]-[env].apigee.net/edgemicro-auth/rotateKey'

مثال على Edge Private Cloud: 

-r '[hostname]/edgemicro-auth/rotateKey'

مثال

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

الناتج (بنجاح)

بعد نجاح الأمر، يعرض الأمر مخرجات مشابهة للنتائج التالية:

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
password:
Checking if private key exists in the KVM...
Checking for certificate...
Found Certificate
Generating New key/cert pair...
Extract new public key
Key Rotation successfully completed!

بعد التدوير، يمكنك أن ترى في واجهة مستخدم Edge أنه تمت إضافة مفاتيح جديدة إلى المدخل المصغّر آلة متجه الدعم

مثال

يستخدم هذا المثال العلامتين -p و-c لتحديد المسار. إلى زوج مفتاح خاص/شهادة. تتيح لك هذه الخيارات ضبط مفتاح خاص وشهادة مخصّصَين. زوج. 

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47 \
-p /users/home/keys.pem -c /users/home/cert.cert

المراقبة الدائمة

إبطال المفاتيح

استخدِم الأمر edgemicro revokekeys لإبطال بيانات الاعتماد الرئيسية والسرّية لـ إعدادات Edge Microgateway.

الاستخدام

edgemicro revokekeys -o [organization] -e [environment] -u [username]
-k [key] -s [secret]

المعلّمات

المعلمات الوصف
-o, --org (مطلوب) مؤسسة Apigee التي ضبطت لها Edge Microgateway.
-e, --env (مطلوب) بيئة تم فيها تهيئة Edge Microgateway.
-u, --username (يجب تحديد إما -u أو -t) اسم المستخدم في Apigee. يجب أن تكون مشرف المؤسسة لما تم تحديده التنظيم. هذه المَعلمة غير مطلوبة في حال تحديد المَعلمة -t بدلاً من ذلك.
-p, --password (اختياري) كلمة مرورك. سيُطلب منك في حال عدم تقديم هذه المَعلمة في سطر الأوامر.
-k, --key (مطلوب) المفتاح المطلوب إبطاله.
-s, --secret (مطلوب) المفتاح السرّي للإبطال.
-t, --token (يجب توفير -u أو -t) يسمح لك هذا الخيار باستخدام رمز OAuth المميز للمصادقة بدلاً من اسم المستخدم/كلمة المرور. إذا تم تحديد -t، لن تكون المعلَمة -u مطلوبة. راجِع أيضًا طلبات بيانات من واجهة برمجة التطبيقات الآمنة باستخدام رمز الدخول OAuth2. على سبيل المثال: 
edgemicro revokekeys -o ORG-NAME -e ENV-NAME -k KEY-TO-REVOKE \
    -s KEY-SECRET -t TOKEN

أمثلة

edgemicro revokekeys -o myorg -e test -u jdoe@apigee.com
-k 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f -s 4b5d6355b874f7c46838893823e8d929dcb2e42fb9aebcb535089c9b98513

بعد النجاح، ستظهر لك الرسالة التالية:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully