أنت تعرض مستندات Apigee Edge.
انتقل إلى
مستندات Apigee X. معلومات
تساعدك واجهة سطر الأوامر في apigee-remote-service-cli
في
توفير وإدارة "محوِّل Apigee لـ Envoy".
أوامر الربط
يربط Binding خدمة تم نشرها على شبكة Istio المتداخلة بمنتج Apigee API. يتيح لك واجهة سطر الأوامر إنشاء عمليات ربط وإزالتها وإدراجها والتحقق منها.
إضافة ربط
إضافة ربط هدف خدمة عن بُعد بمنتج واجهة برمجة التطبيقات
الاستخدام
بالنسبة إلى 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 عن بُعد ملاحظة: تتيح لك هذه العلامة حذف معظم معلَمات الأوامر الأخرى، لأن يمكن لـ CLI سحبها مباشرةً من ملف التهيئة. عرض استخدام الخيار --config
|
-e, --env
|
سلسلة | (مطلوب) بيئة في مؤسستك. |
-h, --help
|
تعرِض هذه العلامة معلومات المساعدة حول مَعلمات الأمر. | |
--insecure
|
السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة | |
--legacy
|
يمكنك ضبط هذه العلامة في حال استخدام Apigee Edge Cloud. يحدِّد عناوين URL الخاصة بالإدارة ووقت التشغيل لـ Edge Cloud. | |
--mfa
|
رمز التفويض المتعدّد العوامل في Apigee (يُستخدَم مع --legacy فقط)
|
|
--opdk
|
يمكنك ضبط هذه العلامة في حال استخدام Apigee Edge for Private Cloud. | |
-o, --org
|
سلسلة | (مطلوب) مؤسسة Apigee. يجب أن تكون مشرفًا في المؤسسة. |
-p, --password
|
سلسلة | (مطلوبة للمصادقة الأساسية فقط) كلمة مرور Apigee. يمكنك اختياريًا تحديد
كلمة المرور في ملف .netrc . وفي هذه الحالة، لن يُطلب منك
تقديم كلمة المرور في سطر الأوامر. يمكن أيضًا مراجعة
استخدام .netrc لبيانات الاعتماد
|
-r, --runtime
|
سلسلة | (السحابة الإلكترونية الخاصة فقط) تحدِّد هذه السياسة عنوان URL لبيئة التشغيل لمثيل السحابة الإلكترونية الخاصة. |
-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 Remote Service. ملاحظة: تتيح لك هذه العلامة حذف معظم معلَمات الأوامر الأخرى، لأن يمكن لـ CLI سحبها مباشرةً من ملف التهيئة. عرض باستخدام الخيار --config
|
-e, --env
|
سلسلة | (مطلوب) بيئة في مؤسستك. |
-h, --help
|
تعرِض هذه العلامة معلومات المساعدة حول مَعلمات الأمر. | |
--insecure
|
السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة | |
--legacy
|
يمكنك ضبط هذه العلامة في حال استخدام Apigee Edge Cloud. يحدِّد عناوين URL الخاصة بالإدارة ووقت التشغيل لـ Edge Cloud. | |
--mfa
|
رمز التفويض المتعدّد العوامل في Apigee (يُستخدَم مع --legacy فقط)
|
|
--opdk
|
يمكنك ضبط هذه العلامة في حال استخدام Apigee Edge for Private Cloud. | |
-o, --org
|
سلسلة | (مطلوب) مؤسسة Apigee. يجب أن تكون مشرفًا في المؤسسة. |
-p, --password
|
سلسلة | (مطلوبة للمصادقة الأساسية فقط) كلمة مرور Apigee. يمكنك اختياريًا تحديد
كلمة المرور في ملف .netrc . في هذه الحالة، لن يُطلب منك
تقديم كلمة المرور في سطر الأوامر. يُرجى الاطّلاع أيضًا على
استخدام ملف .netrc لبيانات الاعتماد.
|
-r, --runtime
|
سلسلة | (السحابة الإلكترونية الخاصة فقط) تحدِّد هذه السياسة عنوان URL لبيئة التشغيل لمثيل السحابة الإلكترونية الخاصة. |
-t, --token
|
سلسلة | (مطلوب لمصادقة رمز OAuth المميز فقط) رمز OAuth أو SAML المميز الذي تنشئه من معلومات حسابك في Apigee للحصول على معلومات عن إنشاء الرموز المميّزة، يُرجى الاطّلاع على استخدام get_token و الوصول إلى Management API باستخدام 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 Remote Service. نصيحة: تتيح لك هذه العلامة حذف معظم معلَمات الأوامر الأخرى، لأن يمكن لـ CLI سحبها مباشرةً من ملف التهيئة. عرض استخدام الخيار --config
|
-e, --env
|
سلسلة | (مطلوب) بيئة في مؤسستك. |
-h, --help
|
تعرِض هذه العلامة معلومات المساعدة حول مَعلمات الأمر. | |
--insecure
|
السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة | |
--legacy
|
يمكنك ضبط هذه العلامة في حال استخدام Apigee Edge Cloud. يحدِّد عناوين URL الخاصة بالإدارة ووقت التشغيل لـ Edge Cloud. | |
--mfa
|
رمز التفويض المتعدّد العوامل في Apigee (يُستخدَم مع --legacy فقط)
|
|
--opdk
|
يمكنك ضبط هذه العلامة في حال استخدام Apigee Edge for Private Cloud. | |
-o, --org
|
سلسلة | (مطلوب) مؤسسة Apigee. يجب أن تكون مشرفًا في المؤسسة. |
-p, --password
|
سلسلة | (مطلوبة للمصادقة الأساسية فقط) كلمة مرور Apigee. يمكنك اختياريًا تحديد
كلمة المرور في ملف .netrc . وفي هذه الحالة، لن يُطلب منك
تقديم كلمة المرور في سطر الأوامر. يُرجى الاطّلاع أيضًا على
استخدام ملف .netrc لبيانات الاعتماد.
|
-r, --runtime
|
سلسلة | (السحابة الإلكترونية الخاصة فقط) تحدِّد هذه السياسة عنوان URL لبيئة التشغيل لمثيل السحابة الإلكترونية الخاصة. |
-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 Remote Service. ملاحظة: تسمح لك هذه العلامة بحذف معظم مَعلمات الأوامر الأخرى، لأنّه يمكن لواجهة سطر الأوامر استخراجها مباشرةً من ملف الضبط. عرض استخدام الخيار --config
|
-e, --env
|
سلسلة | (مطلوب) بيئة في مؤسستك. |
-h, --help
|
تعرِض هذه العلامة معلومات المساعدة حول مَعلمات الأمر. | |
--insecure
|
السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة | |
--legacy
|
يمكنك ضبط هذه العلامة في حال استخدام Apigee Edge Cloud. يحدِّد عناوين URL الخاصة بالإدارة ووقت التشغيل لـ Edge Cloud. | |
--mfa
|
رمز التفويض المتعدّد العوامل في Apigee (يُستخدَم مع --legacy فقط)
|
|
--opdk
|
يمكنك ضبط هذه العلامة في حال استخدام Apigee Edge for Private Cloud. | |
-o, --org
|
سلسلة | (مطلوب) مؤسسة Apigee. يجب أن تكون مشرفًا في المؤسسة. |
-r, --runtime
|
سلسلة | (السحابة الإلكترونية الخاصة فقط) تحدِّد هذه السياسة عنوان URL لبيئة التشغيل لمثيل السحابة الإلكترونية الخاصة. |
-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 لجهاز 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
المعلمات
المعلمات | النوع | الوصف |
---|---|---|
--analytics-sa
|
سلسلة | هذه العلامة هي فقط
متوفّران في عمليات تثبيت Apigee Hybrid وApigee على Google Cloud
يمكنك استخدام هذه العلامة لتحديد المسار إلى ملف مفتاح حساب خدمة Google Cloud، حيث يكون
يكون لحساب الخدمة الدور " |
-c, --config
|
سلسلة | مسار إلى ملف إعداد خدمة Apigee Remote Service راجع أيضًا
استخدام الخيار --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
|
سلسلة | (السحابة الإلكترونية الخاصة فقط) تحدِّد هذه السياسة عنوان URL لبيئة التشغيل لمثيل السحابة الإلكترونية الخاصة. |
-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 | (اختياري) عدد السنوات قبل انتهاء صلاحية شهادة بروتوكول طبقة المقابس الآمنة (SSL) المستخدَمة في عملية الإعداد الإعدادات التلقائية: 1 |
مثال
احرص على تسجيل إخراج الأمر provision
في ملف، والذي يتم استخدامه
كإدخال لعمليات Apigee Adapter for 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 الأصلي، سيأخذ الأمر مضيف الخدمة الهدف والاسم المطلوب
مجموعته العنقودية. يتم أيضًا ضبط اتصال طبقة المقابس الآمنة (SSL) المخصّص من الخادم الوكيل Envoy على الخدمة البعيدة.
تجميع إذا تم توفير مجلد يحتوي على tls.key
وtls.crt
عبر --tls
.
إذا كنت تستخدم Istio، حيث يعمل خادم Envoy الوكيل كنسخة جانبية، إذا لم يتم تحديد الهدف،
سيتم إنشاء مثال httpbin
. خلاف ذلك، فأنت مسئول عن إعداد
ملفات التهيئة المتعلقة بنشر الخدمات المستهدفة.
المعلمات
المعلمات | النوع | الوصف |
---|---|---|
-c, --config
|
سلسلة | (مطلوب) ملف إعداد المسار إلى Apigee Remote Service. ملاحظة: تسمح لك هذه العلامة بحذف معظم مَعلمات الأوامر الأخرى، لأنّه يمكن لواجهة سطر الأوامر استخراجها مباشرةً من ملف الضبط. راجِع استخدام الخيار --config .
|
-f, --force
|
فرض استبدال الدليل الحالي | |
-h, --help
|
يعرض المساعدة لمعلمات الأوامر. | |
--host
|
مضيف الخدمة الهدف (الإعداد التلقائي "httpbin.org") | |
-n, --name
|
اسم الخدمة المستهدفة ("httpbin" التلقائي) | |
--out
|
الدليل الذي سيتم فيه إنشاء نموذج ملفات الإعداد. عناوين URL التلقائية: ./samples
|
|
-t, --template
|
اسم النموذج. إذا كنت بصدد نشر Istio (مختلط فقط)، اختَر أحد خيارات Istio المتاحة. استخدِم الخيار الأصلي لعمليات نشر Envoy الأصلية. الخيارات المتاحة هي:
|
|
--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 Remote Service نصيحة: تتيح لك هذه العلامة حذف معظم معلَمات الأوامر الأخرى، لأن يمكن لـ CLI سحبها مباشرةً من ملف التهيئة. عرض استخدام الخيار --config
|
-e, --env
|
سلسلة | (مطلوب) بيئة في مؤسستك. |
-h, --help
|
يعرض المساعدة لمعلمات الأوامر. | |
--insecure
|
السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة | |
-o, --org
|
سلسلة | (مطلوب) مؤسسة Apigee. يجب أن تكون مشرفًا في المؤسسة. |
-r, --runtime
|
سلسلة | (السحابة الإلكترونية الخاصة فقط) تحدِّد هذه السياسة عنوان URL لبيئة التشغيل لمثيل السحابة الإلكترونية الخاصة. |
-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 Remote Service. ملاحظة: تتيح لك هذه العلامة حذف معظم معلَمات الأوامر الأخرى، لأن يمكن لـ CLI سحبها مباشرةً من ملف التهيئة. عرض استخدام الخيار --config
|
-e, --env
|
سلسلة | (مطلوب) بيئة في مؤسستك. |
-h, --help
|
يعرض المساعدة لمعلمات الأوامر. | |
--insecure
|
السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة | |
-o, --org
|
سلسلة | (مطلوب) مؤسسة Apigee. يجب أن تكون مشرفًا في المؤسسة. |
-r, --runtime
|
سلسلة | (السحابة الإلكترونية الخاصة فقط) تحدِّد هذه السياسة عنوان URL لبيئة التشغيل لمثيل السحابة الإلكترونية الخاصة. |
-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) المشفَّرة. تتمثل عملية إنشاء يسمى زوج المفاتيح الجديد تدوير المفاتيح. عند تدوير المفاتيح، سيتم إنشاء زوج مفاتيح خاص/عام جديد وتخزينه في "istio" KVM في مؤسسة/بيئة 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 Remote Service. نصيحة: تتيح لك هذه العلامة حذف معظم معلَمات الأوامر الأخرى، لأن يمكن لـ CLI سحبها مباشرةً من ملف التهيئة. عرض استخدام الخيار --config
|
-e, --env
|
سلسلة | (مطلوب) بيئة في مؤسستك. |
-h, --help
|
تعرِض هذه العلامة معلومات المساعدة حول مَعلمات الأمر. | |
--insecure
|
السماح باتصالات الخادم غير الآمنة عند استخدام طبقة المقابس الآمنة | |
--truncate
|
int | عدد الشهادات المطلوب الاحتفاظ بها في jwks (الإعداد الافتراضي 2) |
-o, --org
|
سلسلة | (مطلوب) مؤسسة Apigee. يجب أن تكون مشرفًا في المؤسسة. |
-r, --runtime
|
سلسلة | (السحابة الإلكترونية الخاصة فقط) تحدِّد هذه السياسة عنوان URL لبيئة التشغيل لمثيل السحابة الإلكترونية الخاصة. |
-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
. من الفائدة المفيدة من هذا الخيار أنه
بتخطي معظم معلمات الأوامر الأخرى، والتي يسحبها واجهة سطر الأوامر من ملف التهيئة.
وتشمل هذه الخيارات ما يلي:
- مؤسسة
- بيئة
- وقت التشغيل
- الفيديوهات
- غير آمن
- مساحة الاسم
- قديم
- 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