المرجع

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

تساعدك واجهة سطر الأوامر (CLI) في apigee-remote-service-cli على توفير محوِّل Apigee لـ Envoy وإدارته.

ربط الأوامر

يربط الربط خدمة تم نشرها في شبكة Istio Mesh مع منتج واجهة برمجة التطبيقات Apigee. تتيح لك واجهة سطر الأوامر (CLI) إنشاء الروابط وإزالتها وإدراجها والتحقق منها.

إضافة ربط

لإضافة ربط هدف خدمة عن بُعد إلى منتج واجهة برمجة تطبيقات

الاستخدام

بالنسبة إلى Edge Public Cloud:

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

بالنسبة إلى Edge Private Cloud:

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

المكان:

  • target_name هو اسم هدف خدمة عن بُعد لربطه بالمنتج.
  • السمة product_name هي اسم المنتج الذي تريد إلزام الخدمة به.

أعلام

المَعلمات النوع الوصف
-c, --config سلسلة (مطلوب) المسار إلى ملف إعداد خدمة Apigee عن بُعد.
ملاحظة: تتيح لك هذه العلامة حذف معظم مَعلمات الأوامر الأخرى، لأنّ واجهة سطر الأوامر قادرة على سحبها مباشرةً من ملف الإعداد. راجِع استخدام خيار --config.
-e, --env سلسلة (مطلوب) بيئة في مؤسستك.
-h, --help يعرض معلومات المساعدة حول معلَمات الأوامر.
--insecure السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة
--legacy يمكنك ضبط هذه العلامة إذا كنت تستخدم Apigee Edge Cloud. يضبط هذا الإعداد عناوين URL للإدارة ووقت التشغيل لبرنامج Edge Cloud.
--mfa رمز تفويض Apigee متعدد العوامل (يُستخدَم مع --legacy فقط)
--opdk يمكنك ضبط هذه العلامة إذا كنت تستخدم Apigee Edge لـ Private Cloud.
-o, --org سلسلة (مطلوب) مؤسسة Apigee. يجب أن تكون مشرف مؤسسة.
-p, --password سلسلة (مطلوب للمصادقة الأساسية فقط) كلمة مرور Apigee. يمكنك اختياريًا تحديد كلمة المرور في ملف .netrc. وفي هذه الحالة، لن يُطلب منك تقديم كلمة المرور في سطر الأوامر. راجِع أيضًا استخدام .netrc لبيانات الاعتماد.
-r, --runtime سلسلة (Private Cloud فقط) تحدّد عنوان URL لوقت التشغيل لمثيل Private Cloud الخاص بك.
-t, --token سلسلة (مطلوب لمصادقة رمز OAuth المميز فقط) رمز OAuth أو SAML المميز الذي تنشئه من معلومات حسابك على Apigee. لمزيد من المعلومات حول إنشاء الرموز المميّزة، يُرجى الاطّلاع على استخدام get_token والوصول إلى واجهة برمجة تطبيقات الإدارة باستخدام SAML.
-u, --username سلسلة (مطلوب للمصادقة الأساسية فقط) اسم مستخدم Apigee (يكون عادةً عنوان بريد إلكتروني). يمكنك اختياريًا تحديد اسم المستخدم في ملف .netrc. وفي حال إجراء ذلك، لن يكون عليك تقديم اسم المستخدم الخاص بك في سطر الأوامر. يمكنك الاطّلاع أيضًا على استخدام .netrc لبيانات الاعتماد.
-v, --verbose (اختياري) لعرض مخرجات مطوَّلة.

مثال

./apigee-remote-service-cli bindings add httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is now bound to: httpbin.org

عمليات ربط القوائم

أدرج جميع منتجات واجهة برمجة التطبيقات المرتبطة بالخدمة عن بُعد.

الاستخدام

بالنسبة إلى Edge Public Cloud:

apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password]

بالنسبة إلى Edge Private Cloud:

apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password] -r [runtime] 

المَعلمات

