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

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

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

نظرة عامة

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

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

تتيح لك الأوامر cert تثبيت وإدارة زوج المفاتيح العام/الخاص المستخدَم لتوقيع الرموز المميّزة للحامل التي يستخدمها العملاء لإجراء مكالمات آمنة من خلال Edge Microgateway. يتم حفظ المفاتيح في 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 (اختياري) يحدد الاسم المستعار للمضيف الظاهري لمؤسستك:البيئة. يمكنك الاطّلاع على مستندات Edge لمعرفة المزيد عن المضيفين الافتراضيين. اللغة التلقائية: org-env.apigee.net
-c, --configDir (اختياري) يحدد المسار إلى ملف إعداد Edge Microgateway. يكون ملف الإعداد تلقائيًا هو ./config/config.yaml. (تمت إضافة الإصدار 2.4.x)
-x, --proxyName (اختياري) لضبط مسار القاعدة للخادم الوكيل edgemicro-auth إذا تم نشر الخادم الوكيل edgemicro-auth ضمن مسار مختلف عن المسار التلقائي، /edgemicro-auth، تتيح لك هذه الميزة ضبط المسار الجديد في Edge Microgateway. يكون مسار الأساس هو /edgemicro-auth تلقائيًا. (تمت إضافة الإصدار 2.4.x)
-t, --token (اختياري) يتيح لك استخدام رمز OAuth المميز للمصادقة بدلاً من اسم المستخدم/كلمة المرور. يُرجى الاطّلاع أيضًا على طلبات البيانات من واجهة برمجة التطبيقات الآمنة باستخدام رمز دخول OAuth2. مثلاً:

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

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

يخزِّن هذا الأمر معلومات الإعدادات في /.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]

المعلّمات

المَعلمات الوصف
-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 Microgateway.

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

مثال

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

ضبط إعدادات Edge Microgateway لخدمة 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 قائمة مفصولة بفواصل للمضيفين الافتراضيين لمؤسستك:environment. الإعداد التلقائي "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 Microgateway.

...

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

edgemicro configuration complete!

طريق مصغَّرة ضمن حافة الانطلاق

قبل بدء Edge Microgateway، عليك أولاً تشغيل Edgemicro Configuration (Public Cloud) أو edgemicro special setup (السحابة الإلكترونية الخاصة). يعرض الأمر Configuration قيم المفتاح والسرية المطلوبة لبدء تشغيل 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 تقريبًا. القيمة التلقائية: 8,000
-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 بتنسيق JSON JWT (Java Web Token) بتنسيق النص العادي. ينقل الرمز المميّز معلومات حول تطبيق المطوّر 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 مميز متوافق مع OAuth 2.0 (JWT). كما يتطلب إدخال قيم مفتاح العميل (معرّف العميل) وسر العميل (سر العميل) من تطبيق مطوّر برامج مسجَّل على 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 سر العميل من تطبيق المطوّر المرتبط بالوكيل الوكيل لـ 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) }

تهيئة إعداد جديد لـ Edge Microgateway

شغّل هذا الأمر مرة واحدة بعد تثبيت 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-auth، وتم نشره في مؤسسة 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 هو 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 للسحابة الإلكترونية العامة:

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

Edge لـ 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: مطلوبة.

مثال على 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 للسحابة الإلكترونية العامة:

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

Edge لـ 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: مطلوبة.

مثال على 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 أنّه تمت إضافة مفاتيح جديدة إلى مسار البوابة الصغيرة KVM.

مثال

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

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

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

استخدِم الأمر edgemicro forever لإدارة عملية Forever، وهي أداة Node.js تعيد تشغيل تطبيق Node.js تلقائيًا في حال تعطُّل التطبيق أو حدوث خطأ. راجِع أيضًا المراقبة الدائمة.

الاستخدام

يجب ضبط متغيّرات البيئة التالية قبل تنفيذ الأمر edgemicro forever:

  • EDGEMICRO_ORG - مؤسسة Apigee التي ضبطت لها Edge Microgateway.
  • EDGEMICRO_ENV - بيئة تم فيها ضبط Edge Microgateway.
  • EDGEMICRO_KEY - قيمة المفتاح التي تم عرضها عند تشغيل الأمر "edgemicro Configuration" (الضبط).
  • EDGEMICRO_SECRET: القيمة السرية التي تم عرضها عند تشغيل الأمر "edgemicro Configuration" (الضبط).
edgemicro forever -f [forever_file] -a [start|stop]

المعلّمات

المَعلمةالوصف
-f, --fileتحدِّد هذه السياسة موقع ملف forever.json.
-a, --actionإما start أو stop. ويكون الإعداد التلقائي هو start.

أمثلة:

للبدء إلى الأبد:

edgemicro forever -f ~/mydir/forever.json -a start

للإيقاف إلى الأبد:

edgemicro forever -a stop

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

استخدِم الأمر 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