أنت تعرض مستندات Apigee Edge.
انتقل إلى
مستندات Apigee X. معلومات
تساعدك واجهة سطر الأوامر (CLI) في apigee-remote-service-cli
توفير وإدارة Apigee Adapter لـ Envoy.
أمر List linkeds (إدراج الارتباط)
أدرِج جميع منتجات واجهة برمجة التطبيقات المرتبطة بـ "الخدمة عن بُعد".
الاستخدام
apigee-remote-service-cli bindings list [flags]
المعلمات
المعلمات | التواجد في المنزل | تُستخدَم مع المنتجات | الوصف |
---|---|---|---|
-c,
|
مطلوب | الكل | (سلسلة) المسار إلى ملف إعداد Apigee Remote Service. نصيحة: تتيح لك هذه العلامة حذف معظم معلَمات الأوامر الأخرى، لأن يمكن لـ CLI سحبها مباشرةً من ملف التهيئة. عرض استخدام الخيار ‑‑config
|
-e,
|
مطلوب | الكل | (سلسلة) بيئة في مؤسستك. |
-h,
|
اختياري | الكل | يعرض المساعدة لمعلمات الأوامر. |
‑‑insecure
|
اختياري | الكل | السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة |
‑‑legacy
|
مطلوب | Edge Public Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for 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 for 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) من جهة العميل والمفتاح الخاص وهيئة إصدار الشهادات (CA) الجذر لاتصال mTLS. |
-t,
|
مطلوب (مصادقة رمز OAuth المميز فقط) |
الكل | (سلسلة) رمز مميّز OAuth أو SAML تنشئه من معلومات حسابك في Apigee يتجاوز أي بيانات اعتماد أخرى مقدَّمة. |
-u,
|
مطلوب (المصادقة الأساسية فقط) |
شبكة Edge المتاحة للجميع والسحابة الخاصة الخاصة فقط |
(سلسلة) اسم مستخدم 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 Remote Service. نصيحة: تتيح لك هذه العلامة حذف معظم معلَمات الأوامر الأخرى، لأن يمكن لـ CLI سحبها مباشرةً من ملف التهيئة. عرض استخدام الخيار ‑‑config
|
-e,
|
مطلوب | الكل | (سلسلة) بيئة في مؤسستك. |
-f, ‑‑force-proxy-install
|
اختياري | الكل | (اختياري) تفرض إعادة تثبيت الخادم الوكيل remote-service في حال
مثبت من قبل في مؤسستك.
|
-h,
|
اختياري | الكل | يعرض المساعدة لمعلمات الأوامر. |
‑‑insecure
|
اختياري | الكل | السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة |
‑‑legacy
|
مطلوب | Edge Public Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for 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 for 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) من جهة العميل والمفتاح الخاص وهيئة إصدار الشهادات (CA) الجذر لاتصال mTLS. |
-t,
|
مطلوب (مصادقة رمز OAuth المميز فقط) |
الكل | (سلسلة) رمز مميّز OAuth أو SAML تنشئه من معلومات حسابك في Apigee يتجاوز أي بيانات اعتماد أخرى مقدَّمة. |
-u,
|
مطلوب (المصادقة الأساسية فقط) |
شبكة Edge المتاحة للجميع والسحابة الخاصة الخاصة فقط |
(سلسلة) اسم مستخدم Apigee (يكون عادةً عنوان بريد إلكتروني).
يمكنك اختياريًا تحديد اسم المستخدم في ملف .netrc . عرض
أيضًا استخدام .netrc لبيانات الاعتماد
|
-v,
|
اختياري | الكل | (اختياري) يؤدي إلى عرض مخرجات مطوّلة. |
‑‑virtual-hosts
|
اختياري | Edge Private Cloud فقط | (سلسلة) لإلغاء المضيفات الافتراضية التلقائية، وهي default,secure . استخدِم هذا الخيار إذا كنت
لديها مضيفات افتراضية محددة لبيئة مؤسسة Edge غير هذه الإعدادات الافتراضية.
|
مثال
كما يبيِّن المثال التالي، من المهم الحصول على ناتج الأمر provision
في الملف، والذي يتم استخدامه
كمدخل لمهايئ Apigee الآخر لعمليات 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 الأصلي، سيأخذ الأمر مضيف الخدمة الهدف والاسم المطلوب
مجموعته العنقودية. يتم أيضًا ضبط اتصال طبقة المقابس الآمنة (SSL) المخصّص من الخادم الوكيل Envoy على الخدمة البعيدة.
تجميع إذا تم توفير مجلد يحتوي على tls.key
وtls.crt
عبر --tls
.
إذا كنت تستخدم Istio، حيث يعمل خادم Envoy الوكيل كنسخة جانبية، إذا لم يتم تحديد الهدف،
سيتم إنشاء مثال httpbin
. خلاف ذلك، فأنت مسئول عن إعداد
ملفات التهيئة المتعلقة بنشر الخدمات المستهدفة.
المعلمات
المعلمات | التواجد في المنزل | تُستخدَم مع المنتجات | الوصف |
---|---|---|---|
‑‑adapter‑host
|
مطلوب لنماذج Envoy فقط | الكل | (سلسلة) اسم المضيف للمحوّل (القيمة التلقائية: localhost )
|
-c, ‑‑config
|
مطلوب | الكل | (سلسلة) ملف إعداد المسار إلى Apigee Remote Service نصيحة: تتيح لك هذه العلامة حذف معظم معلَمات الأوامر الأخرى، لأن يمكن لـ CLI سحبها مباشرةً من ملف التهيئة. عرض استخدام الخيار ‑‑config
|
-f, ‑‑force
|
اختياري | الكل | فرض استبدال الدليل الحالي |
-h, ‑‑help
|
اختياري | الكل | يعرض المساعدة لمعلمات الأوامر. |
‑‑host |
مطلوب لنماذج Envoy فقط | الكل | (سلسلة) مضيف الخدمة الهدف (القيمة التلقائية httpbin.org )
|
-n, ‑‑name |
مطلوب | الكل | (سلسلة) اسم الخدمة المستهدفة (القيمة التلقائية httpbin.org )
|
‑‑out
|
اختياري | الكل | (سلسلة) الدليل الذي سيتم فيه إنشاء نماذج ملفات الإعداد. القيمة التلقائية: ./samples
|
‑‑tag
|
مطلوب لنماذج Istio فقط | الكل | (سلسلة) علامة إصدار صورة محوّل Envoy. عناوين 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 Remote Service. ملاحظة: تتيح لك هذه العلامة حذف معظم معلَمات الأوامر الأخرى، لأن يمكن لـ CLI سحبها مباشرةً من ملف التهيئة. عرض استخدام الخيار ‑‑config
|
-e,
|
مطلوب | الكل | (سلسلة) بيئة في مؤسستك. |
-h,
|
اختياري | الكل | يعرض المساعدة لمعلمات الأوامر. |
--i, --id
|
مطلوب | الكل | (سلسلة) بيانات اعتماد المفتاح التي تم العثور عليها في تطبيق مطوّري برامج Apigee كما هو موضّح في كيفية الحصول على مفتاح واجهة برمجة التطبيقات |
‑‑insecure
|
اختياري | الكل | السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة |
‑‑legacy
|
مطلوب | Edge Public Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for Public Cloud. تحدِّد هذه السياسة عناوين URL للإدارة وبيئة التشغيل. في Apigee Edge for Public Cloud |
‑‑opdk
| مطلوب | Edge Private Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for 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) من جهة العميل والمفتاح الخاص وهيئة إصدار الشهادات (CA) الجذر لاتصال 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 Remote Service. نصيحة: تتيح لك هذه العلامة حذف معظم معلَمات الأوامر الأخرى، لأن يمكن لـ CLI سحبها مباشرةً من ملف التهيئة. عرض استخدام الخيار ‑‑config
|
-e,
|
مطلوب | الكل | (سلسلة) بيئة في مؤسستك. |
-f,
|
مطلوب | الكل | (سلسلة) ملف الرمز المميّز (الإعداد التلقائي: استخدام stdin )
|
-h,
|
اختياري | الكل | يعرض المساعدة لمعلمات الأوامر. |
‑‑insecure
|
اختياري | الكل | السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة |
‑‑legacy
|
مطلوب | Edge Public Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for Public Cloud. تحدِّد هذه السياسة عناوين URL للإدارة وبيئة التشغيل. في Apigee Edge for Public Cloud |
‑‑opdk
| مطلوب | Edge Private Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for 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) من جهة العميل والمفتاح الخاص وهيئة إصدار الشهادات (CA) الجذر لاتصال 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) المشفرة. تتمثل عملية إنشاء يسمى زوج المفاتيح الجديد تدوير المفاتيح. عند تدوير المفاتيح، سيتم إنشاء زوج مفاتيح خاص/عام جديد وتخزينه في "istio" KVM في مؤسسة/بيئة Apigee بالإضافة إلى ذلك، يتم الاحتفاظ بالمفتاح العام القديم مع قيمة رقم تعريف المفتاح الأصلية.الاستخدام
apigee-remote-service-cli token rotate-cert [flags]
المعلمات
المعلمات | التواجد في المنزل | تُستخدَم مع المنتجات | الوصف |
---|---|---|---|
-c,
|
مطلوب | الكل | (سلسلة) المسار إلى ملف إعداد Apigee Remote Service. نصيحة: تتيح لك هذه العلامة حذف معظم معلَمات الأوامر الأخرى، لأن يمكن لـ CLI سحبها مباشرةً من ملف التهيئة. عرض استخدام الخيار ‑‑config
|
-e,
|
مطلوب | الكل | (سلسلة) بيئة في مؤسستك. |
-h,
|
اختياري | شبكة Edge المتاحة للجميع والسحابة الخاصة الخاصة فقط | يعرض المساعدة لمعلمات الأوامر. |
--k, --key
|
مطلوب | شبكة Edge المتاحة للجميع والسحابة الخاصة الخاصة فقط | (سلسلة) مفتاح توفير المتطلبات اللازمة. |
‑‑insecure
|
اختياري | شبكة Edge المتاحة للجميع والسحابة الخاصة الخاصة فقط | السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة |
‑‑legacy
|
مطلوب | Edge Public Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for Public Cloud. تحدِّد هذه السياسة عناوين URL للإدارة وبيئة التشغيل. في Apigee Edge for Public Cloud |
‑‑opdk
| مطلوب | Edge Private Cloud فقط | يجب ضبط هذه العلامة إذا كنت تستخدم Apigee Edge for Private Cloud. |
-o,
|
مطلوب | شبكة Edge المتاحة للجميع والسحابة الخاصة الخاصة فقط | (سلسلة) مؤسسة Apigee: يجب أن تكون مشرف مؤسسة. |
-r,
|
مطلوب | Edge Private Cloud فقط | (سلسلة) تحدِّد هذه السياسة عنوان URL لبيئة التشغيل لمثيل Private Cloud أو 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. نصيحة: تتيح لك هذه العلامة حذف معظم معلَمات الأوامر الأخرى، لأن يمكن لـ CLI سحبها مباشرةً من ملف التهيئة. عرض استخدام الخيار ‑‑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