المَعلمات النوع الوصف
-c, --config سلسلة (مطلوب) المسار إلى ملف إعداد خدمة Apigee عن بُعد.
ملاحظة: تتيح لك هذه العلامة حذف معظم مَعلمات الأوامر الأخرى، لأنّ واجهة سطر الأوامر قادرة على سحبها مباشرةً من ملف الإعداد. راجِع استخدام خيار --config..
-e, --env سلسلة (مطلوب) بيئة في مؤسستك.
-h, --help يعرض معلومات المساعدة حول معلَمات الأوامر.
--insecure السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة
--legacy يمكنك ضبط هذه العلامة إذا كنت تستخدم Apigee Edge Cloud. يضبط هذا الإعداد عناوين URL للإدارة ووقت التشغيل لبرنامج Edge Cloud.
--mfa رمز تفويض Apigee متعدد العوامل (يُستخدَم مع --legacy فقط)
--opdk يمكنك ضبط هذه العلامة إذا كنت تستخدم Apigee Edge لـ Private Cloud.
-o, --org سلسلة (مطلوب) مؤسسة Apigee. يجب أن تكون مشرف مؤسسة.
-p, --password سلسلة (مطلوب للمصادقة الأساسية فقط) كلمة مرور Apigee. يمكنك اختياريًا تحديد كلمة المرور في ملف .netrc. وفي هذه الحالة، لن يُطلب منك تقديم كلمة المرور في سطر الأوامر. راجِع أيضًا استخدام .netrc لبيانات الاعتماد.
-r, --runtime سلسلة (Private Cloud فقط) تحدّد عنوان URL لوقت التشغيل لمثيل Private Cloud الخاص بك.
-t, --token سلسلة (مطلوب لمصادقة رمز OAuth المميز فقط) رمز OAuth أو SAML المميز الذي تنشئه من معلومات حسابك على Apigee. لمزيد من المعلومات حول إنشاء الرموز المميّزة، يُرجى الاطّلاع على استخدام get_token والوصول إلى واجهة برمجة تطبيقات الإدارة باستخدام SAML.
-u, --username سلسلة (مطلوب للمصادقة الأساسية فقط) اسم مستخدم Apigee (يكون عادةً عنوان بريد إلكتروني). يمكنك اختياريًا تحديد اسم المستخدم في ملف .netrc. وفي حال إجراء ذلك، لن يكون عليك تقديم اسم المستخدم الخاص بك في سطر الأوامر. يمكنك الاطّلاع أيضًا على استخدام .netrc لبيانات الاعتماد.
-v, --verbose (اختياري) لعرض مخرجات مطوَّلة.

مثال

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:

إزالة ربط

إزالة ربط "الخدمة عن بُعد لـ Envoy" من منتج واجهة برمجة تطبيقات

الاستخدام

بالنسبة إلى Edge Public Cloud:

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

بالنسبة إلى Edge Private Cloud:

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

المكان:

  • target_name هو اسم هدف خدمة عن بُعد لإلغاء ربطه بالمنتج.
  • product_name هي اسم المنتج الذي تريد إلغاء ربط الهدف منه.

المَعلمات

