أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى
مستندات Apigee X. info
تساعدك apigee-remote-service-cli واجهة سطر الأوامر (CLI) في توفير وإدارة "محوّل Apigee" لـ Envoy.
أمر ربط القائمة
أدرِج جميع منتجات واجهة برمجة التطبيقات المرتبطة بالخدمة البعيدة.
الاستخدام
apigee-remote-service-cli bindings list [flags]
المعلمات
| المعلمات | التواجد في المنزل | الاستخدام مع المنتجات | الوصف |
|---|---|---|---|
-c,
|
مطلوب | الكل | (سلسلة) مسار ملف إعداد "الخدمة البعيدة" في Apigee ملاحظة: تتيح لك هذه العلامة إغفال معظم مَعلمات الأوامر الأخرى، لأنّ واجهة سطر الأوامر يمكنها استردادها مباشرةً من ملف الإعداد. راجِع مقالة استخدام الخيار ‑‑config.
|
-e,
|
مطلوب | الكل | (سلسلة) بيئة في مؤسستك |
-h,
|
اختياري | الكل | تعرض هذه السمة معلومات المساعدة حول مَعلمات الأمر. |
‑‑insecure
|
اختياري | الكل | السماح بالاتصالات غير الآمنة بالخادم عند استخدام طبقة المقابس الآمنة |
‑‑legacy
|
مطلوب | Edge Public Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for Public Cloud. تضبط هذه السمة عناوين URL الخاصة بالإدارة ووقت التشغيل في Apigee Edge Public Cloud. |
-m,
|
مطلوب | Edge Private Cloud فقط | (سلسلة) عنوان URL الأساسي للإدارة في عملية تثبيت Apigee Edge for Private Cloud.
عناوين URL التلقائية: https://api.enterprise.apigee.com
|
‑‑mfa
| مطلوب | Edge Public Cloud فقط | (سلسلة) رمز المصادقة المتعدّدة العوامل في Apigee Edge for Public Cloud. مطلوب فقط إذا تم إعداد المصادقة المتعدّدة العوامل في حسابك على Apigee Edge. |
‑‑opdk
| مطلوب | Edge Private Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for Private Cloud. |
-o,
|
مطلوب | الكل | (سلسلة) مؤسسة Apigee يجب أن تكون مشرف مؤسسة. |
-p,
|
مطلوب (المصادقة الأساسية فقط) |
Edge Public and Private Cloud فقط | (سلسلة) كلمة مرور Apigee. يمكنك اختياريًا تحديد كلمة المرور في ملف .netrc. يُرجى الاطّلاع أيضًا على
استخدام ملف .netrc لبيانات الاعتماد.
|
-r,
|
مطلوب | Edge Private Cloud وApigee hybrid فقط | (سلسلة) تحدّد عنوان URL لوقت التشغيل الخاص بالسحابة الإلكترونية الخاصة أو نسخة Apigee المختلطة.
يجب أن يبدأ عنوان URL بـ https://. على سبيل المثال: https://apitest.apigee-hybrid-docs.net
|
|
اختياري | Edge Private Cloud فقط | (سلسلة) تحدّد شهادة TLS من جهة العميل والمفتاح الخاص ومرجع التصديق الجذر لاتصال mTLS. |
-t,
|
مطلوب (مصادقة رمز OAuth المميز فقط) |
الكل | (سلسلة) رمز مميز لبروتوكول OAuth أو SAML تنشئه من معلومات حسابك على Apigee. تتجاوز أي بيانات اعتماد أخرى تم تقديمها. |
-u,
|
مطلوب (المصادقة الأساسية فقط) |
Edge Public and Private Cloud فقط |
(سلسلة) اسم مستخدم Apigee (عادةً ما يكون عنوان بريد إلكتروني)
يمكنك اختياريًا تحديد اسم المستخدم في ملف .netrc. في هذه الحالة، لن يُطلب منك تقديم اسم المستخدم في سطر الأوامر. يُرجى الاطّلاع أيضًا على استخدام ملف .netrc لبيانات الاعتماد.
|
-v,
|
اختياري | الكل | (اختياري) لإنشاء ناتج تفصيلي |
مثال
apigee-remote-service-cli bindings list -o myorg -e test -u user@example.com \ -c config.yaml -p abc123
مثال على الناتج
PI Products
============
Bound
-----
envoy-test:
Quota: 5 requests every 1 minute
Target bindings:
httpbin.org
Paths:
httpbin:
Quota: 5 requests every 1 minute
Target bindings:
httpbin.org
Paths:
/httpbin
/
Unbound
-------
product-1:
Quota: 100 requests every 1 hour
product-2:
Quota: 1000 requests every 1 month
product-3:
product-4:
أمر المساعدة
تتوفّر مساعدة على الإنترنت لجميع أوامر apigee-remote-service-cli. ما عليك سوى كتابة:
apigee-remote-service-cli help
للحصول على مساعدة بشأن أي أمر، اكتب:
apigee-remote-service-cli [command] help
على سبيل المثال:
apigee-remote-service-cli provision help
أمر توفير المتطلبات اللازمة
يؤدي الأمر apigee-remote-service-cli provision إلى تثبيت خادمي وكيل لواجهة برمجة التطبيقات في مؤسستك على Apigee
Edge، وإعداد شهادة، وإنشاء بيانات اعتماد ستحتاج إليها
لضبط Apigee Adapter for Envoy.
الاستخدام
apigee-remote-service-cli provision [flags]
المعلمات
| المعلمات | التواجد في المنزل | الاستخدام مع المنتجات | الوصف |
|---|---|---|---|
‑‑analytics-sa
|
اختياري | Apigee hybrid وApigee X فقط |
(سلسلة) استخدِم هذا الخيار لتحديد مسار ملف مفتاح حساب الخدمة على Google Cloud، حيث يكون لحساب الخدمة الدور |
-c,
|
مطلوب | الكل | (سلسلة) مسار ملف إعداد "الخدمة البعيدة" في Apigee ملاحظة: تتيح لك هذه العلامة إغفال معظم مَعلمات الأوامر الأخرى، لأنّ واجهة سطر الأوامر يمكنها استردادها مباشرةً من ملف الإعداد. راجِع مقالة استخدام الخيار ‑‑config.
|
-e,
|
مطلوب | الكل | (سلسلة) بيئة في مؤسستك |
-f, ‑‑force-proxy-install
|
اختياري | الكل | (اختياري) يفرض إعادة تثبيت وكيل remote-service إذا كان مثبّتًا في مؤسستك.
|
-h,
|
اختياري | الكل | تعرض هذه السمة معلومات المساعدة حول مَعلمات الأمر. |
‑‑insecure
|
اختياري | الكل | السماح بالاتصالات غير الآمنة بالخادم عند استخدام طبقة المقابس الآمنة |
‑‑legacy
|
مطلوب | Edge Public Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for Public Cloud. تضبط هذه السمة عناوين URL الخاصة بالإدارة ووقت التشغيل في Apigee Edge Public Cloud. |
-m,
|
مطلوب | Edge Private Cloud فقط | (سلسلة) عنوان URL الأساسي للإدارة في عملية تثبيت Apigee Edge for Private Cloud.
عناوين URL التلقائية: https://api.enterprise.apigee.com
|
‑‑mfa
| مطلوب | Edge Public Cloud فقط | رمز المصادقة المتعدّدة العوامل لخدمة "Apigee Edge للسحابة الإلكترونية العامة" مطلوب فقط إذا تم إعداد المصادقة المتعدّدة العوامل في حسابك على Apigee Edge. |
-n, ‑‑namespace
|
اختياري | الكل | (سلسلة) إصدار الإعدادات كـ Envoy ConfigMap في مساحة الاسم المحدّدة عناوين URL التلقائية: apigee
|
‑‑opdk
| مطلوب | Edge Private Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for Private Cloud. |
-o,
|
مطلوب | الكل | (سلسلة) مؤسسة Apigee يجب أن تكون مشرف مؤسسة لتوفير الخدمة. |
-p,
|
مطلوب (المصادقة الأساسية فقط) |
Edge Public and Private Cloud فقط | (سلسلة) كلمة مرور Apigee. يمكنك اختياريًا تحديد كلمة المرور في ملف .netrc. في هذه الحالة، لن يُطلب منك تقديم كلمة المرور في سطر الأوامر. يُرجى الاطّلاع أيضًا على
استخدام ملف .netrc لبيانات الاعتماد.
|
‑‑rotate-int
|
اختياري | Apigee Hybrid فقط | (عدد صحيح) إذا كان n > 0، يتم إنشاء مفتاح خاص جديد والاحتفاظ بـ n مفتاح عام (في الوضع المختلط فقط) |
-r,
|
مطلوب | Edge Private Cloud وApigee hybrid فقط | (سلسلة) تحدّد عنوان URL لوقت التشغيل الخاص بالسحابة الإلكترونية الخاصة أو نسخة Apigee المختلطة.
يجب أن يبدأ عنوان URL بـ https://. على سبيل المثال: https://apitest.apigee-hybrid-docs.net
|
|
اختياري | Edge Private Cloud فقط | (سلسلة) تحدّد شهادة TLS من جهة العميل والمفتاح الخاص ومرجع التصديق الجذر لاتصال mTLS. |
-t,
|
مطلوب (مصادقة رمز OAuth المميز فقط) |
الكل | (سلسلة) رمز مميز لبروتوكول OAuth أو SAML تنشئه من معلومات حسابك على Apigee. تتجاوز أي بيانات اعتماد أخرى تم تقديمها. |
-u,
|
مطلوب (المصادقة الأساسية فقط) |
Edge Public and Private Cloud فقط |
(سلسلة) اسم مستخدم Apigee (عادةً ما يكون عنوان بريد إلكتروني)
يمكنك اختياريًا تحديد اسم المستخدم في ملف .netrc. يُرجى الاطّلاع أيضًا على استخدام ملف .netrc لبيانات الاعتماد.
|
-v,
|
اختياري | الكل | (اختياري) لإنشاء ناتج تفصيلي |
‑‑virtual-hosts
|
اختياري | Edge Private Cloud فقط | (سلسلة) تتجاهل المضيفات الافتراضية التلقائية، وهي default,secure. استخدِم هذا الخيار إذا كانت لديك مضيفات افتراضية محدّدة لبيئة مؤسسة Edge غير هذه الإعدادات التلقائية.
|
مثال
كما يوضّح المثال التالي، من المهم تسجيل ناتج الأمر provision في ملف يتم استخدامه كإدخال لعمليات أخرى في Apigee Adapter for Envoy.
مثال:
apigee-remote-service-cli provision --legacy --mfa $MFA --username $USER --password $PASSWORD \ --organization $ORG --environment $ENV > config.yaml
أمر "العيّنات"
ينشئ هذا الأمر ملفات إعداد نموذجية ويدرجها.
إنشاء ملفات إعداد نموذجية
تُنشئ هذه الأداة ملفات إعداد نموذجية لعمليات نشر Envoy وIstio الأصلية.
الاستخدام
apigee-remote-service-cli samples create [flags]
الوصف
يتطلّب هذا الأمر ملف config.yaml صالحًا كإدخال. ملف الإدخال هذا هو الملف الذي تم إنشاؤه من خلال عملية التوفير.
يتم تلقائيًا إخراج الملفات النموذجية إلى دليل باسم ./samples. ينشئ الأمر
هذا الدليل لك.
إذا كنت تستخدم Envoy الأصلي، يأخذ الأمر مضيف الخدمة المستهدَفة والاسم المطلوب للمجموعة. يضبط أيضًا اتصال طبقة المقابس الآمنة المخصّص من خادم Envoy الوكيل إلى مجموعة الخدمات البعيدة إذا تم توفير مجلد يحتوي على tls.key وtls.crt من خلال --tls.
إذا كنت تستخدم Istio، حيث يعمل خادم Envoy الوكيل كحاوية جانبية، وفي حال عدم تحديد الهدف، سيتم إنشاء المثال httpbin. وفي ما عدا ذلك، تكون أنت المسؤول عن إعداد ملفات الإعدادات المرتبطة بنشر الخدمات المستهدَفة.
المعلمات
| المعلمات | التواجد في المنزل | الاستخدام مع المنتجات | الوصف |
|---|---|---|---|
‑‑adapter‑host
|
مطلوب لنماذج Envoy فقط | الكل | (سلسلة) اسم مضيف المحوّل (القيمة التلقائية: localhost)
|
-c, ‑‑config
|
مطلوب | الكل | (سلسلة) مسار ملف إعداد "الخدمة البعيدة" في Apigee ملاحظة: تتيح لك هذه العلامة إغفال معظم مَعلمات الأوامر الأخرى، لأنّ واجهة سطر الأوامر يمكنها استردادها مباشرةً من ملف الإعداد. راجِع مقالة استخدام الخيار ‑‑config.
|
-f, ‑‑force
|
اختياري | الكل | فرض استبدال الدليل الحالي |
-h, ‑‑help
|
اختياري | الكل | تعرض هذه السمة معلومات المساعدة حول مَعلمات الأمر. |
‑‑host |
مطلوب لنماذج Envoy فقط | الكل | (سلسلة) مضيف الخدمة المستهدَف (القيمة التلقائية httpbin.org)
|
-n, ‑‑name |
مطلوب | الكل | (سلسلة) اسم الخدمة المستهدَفة (القيمة التلقائية هي httpbin.org)
|
‑‑out
|
اختياري | الكل | (سلسلة) الدليل الذي سيتم فيه إنشاء ملفات الإعداد النموذجية القيمة التلقائية: ./samples
|
‑‑tag
|
مطلوب لنماذج Istio فقط | الكل | (سلسلة) علامة إصدار صورة Envoy Adapter. عناوين URL التلقائية: v2.0.0
|
-t, ‑‑template
|
مطلوب | الكل | (سلسلة) اسم نموذج Envoy أو Istio. للاطّلاع على قائمة النماذج المتاحة، نفِّذ الأمر
apigee-remote-service samples templates.
|
‑‑tls
|
اختياري، لنماذج Envoy فقط | الكل | (سلسلة) الدليل الذي يحتوي على الملفَين tls.key وtls.crt
المستخدَمَين لخدمة المحوّل
|
مثال
apigee-remote-service-cli samples create -c ./config.yaml
عرض خيارات النماذج المتاحة
تعرض هذه السمة قائمة بالنماذج المتاحة للاستخدام مع المَعلمة --templates للأمر samples.
الاستخدام
apigee-remote-service-cli samples templates
المعلمات
بلا عُري
مثال
apigee-remote-service-cli samples templates
Supported templates (native is deprecated): envoy-1.15 envoy-1.16 envoy-1.17 istio-1.7 istio-1.8 istio-1.9
أوامر الرموز المميّزة
يمكنك استخدام رمز JWT المميّز لإجراء طلبات مصادقة من خلال خادم وكيل لواجهة برمجة التطبيقات بدلاً من استخدام مفتاح واجهة برمجة التطبيقات. تتيح لك أوامر الرموز المميزة إنشاء رموز JWT المميزة وفحصها وتدويرها لهذا الغرض.
إنشاء رمز JWT
يمكنك استخدام رمز JWT المميز لإجراء طلبات مصادقة من خلال خادم وكيل لواجهة برمجة التطبيقات إلى هدف خدمة بعيد. يمكنك الاطّلاع أيضًا على استخدام المصادقة المستندة إلى JWT.الاستخدام
apigee-remote-service-cli token create [flags]
المعلمات
| المعلمات | التواجد في المنزل | الاستخدام مع المنتجات | الوصف |
|---|---|---|---|
-c,
|
مطلوب | الكل | (سلسلة) مسار ملف إعداد "الخدمة البعيدة" في Apigee ملاحظة: تتيح لك هذه العلامة إغفال معظم مَعلمات الأوامر الأخرى، لأنّ واجهة سطر الأوامر يمكنها استردادها مباشرةً من ملف الإعداد. راجِع مقالة استخدام الخيار ‑‑config.
|
-e,
|
مطلوب | الكل | (سلسلة) بيئة في مؤسستك |
-h,
|
اختياري | الكل | تعرض هذه السمة معلومات المساعدة حول مَعلمات الأمر. |
--i, --id
|
مطلوب | الكل | (سلسلة) بيانات اعتماد المفتاح التي تم العثور عليها في تطبيق المطوّر على Apigee كما هو موضّح في كيفية الحصول على مفتاح واجهة برمجة التطبيقات |
‑‑insecure
|
اختياري | الكل | السماح بالاتصالات غير الآمنة بالخادم عند استخدام طبقة المقابس الآمنة |
‑‑legacy
|
مطلوب | Edge Public Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for Public Cloud. تضبط هذه السمة عناوين URL الخاصة بالإدارة ووقت التشغيل في Apigee Edge Public Cloud. |
‑‑opdk
| مطلوب | Edge Private Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for Private Cloud. |
-o,
|
مطلوب | الكل | (سلسلة) مؤسسة Apigee يجب أن تكون مشرف مؤسسة. |
-r,
|
مطلوب | Edge Private Cloud وApigee hybrid فقط | (سلسلة) تحدّد عنوان URL لوقت التشغيل الخاص بالسحابة الإلكترونية الخاصة أو نسخة Apigee المختلطة.
يجب أن يبدأ عنوان URL بـ https://. على سبيل المثال: https://apitest.apigee-hybrid-docs.net
|
--s, ‑‑secret
|
مطلوب | الكل | (سلسلة) بيانات اعتماد الرمز السري التي تم العثور عليها في تطبيق المطوِّر على Apigee كما هو موضّح في كيفية الحصول على مفتاح واجهة برمجة التطبيقات |
|
اختياري | Edge Private Cloud فقط | (سلسلة) تحدّد شهادة TLS من جهة العميل والمفتاح الخاص ومرجع التصديق الجذر لاتصال mTLS. |
-v,
|
اختياري | الكل | (اختياري) لإنشاء ناتج تفصيلي |
مثال
apigee-remote-service-cli token create -o myorg -e test -i YUmlZAcBKNsTAelJqPZFl3sh58ObATX9 \ -s icTARgaKHqvUH1dq -c config.yaml
الناتج
عند النجاح، ستظهر لك نتيجة رمز JST المميز مشابهة لما يلي:eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q
فحص رمز JWT
يمكنك فحص رمز JWT المميز باستخدام هذا الأمر. اطّلِع أيضًا على فحص رمز مميّز.الاستخدام
apigee-remote-service-cli token inspect [flags]
المعلمات
المعلمات
| المعلمات | التواجد في المنزل | الاستخدام مع المنتجات | الوصف |
|---|---|---|---|
-c,
|
مطلوب | الكل | (سلسلة) مسار ملف إعداد "الخدمة البعيدة" في Apigee ملاحظة: تتيح لك هذه العلامة إغفال معظم مَعلمات الأوامر الأخرى، لأنّ واجهة سطر الأوامر يمكنها استردادها مباشرةً من ملف الإعداد. راجِع مقالة استخدام الخيار ‑‑config.
|
-e,
|
مطلوب | الكل | (سلسلة) بيئة في مؤسستك |
-f,
|
مطلوب | الكل | (سلسلة) ملف الرمز المميّز (القيمة التلقائية: استخدام stdin)
|
-h,
|
اختياري | الكل | تعرض هذه السمة معلومات المساعدة حول مَعلمات الأمر. |
‑‑insecure
|
اختياري | الكل | السماح بالاتصالات غير الآمنة بالخادم عند استخدام طبقة المقابس الآمنة |
‑‑legacy
|
مطلوب | Edge Public Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for Public Cloud. تضبط هذه السمة عناوين URL الخاصة بالإدارة ووقت التشغيل في Apigee Edge Public Cloud. |
‑‑opdk
| مطلوب | Edge Private Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for Private Cloud. |
-o,
|
مطلوب | الكل | (سلسلة) مؤسسة Apigee يجب أن تكون مشرف مؤسسة. |
-r,
|
مطلوب | Edge Private Cloud وApigee hybrid فقط | (سلسلة) تحدّد عنوان URL لوقت التشغيل الخاص بالسحابة الإلكترونية الخاصة أو نسخة Apigee المختلطة.
يجب أن يبدأ عنوان URL بـ https://. على سبيل المثال: https://apitest.apigee-hybrid-docs.net
|
|
اختياري | Edge Private Cloud فقط | (سلسلة) تحدّد شهادة TLS من جهة العميل والمفتاح الخاص ومرجع التصديق الجذر لاتصال mTLS. |
-v,
|
اختياري | الكل | (اختياري) لإنشاء ناتج تفصيلي |
مثال
apigee-remote-service-cli token inspect -c config.yaml <<< $TOKEN
الناتج
عند النجاح، ستظهر لك نتيجة مشابهة لما يلي:
{
"aud": [
"remote-service-client"
],
"exp": 1591741549,
"iat": 1591740649,
"iss": "https://apigee-docs-test.apigee.net/remote-service/token",
"jti": "99325d2e-6440-4278-9f7f-b252a1a79e53",
"nbf": 1591740649,
"access_token": "VfzpXzBGAQ07po0bPMKY4JgQjus",
"api_product_list": [
"httpbin"
],
"application_name": "httpbin",
"client_id": "GYDGHy5TRpV8AejXCOlreP7dPVepA8H",
"developer_email": "user@example.com",
"scope": ""
}
verifying...
token ok.
تدوير رمز JWT
في وقت ما بعد إنشاء رمز JWT في البداية، قد تحتاج إلى تغيير زوج المفتاح العام/الخاص المخزَّن بواسطة Apigee في خريطة المفتاح/القيمة (KVM) المشفّرة. تُعرف عملية إنشاء زوج مفاتيح جديد باسم "تغيير المفتاح". عند تدوير المفاتيح، يتم إنشاء زوج مفاتيح خاص/عام جديد وتخزينه في KVM "istio" في مؤسسة/بيئة Apigee. بالإضافة إلى ذلك، يتم الاحتفاظ بالمفتاح العام القديم مع قيمة معرّف المفتاح الأصلي.الاستخدام
apigee-remote-service-cli token rotate-cert [flags]
المعلمات
| المعلمات | التواجد في المنزل | الاستخدام مع المنتجات | الوصف |
|---|---|---|---|
-c,
|
مطلوب | الكل | (سلسلة) مسار ملف إعداد "الخدمة البعيدة" في Apigee ملاحظة: تتيح لك هذه العلامة إغفال معظم مَعلمات الأوامر الأخرى، لأنّ واجهة سطر الأوامر يمكنها استردادها مباشرةً من ملف الإعداد. راجِع مقالة استخدام الخيار ‑‑config.
|
-e,
|
مطلوب | الكل | (سلسلة) بيئة في مؤسستك |
-h,
|
اختياري | Edge Public and Private Cloud فقط | تعرض هذه السمة معلومات المساعدة حول مَعلمات الأمر. |
--k, --key
|
مطلوب | Edge Public and Private Cloud فقط | (سلسلة) مفتاح التوفير |
‑‑insecure
|
اختياري | Edge Public and Private Cloud فقط | السماح بالاتصالات غير الآمنة بالخادم عند استخدام طبقة المقابس الآمنة |
‑‑legacy
|
مطلوب | Edge Public Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for Public Cloud. تضبط هذه السمة عناوين URL الخاصة بالإدارة ووقت التشغيل في Apigee Edge Public Cloud. |
‑‑opdk
| مطلوب | Edge Private Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for Private Cloud. |
-o,
|
مطلوب | Edge Public and Private Cloud فقط | (سلسلة) مؤسسة Apigee يجب أن تكون مشرف مؤسسة. |
-r,
|
مطلوب | Edge Private Cloud فقط | (سلسلة) تحدّد عنوان URL لوقت التشغيل الخاص بالسحابة الإلكترونية الخاصة أو نسخة Apigee المختلطة.
يجب أن يبدأ عنوان URL بـ https://. على سبيل المثال: https://apitest.apigee-hybrid-docs.net
|
--s, ‑‑secret
|
مطلوب | الكل | (سلسلة) تمثّل بيانات الاعتماد الخاصة بالتوفير. |
|
اختياري | Edge Private Cloud فقط | (سلسلة) تحدّد شهادة TLS من جهة العميل والمفتاح الخاص ومرجع التصديق الجذر لاتصال mTLS. |
--t, ‑‑truncate
|
مطلوب | الكل | (عدد صحيح) عدد الشهادات التي يجب الاحتفاظ بها في JWKS (القيمة التلقائية هي 2). |
-v,
|
اختياري | الكل | (اختياري) لإنشاء ناتج تفصيلي |
مثال
apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test \ -k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 \ -s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08
الناتج
certificate successfully rotated
إنشاء رمز مميّز داخلي
أنشئ رمز JWT مميّزًا لتفويض طلبات واجهة برمجة التطبيقات للخدمة البعيدة.الاستخدام
apigee-remote-service-cli token internal [flags]
المعلمات
المعلمات
| المعلمات | التواجد في المنزل | الاستخدام مع المنتجات | الوصف |
|---|---|---|---|
-c,
|
مطلوب | Apigee Hybrid فقط | (سلسلة) مسار ملف إعداد "الخدمة البعيدة" في Apigee ملاحظة: تتيح لك هذه العلامة إغفال معظم مَعلمات الأوامر الأخرى، لأنّ واجهة سطر الأوامر يمكنها استردادها مباشرةً من ملف الإعداد. راجِع مقالة استخدام الخيار ‑‑config.
|
-d,
|
مطلوب | Apigee Hybrid فقط | (سلسلة) الوقت الصالح لرمز JWT الداخلي منذ إنشائه (القيمة التلقائية: 10m0s (10 دقائق)).
|
-e,
|
مطلوب | Apigee Hybrid فقط | (سلسلة) بيئة في مؤسستك |
-h,
|
اختياري | Apigee Hybrid فقط | تعرض هذه السمة معلومات المساعدة حول مَعلمات الأمر. |
‑‑insecure
|
اختياري | Apigee Hybrid فقط | السماح بالاتصالات غير الآمنة بالخادم عند استخدام طبقة المقابس الآمنة |
-o,
|
مطلوب | Apigee Hybrid فقط | (سلسلة) مؤسسة Apigee يجب أن تكون مشرف مؤسسة. |
-r,
|
مطلوب | Apigee Hybrid فقط | (سلسلة) تحدِّد عنوان URL لوقت التشغيل لنسخة Apigee hybrid.
يجب أن يبدأ عنوان URL بـ https://. على سبيل المثال: https://apitest.apigee-hybrid-docs.net
|
-v,
|
اختياري | Apigee Hybrid فقط | (اختياري) لإنشاء ناتج تفصيلي |
أمر الإصدار
اطبع إصدار واجهة سطر الأوامر.
apigee-remote-service-cli version
استخدام ملف .netrc لبيانات الاعتماد
يستردapigee-remote-service-cli تلقائيًا username وpassword (للمصادقة الأساسية عند الحاجة) من ملف .netrc في دليل الصفحة الرئيسية إذا كنت تستخدم Edge Public Cloud ولديك إدخال للجهاز api.enterprise.apigee.com. إذا كنت تستخدم Apigee Private Cloud، ستكون قيمة الجهاز هي نفسها قيمة عنوان URL management (على سبيل المثال:
http://192.162.55.100).
في ما يلي مثال على Edge Public Cloud:
machine api.enterprise.apigee.com login jdoe@google.com password abc123
machine http://192.162.55.100 login jdoe@google.com password abc123
استخدام خيار الأمر ‑‑config
يحدّد الخيار ‑‑config موقع ملف الإعداد الذي تم إنشاؤه باستخدام الأمر provision. من المزايا المفيدة لهذا الخيار أنّه يتيح لك تخطّي معظم مَعلمات الأوامر الأخرى التي تستخرجها واجهة سطر الأوامر من ملف الإعداد.
تشمل هذه الخيارات ما يلي:
- مؤسسة
- بيئة
- وقت التشغيل
- الفيديوهات
- غير آمن
- مساحة الاسم
- قديم
- opdk
على سبيل المثال، يمكنك تنفيذ الأمر provision على النحو التالي:
apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml
ملف الإعداد
يعرض هذا القسم مثالاً لملف إعدادات يتضمّن جميع الخيارات المتاحة.
global:
temp_dir: /tmp/apigee-istio
keep_alive_max_connection_age: 10m
api_address: :5000
metrics_address: :5001
tls:
cert_file: tls.crt
key_file: tls.key
tenant:
internal_api: https://istioservices.apigee.net/edgemicro
remote_service_api: https://org-test.apigee.net/remote-service
org_name: org
env_name: env
key: mykey
secret: mysecret
client_timeout: 30s
tls:
ca_file: /opt/apigee/tls/ca.crt
cert_file: /opt/apigee/tls/tls.crt
key_file: /opt/apigee/tls/tls.key
allow_unverified_ssl_cert: false
products:
refresh_rate: 2m
analytics:
legacy_endpoint: false
file_limit: 1024
send_channel_size: 10
collection_interval: 10s
auth:
api_key_claim: claim
api_key_cache_duration: 30m
api_key_header: x-api-key
api_header: :authority
allow_unauthorized: false
jwt_provider_key: https://org-test.apigee.net/remote-token/token
append_metadata_headers: true