أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى
مستندات Apigee X. info
تساعدك واجهة سطر الأوامر في apigee-remote-service-cli
في
توفير وإدارة "محوِّل Apigee لـ Envoy".
أمر عرض عمليات الربط
أدرِج جميع منتجات واجهة برمجة التطبيقات المرتبطة بالخدمة البعيدة.
الاستخدام
apigee-remote-service-cli bindings list [flags]
المعلمات
المعلمات | التواجد في المنزل | استخدامها مع المنتجات | الوصف |
---|---|---|---|
-c,
|
مطلوب | الكل | (سلسلة) المسار إلى ملف إعدادات خدمة Apigee عن بُعد ملاحظة: تسمح لك هذه العلامة بحذف معظم مَعلمات الأوامر الأخرى، لأنّه يمكن لواجهة سطر الأوامر استخراجها مباشرةً من ملف الضبط. راجِع استخدام الخيار ‑‑config .
|
-e,
|
مطلوب | الكل | (سلسلة) بيئة في مؤسستك. |
-h,
|
اختياري | الكل | تعرِض هذه العلامة معلومات المساعدة حول مَعلمات الأمر. |
‑‑insecure
|
اختياري | الكل | السماح باتصالات الخوادم غير الآمنة عند استخدام طبقة المقابس الآمنة (SSL) |
‑‑legacy
|
مطلوب | Edge Public Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge لـ Public Cloud. لضبط عناوين URL الخاصة بالإدارة ووقت التشغيل في Apigee Edge for 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 غير مطلوب فقط في حال إعداد MFA على حسابك في Apigee Edge. |
‑‑opdk
| مطلوب | Edge Private Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge لـ Private Cloud. |
-o,
|
مطلوب | الكل | (سلسلة) مؤسسة Apigee يجب أن تكون مشرفًا في المؤسسة. |
-p,
|
مطلوبة (المصادقة الأساسية فقط) |
شبكة Edge المتاحة للجميع والسحابة الخاصة الخاصة فقط | (سلسلة) كلمة مرور Apigee يمكنك اختياريًا تحديد
كلمة المرور في ملف .netrc . يُرجى الاطّلاع أيضًا على
استخدام ملف .netrc لبيانات الاعتماد.
|
-r,
|
مطلوب | Edge Private Cloud وApigee Hybrid فقط | (سلسلة) تُحدِّد عنوان URL لوقت التشغيل لـ Private Cloud أو لمثيل 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 لـ 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
|
اختياري | الكل | السماح باتصالات الخوادم غير الآمنة عند استخدام طبقة المقابس الآمنة (SSL) |
‑‑legacy
|
مطلوب | Edge Public Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge لـ Public Cloud. لضبط عناوين URL الخاصة بالإدارة ووقت التشغيل في Apigee Edge for 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 غير مطلوب فقط في حال إعداد MFA على حسابك في Apigee Edge. |
-n, ‑‑namespace
|
اختياري | الكل | (سلسلة) إطلاق الإعدادات كـ Envoy ConfigMap في مساحة الاسم المحدّدة. عناوين URL التلقائية: apigee
|
‑‑opdk
| مطلوب | Edge Private Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge لـ Private Cloud. |
-o,
|
مطلوب | الكل | (سلسلة) مؤسسة Apigee يجب أن تكون مشرفًا في المؤسسة لتتمكّن من الإعداد. |
-p,
|
مطلوب (المصادقة الأساسية فقط) |
شبكة Edge المتاحة للجميع والسحابة الخاصة الخاصة فقط | (سلسلة) كلمة مرور Apigee يمكنك اختياريًا تحديد
كلمة المرور في ملف .netrc . وفي هذه الحالة، لن يُطلب منك
تقديم كلمة المرور في سطر الأوامر. يُرجى الاطّلاع أيضًا على
استخدام ملف .netrc لبيانات الاعتماد.
|
‑‑rotate-int
|
اختياري | Apigee Hybrid فقط | (عدد صحيح) إذا كان n > 0، أنشئ مفتاحًا خاصًا جديدًا واحفظ n مفتاحًا عامًا (النظام المختلط فقط) |
-r,
|
مطلوب | Edge Private Cloud وApigee Hybrid فقط | (سلسلة) تُحدِّد عنوان URL لوقت التشغيل لـ Private Cloud أو لمثيل 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
الأمر Samples
لإنشاء نماذج ملفات الإعداد وعرضها
إنشاء نماذج لملفات الإعداد
تنشئ نموذجًا لملفات الإعداد لعمليات نشر 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 Remote Service ملاحظة: تسمح لك هذه العلامة بحذف معظم مَعلمات الأوامر الأخرى، لأنّه يمكن لواجهة سطر الأوامر استخراجها مباشرةً من ملف الضبط. راجِع استخدام الخيار ‑‑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
|
اختياري | الكل | السماح باتصالات الخوادم غير الآمنة عند استخدام طبقة المقابس الآمنة (SSL) |
‑‑legacy
|
مطلوب | Edge Public Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge لـ Public Cloud. لضبط عناوين URL الخاصة بالإدارة ووقت التشغيل في Apigee Edge for Public Cloud |
‑‑opdk
| مطلوب | Edge Private Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge لـ Private Cloud. |
-o,
|
مطلوب | الكل | (سلسلة) مؤسسة Apigee يجب أن تكون مشرفًا في المؤسسة. |
-r,
|
مطلوب | Edge Private Cloud وApigee Hybrid فقط | (سلسلة) تُحدِّد عنوان URL لوقت التشغيل لـ Private Cloud أو لمثيل 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
|
اختياري | الكل | السماح باتصالات الخوادم غير الآمنة عند استخدام طبقة المقابس الآمنة (SSL) |
‑‑legacy
|
مطلوب | Edge Public Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge لـ Public Cloud. لضبط عناوين URL الخاصة بالإدارة ووقت التشغيل في Apigee Edge for Public Cloud |
‑‑opdk
| مطلوب | Edge Private Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge لـ Private Cloud. |
-o,
|
مطلوب | الكل | (سلسلة) مؤسسة Apigee يجب أن تكون مشرفًا في المؤسسة. |
-r,
|
مطلوب | Edge Private Cloud وApigee Hybrid فقط | (سلسلة) تُحدِّد عنوان URL لوقت التشغيل لـ Private Cloud أو لمثيل 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 المتاحة للجميع والسحابة الخاصة الخاصة فقط | (سلسلة) مفتاح التوفير |
‑‑insecure
|
اختياري | شبكة Edge المتاحة للجميع والسحابة الخاصة الخاصة فقط | السماح باتصالات الخوادم غير الآمنة عند استخدام طبقة المقابس الآمنة (SSL) |
‑‑legacy
|
مطلوب | Edge Public Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge لـ Public Cloud. لضبط عناوين URL الخاصة بالإدارة ووقت التشغيل في Apigee Edge for Public Cloud |
‑‑opdk
| مطلوب | Edge Private Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge لـ 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) من جهة العميل والمفتاح الخاص وهيئة إصدار الشهادات (CA) الجذر لاتصال 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 Remote Service. ملاحظة: تسمح لك هذه العلامة بحذف معظم مَعلمات الأوامر الأخرى، لأنّه يمكن لواجهة سطر الأوامر استخراجها مباشرةً من ملف الضبط. راجِع استخدام الخيار ‑‑config .
|
-d,
|
مطلوب | Apigee Hybrid فقط | (سلسلة) وقت صالح لـ JWT الداخلي من الإنشاء (القيمة التلقائية: 10m0s (10 دقائق))
|
-e,
|
مطلوب | Apigee Hybrid فقط | (سلسلة) بيئة في مؤسستك |
-h,
|
اختياري | Apigee Hybrid فقط | تعرِض هذه العلامة معلومات المساعدة حول مَعلمات الأمر. |
‑‑insecure
|
اختياري | Apigee Hybrid فقط | السماح باتصالات الخوادم غير الآمنة عند استخدام طبقة المقابس الآمنة (SSL) |
-o,
|
مطلوب | Apigee Hybrid فقط | (سلسلة) مؤسسة Apigee يجب أن تكون مشرفًا في المؤسسة. |
-r,
|
مطلوب | Apigee Hybrid فقط | (سلسلة) تحدِّد عنوان URL لوقت التشغيل لنسخة Apigee المختلطة.
يجب أن يبدأ عنوان URL بـ https:// . على سبيل المثال: https://apitest.apigee-hybrid-docs.net
|
-v,
|
اختياري | Apigee Hybrid فقط | (اختياري) لعرض معلومات أكثر تفصيلاً |
الأمر version
اطبع إصدار واجهة سطر الأوامر.
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على سبيل المثال في Edge Private Cloud:
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