المَعلمات النوع الوصف
-c, --config سلسلة (مطلوب) المسار إلى ملف إعداد خدمة Apigee عن بُعد.
ملاحظة: تتيح لك هذه العلامة حذف معظم مَعلمات الأوامر الأخرى، لأنّ واجهة سطر الأوامر قادرة على سحبها مباشرةً من ملف الإعداد. راجِع استخدام خيار --config.
-e, --env سلسلة (مطلوب) بيئة في مؤسستك.
-h, --help يعرض معلومات المساعدة حول معلَمات الأوامر.
--insecure السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة
--legacy يمكنك ضبط هذه العلامة إذا كنت تستخدم Apigee Edge Cloud. يضبط هذا الإعداد عناوين URL للإدارة ووقت التشغيل لبرنامج Edge Cloud.
--mfa رمز تفويض Apigee متعدد العوامل (يُستخدَم مع --legacy فقط)
--opdk يمكنك ضبط هذه العلامة إذا كنت تستخدم Apigee Edge لـ Private Cloud.
-o, --org سلسلة (مطلوب) مؤسسة Apigee. يجب أن تكون مشرف مؤسسة.
-p, --password سلسلة (مطلوب للمصادقة الأساسية فقط) كلمة مرور Apigee. يمكنك اختياريًا تحديد كلمة المرور في ملف .netrc. وفي هذه الحالة، لن يُطلب منك تقديم كلمة المرور في سطر الأوامر. راجِع أيضًا استخدام .netrc لبيانات الاعتماد.
-r, --runtime سلسلة (Private Cloud فقط) تحدّد عنوان URL لوقت التشغيل لمثيل Private Cloud الخاص بك.
-t, --token سلسلة (مطلوب لمصادقة رمز OAuth المميز فقط) رمز OAuth أو SAML المميز الذي تنشئه من معلومات حسابك على Apigee. لمزيد من المعلومات حول إنشاء الرموز المميّزة، يُرجى الاطّلاع على استخدام get_token والوصول إلى واجهة برمجة تطبيقات الإدارة باستخدام SAML.
-u, --username سلسلة (مطلوب للمصادقة الأساسية فقط) اسم مستخدم Apigee (يكون عادةً عنوان بريد إلكتروني). يمكنك اختياريًا تحديد اسم المستخدم في ملف .netrc. وفي حال إجراء ذلك، لن يكون عليك تقديم اسم المستخدم الخاص بك في سطر الأوامر. يمكنك الاطّلاع أيضًا على استخدام .netrc لبيانات الاعتماد.
-v, --verbose (اختياري) لعرض مخرجات مطوَّلة.

مثال

./apigee-remote-service-cli bindings remove httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is no longer bound to: httpbin.org

التحقّق من عملية ربط

تأكَّد من أنّ المنتج المحدّد المرتبط بواجهة برمجة التطبيقات وتطبيقات المطوّرين المرتبطة به يرتبط أيضًا بمنتج خدمة عن بُعد. إذا لم تحدّد اسم منتج واجهة برمجة التطبيقات، سيتحقّق الأمر من جميع المنتجات المرتبطة.

الاستخدام

بالنسبة إلى Edge Public Cloud:

apigee-remote-service-cli bindings verify [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

بالنسبة إلى Edge Private Cloud:

apigee-remote-service-cli bindings verify [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

حيث يكون product_name اختياريًا. إذا لم تحدّد اسم منتج، يتم وضع علامة في جميع المنتجات المرتبطة.

المَعلمات

المَعلمات النوع الوصف
-c, --config سلسلة (مطلوب) المسار إلى ملف إعداد خدمة Apigee عن بُعد.
ملاحظة: تتيح لك هذه العلامة حذف معظم مَعلمات الأوامر الأخرى، لأنّ واجهة سطر الأوامر قادرة على سحبها مباشرةً من ملف الإعداد. راجِع استخدام خيار --config.
-e, --env سلسلة (مطلوب) بيئة في مؤسستك.
-h, --help يعرض معلومات المساعدة حول معلَمات الأوامر.
--insecure السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة
--legacy يمكنك ضبط هذه العلامة إذا كنت تستخدم Apigee Edge Cloud. يضبط هذا الإعداد عناوين URL للإدارة ووقت التشغيل لبرنامج Edge Cloud.
--mfa رمز تفويض Apigee متعدد العوامل (يُستخدَم مع --legacy فقط)
--opdk يمكنك ضبط هذه العلامة إذا كنت تستخدم Apigee Edge لـ Private Cloud.
-o, --org سلسلة (مطلوب) مؤسسة Apigee. يجب أن تكون مشرف مؤسسة.
-r, --runtime سلسلة (Private Cloud فقط) تحدّد عنوان URL لوقت التشغيل لمثيل Private Cloud الخاص بك.
-t, --token سلسلة (مطلوب لمصادقة رمز OAuth المميز فقط) رمز OAuth أو SAML المميز الذي تنشئه من معلومات حسابك على Apigee. لمزيد من المعلومات حول إنشاء الرموز المميّزة، يُرجى الاطّلاع على استخدام get_token والوصول إلى واجهة برمجة تطبيقات الإدارة باستخدام SAML.
-v, --verbose (اختياري) لعرض مخرجات مطوَّلة.

مثال

./apigee-remote-service-cli bindings verify my-product -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
  app my-app associated with product my-product is verified

طلب المساعدة

يتم توفير المساعدة على الإنترنت لجميع أوامر 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.

الاستخدام

إذا كنت تستخدم Edge Public Cloud:

apigee-remote-service-cli provision -o $ORG -e $ENV -u $USERNAME -p $PASSWORD

إذا كنت تستخدم Edge Private Cloud:

apigee-remote-service-cli provision --opdk -o $ORG -e $ENV -u $USERNAME --management $MGMT_SERVER_URL --runtime $RUNTIME_URL -p $PASSWORD

المَعلمات

المَعلمات النوع الوصف
-c, --config سلسلة مسار ملف إعداد خدمة Apigee البعيدة. راجِع أيضًا استخدام خيار --config.
-e, --environment سلسلة (مطلوب) بيئة في مؤسستك.
-f, --force-proxy-install (اختياري) يؤدي هذا الخيار إلى فرض إعادة تثبيت الخادم الوكيل remote-service إذا كان مثبَّتًا من قبل في مؤسستك.
-h, --help يعرض معلومات المساعدة حول معلَمات الأوامر.
-k, --key سلسلة تحدّد هذه العلامة المفتاح الذي يعرضه الأمر apigee-remote-service-cli provision.
--legacy يمكنك ضبط هذه العلامة إذا كنت تستخدم Apigee Edge Cloud. يضبط هذا الإعداد عناوين URL للإدارة ووقت التشغيل لبرنامج Edge Cloud.
--mfa رمز تفويض Apigee متعدد العوامل (يُستخدَم مع --legacy فقط)
-m, --management سلسلة (مطلوب إذا كنت مشتركًا في Apigee Private Cloud) عنوان URL لقاعدة إدارة Apigee الخاصة بك. عناوين URL التلقائية: https://api.enterprise.apigee.com
-n, --namespace سلسلة إصدار الإعدادات كـ Envoy ConfigMap في مساحة الاسم المحدّدة. القيمة التلقائية: apigee
--opdk سلسلة Apigee OPDK.
-o, --organization سلسلة (مطلوب) مؤسسة Apigee الخاصة بك. يجب أن تكون مشرف مؤسسة.
-p, --password سلسلة (مطلوب للمصادقة الأساسية فقط) كلمة مرور Apigee. يمكنك اختياريًا تحديد كلمة المرور في ملف .netrc. وفي هذه الحالة، لن يُطلب منك تقديم كلمة المرور في سطر الأوامر. راجِع أيضًا استخدام .netrc لبيانات الاعتماد.
--rotate-int int إذا كانت n > 0، أنشئ مفتاحًا خاصًا جديدًا واحتفظ بـ n مفتاح عام (مختلط فقط)
-r, --runtime سلسلة (Private Cloud فقط) تحدّد عنوان URL لوقت التشغيل لمثيل Private Cloud الخاص بك.
-s, --secret سلسلة تحدّد هذه السمة المفتاح السرّي الذي يعرضه الأمر apigee-remote-service-cli provision.
--strength int (اختياري) تحدّد قوة التشفير لشهادات طبقة المقابس الآمنة (SSL) المستخدمة في توفير المحوّل. العدد التلقائي 2048
-t, --token سلسلة (مختلط فقط) Apigee OAuth أو رمز SAML المميز.
-u, --username سلسلة (مطلوب للمصادقة الأساسية فقط) اسم مستخدم Apigee (يكون عادةً عنوان بريد إلكتروني). يمكنك اختياريًا تحديد اسم المستخدم في ملف .netrc. راجِع أيضًا استخدام .netrc لبيانات الاعتماد.
-v, --verbose (اختياري) لعرض مخرجات مطوَّلة.
--virtual-hosts سلسلة لإلغاء المضيفات الافتراضية، وهي default,secure. ويمكنك استخدام هذا الخيار إذا كانت لديك مضيفات افتراضية محددة لبيئة مؤسسة Edge غير هذه الإعدادات التلقائية. يمكنك الاطّلاع على مستندات Edge لمعرفة المزيد عن الأجهزة المضيفة الافتراضية.
--years int (اختياري) عدد السنوات قبل انتهاء صلاحية شهادة طبقة المقابس الآمنة المستخدَمة في توفير المتطلبات اللازمة. القيمة التلقائية: 1

مثال

احرص على تسجيل إخراج الأمر provision في ملف، والذي يستخدم كإدخال في عمليات Apigee Adapter الأخرى لعمليات Envoy.

مثال على Edge Public Cloud:

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. وبخلاف ذلك، تكون مسؤولاً عن إعداد ملفات التهيئة المتعلقة بنشر خدماتك المستهدفة.

المَعلمات

المَعلمات النوع الوصف
-c, --config سلسلة (مطلوب) مسار ملف إعداد خدمة Apigee عن بُعد.
ملاحظة: تتيح لك هذه العلامة حذف معظم مَعلمات الأوامر الأخرى، لأنّ واجهة سطر الأوامر قادرة على سحبها مباشرةً من ملف الإعداد. راجِع استخدام خيار --config.
-f, --force فرض استبدال الدليل الحالي
-h, --help يعرض معلومات المساعدة حول معلَمات الأوامر.
--host مضيف الخدمة المستهدف (القيمة التلقائية "httpbin.org")
-n, --name اسم الخدمة المستهدفة (القيمة التلقائية "httpbin")
--out دليل Th الذي يمكن إنشاء نموذج ملفات الإعداد فيه. عناوين URL التلقائية: ./samples
-t, --template

اسم النموذج إذا كنت تريد نشر Istio (المختلط فقط)، اختَر أحد خيارات Istio المتاحة. استخدام الخيار الأصلي لعمليات نشر Envoy الأصلية. في ما يلي الخيارات المتاحة:

  • istio-1.6 (الخيار التلقائي)
  • istio-1.7
  • native
--tls الدليل الذي يتم فيه تخزين مفتاح بروتوكول أمان طبقة النقل (TLS) وملفات crt.

مثال

apigee-remote-service-cli samples create -c ./config.yaml

أوامر الرموز المميّزة

يمكنك استخدام رمز JWT المميز لإجراء استدعاءات الخادم الوكيل لواجهة برمجة التطبيقات التي تمت مصادقتها بدلاً من استخدام مفتاح واجهة برمجة التطبيقات. تتيح لك أوامر الرمز المميز إنشاء رموز JWT المميزة وفحصها وتدويرها لهذا الغرض.

إنشاء رمز JWT مميز

يمكنك استخدام رمز JWT المميز لإجراء استدعاءات الخادم الوكيل لواجهة برمجة التطبيقات التي تمت مصادقتها إلى هدف خدمة عن بُعد. يمكنك الاطّلاع أيضًا على استخدام المصادقة المستندة إلى JWT.

الاستخدام

بالنسبة إلى Edge Public Cloud:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -o [org] -e [env]
بالنسبة إلى Edge Private Cloud:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]

المَعلمات

المَعلمات النوع الوصف
-c, --config سلسلة (مطلوب) المسار إلى ملف إعداد خدمة Apigee عن بُعد.
ملاحظة: تتيح لك هذه العلامة حذف معظم مَعلمات الأوامر الأخرى، لأنّ واجهة سطر الأوامر قادرة على سحبها مباشرةً من ملف الإعداد. راجِع استخدام خيار --config.
-e, --env سلسلة (مطلوب) بيئة في مؤسستك.
-h, --help يعرض معلومات المساعدة حول معلَمات الأوامر.
--insecure السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة (SSL).
-o, --org سلسلة (مطلوب) مؤسسة Apigee. يجب أن تكون مشرف مؤسسة.
-r, --runtime سلسلة (Private Cloud فقط) تحدّد عنوان URL لوقت التشغيل لمثيل Private Cloud الخاص بك.
-v, --verbose (اختياري) لعرض مخرجات مطوَّلة.

مثال

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 باستخدام هذا الأمر. راجِع أيضًا فحص رمز مميّز.

الاستخدام

بالنسبة إلى Edge Public Cloud:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file]
بالنسبة إلى Edge Private Cloud:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]

المَعلمات

المَعلمات النوع الوصف
-c, --config سلسلة (مطلوب) المسار إلى ملف إعداد خدمة Apigee عن بُعد.
ملاحظة: تتيح لك هذه العلامة حذف معظم مَعلمات الأوامر الأخرى، لأنّ واجهة سطر الأوامر قادرة على سحبها مباشرةً من ملف الإعداد. راجِع استخدام خيار --config.
-e, --env سلسلة (مطلوب) بيئة في مؤسستك.
-h, --help يعرض معلومات المساعدة حول معلَمات الأوامر.
--insecure السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة (SSL).
-o, --org سلسلة (مطلوب) مؤسسة Apigee. يجب أن تكون مشرف مؤسسة.
-r, --runtime سلسلة (Private Cloud فقط) تحدّد عنوان URL لوقت التشغيل لمثيل Private Cloud الخاص بك.
-v, --verbose (اختياري) لعرض مخرجات مطوَّلة.

مثال

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 Edge في خريطة قيمة المفتاح المشفرة (KVM). وتسمى عملية إنشاء زوج مفاتيح جديد عند تدوير المفاتيح، يتم إنشاء زوج مفاتيح خاص/عام جديد وتخزينه في KVM "istio" في مؤسسة/بيئة Apigee Edge. بالإضافة إلى ذلك، يتم الاحتفاظ بالمفتاح العام القديم مع قيمة رقم تعريف المفتاح الأصلي.

الاستخدام

إذا كنت تستخدم Edge Public Cloud:
apigee-remote-service-cli token rotate-cert -c [config_file] -o [organization] -e [environment] -k [provision_key] -s [provision_secret] --kid [new_key_id]
إذا كنت تستخدم Edge Private Cloud:
apigee-remote-service-cli token rotate-cert -o [organization] -e [environment] -u [username] -p [password] -k [provision_key] -s [provision_secret] --kid [new_key_id]

المَعلمات

المَعلمات النوع الوصف
-c, --config سلسلة (مطلوب) المسار إلى ملف إعداد خدمة Apigee عن بُعد.
ملاحظة: تتيح لك هذه العلامة حذف معظم مَعلمات الأوامر الأخرى، لأنّ واجهة سطر الأوامر قادرة على سحبها مباشرةً من ملف الإعداد. راجِع استخدام خيار --config.
-e, --env سلسلة (مطلوب) بيئة في مؤسستك.
-h, --help يعرض معلومات المساعدة حول معلَمات الأوامر.
--insecure السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة
--truncate int عدد الشهادات المطلوب الاحتفاظ بها في jwks (الشهادات الافتراضية)
-o, --org سلسلة (مطلوب) مؤسسة Apigee. يجب أن تكون مشرف مؤسسة.
-r, --runtime سلسلة (Private Cloud فقط) تحدّد عنوان URL لوقت التشغيل لمثيل Private Cloud الخاص بك.
-v, --verbose (اختياري) لعرض مخرجات مطوَّلة.

مثال

apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test -k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 -s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08

الناتج

certificate successfully rotated

استخدام .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

أمر الإصدار

طباعة نسخة واجهة سطر الأوامر

apigee-remote-service-cli version

استخدام خيار الأمر --config

يحدِّد الخيار --config موقع ملف الإعداد الذي تم إنشاؤه باستخدام الأمر provision. ومن الفوائد المفيدة لهذا الخيار أنّه يسمح لك بتخطّي معظم معلَمات الأوامر الأخرى، التي يسحبها واجهة سطر الأوامر من ملف الإعداد. وتشمل هذه الخيارات ما يلي:
  • مؤسسة
  • بيئة
  • وقت التشغيل
  • الفيديوهات
  • غير آمن
  • namespace
  • قديم
  • 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
  allow_unverified_ssl_cert: false
products:
  refresh_rate: 2m
analytics:
  legacy_endpoint: false
  file_limit: 1024
  send_channel_size: 10
  collection_interval: 10s
  fluentd_endpoint: apigee-udca-myorg-test.apigee.svc.cluster.local:20001
  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
auth:
  api_key_claim: claim
  api_key_cache_duration: 30m
  api_key_header: x-api-key
  api_target_header: :authority
  reject_unauthorized: true
  jwks_poll_interval: 0s