شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات
رابط خط فرمان (CLI) apigee-remote-service-cli به شما کمک میکند تا Apigee Adapter را برای Envoy آمادهسازی و مدیریت کنید.
دستورات اتصال
اتصال، سرویسی را که در شبکه Istio مستقر شده است، با یک محصول API از Apigee مرتبط میکند. رابط خط فرمان (CLI) به شما امکان میدهد اتصالها را ایجاد، حذف، فهرست و تأیید کنید.
اضافه کردن یک اتصال
یک اتصال هدف سرویس از راه دور را به یک محصول API اضافه میکند.
کاربرد
برای فضای ابری عمومی Edge:
apigee-remote-service-cli bindings add [service_name] [product_name] -o [organization] -e [environment] -u [username] -p [password] -c [config]
برای ابر خصوصی لبه:
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 | هنگام استفاده از SSL، اتصالات ناامن سرور را مجاز کنید | |
--legacy | اگر از Apigee Edge Cloud استفاده میکنید، این پرچم را تنظیم کنید. این پرچم، مدیریت و URLهای زمان اجرا را برای Edge Cloud تنظیم میکند. | |
--mfa | توکن احراز هویت چند عاملی Apigee (فقط با --legacy استفاده میشود) | |
--opdk | اگر از Apigee Edge برای فضای ابری خصوصی استفاده میکنید، این پرچم را تنظیم کنید. | |
-o, --org | رشته | (الزامی) یک سازمان Apigee. شما باید مدیر سازمان باشید. |
-p, --password | رشته | (فقط برای احراز هویت اولیه لازم است) رمز عبور Apigee شما. میتوانید به صورت اختیاری رمز عبور را در یک فایل .netrc مشخص کنید. اگر این کار را انجام دهید، دیگر نیازی به ارائه رمز عبور خود در خط فرمان ندارید. همچنین به بخش استفاده از .netrc برای اعتبارنامهها مراجعه کنید. |
-r, --runtime | رشته | (فقط ابر خصوصی) URL زمان اجرا را برای نمونه ابر خصوصی شما مشخص میکند. |
-t, --token | رشته | (فقط برای احراز هویت با توکن OAuth مورد نیاز است) یک توکن OAuth یا SAML که از اطلاعات حساب Apigee خود تولید میکنید. برای اطلاعات بیشتر در مورد تولید توکنها، به بخش استفاده از get_token و دسترسی به API مدیریت با 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
لیستهای مقیدسازی
تمام محصولات API که به سرویس راه دور متصل هستند را فهرست کنید.
کاربرد
برای فضای ابری عمومی Edge:
apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password]
برای ابر خصوصی لبه:
apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password] -r [runtime]
پارامترها
| پارامترها | نوع | توضیحات |
|---|---|---|
-c, --config | رشته | (الزامی) مسیر فایل پیکربندی سرویس راه دور Apigee. نکته : این پرچم به شما امکان میدهد اکثر پارامترهای دستور دیگر را حذف کنید، زیرا رابط خط فرمان (CLI) قادر است آنها را مستقیماً از فایل پیکربندی دریافت کند. به استفاده از گزینه --config مراجعه کنید.. |
-e, --env | رشته | (الزامی) محیطی در سازمان شما. |
-h, --help | راهنمای پارامترهای دستور را نمایش میدهد. | |
--insecure | هنگام استفاده از SSL، اتصالات ناامن سرور را مجاز کنید | |
--legacy | اگر از Apigee Edge Cloud استفاده میکنید، این پرچم را تنظیم کنید. این پرچم، مدیریت و URLهای زمان اجرا را برای Edge Cloud تنظیم میکند. | |
--mfa | توکن احراز هویت چند عاملی Apigee (فقط با --legacy استفاده میشود) | |
--opdk | اگر از Apigee Edge برای فضای ابری خصوصی استفاده میکنید، این پرچم را تنظیم کنید. | |
-o, --org | رشته | (الزامی) یک سازمان Apigee. شما باید مدیر سازمان باشید. |
-p, --password | رشته | (فقط برای احراز هویت اولیه لازم است) رمز عبور Apigee شما. میتوانید به صورت اختیاری رمز عبور را در یک فایل .netrc مشخص کنید. اگر این کار را انجام دهید، دیگر نیازی به ارائه رمز عبور خود در خط فرمان ندارید. همچنین به بخش استفاده از .netrc برای اعتبارنامهها مراجعه کنید. |
-r, --runtime | رشته | (فقط ابر خصوصی) URL زمان اجرا را برای نمونه ابر خصوصی شما مشخص میکند. |
-t, --token | رشته | (فقط برای احراز هویت با توکن OAuth مورد نیاز است) یک توکن OAuth یا SAML که از اطلاعات حساب Apigee خود تولید میکنید. برای اطلاعات بیشتر در مورد تولید توکنها، به بخش استفاده از get_token و دسترسی به 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 را از یک محصول API حذف کنید.
کاربرد
برای فضای ابری عمومی Edge:
apigee-remote-service-cli bindings remove [service_name] [product_name] -o [organization] -e [environment] -u [username] -p [password] -c [config]
برای ابر خصوصی لبه:
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. نکته : این پرچم به شما امکان میدهد اکثر پارامترهای دستور دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی دریافت کند. به استفاده از گزینه --config مراجعه کنید. |
-e, --env | رشته | (الزامی) محیطی در سازمان شما. |
-h, --help | راهنمای پارامترهای دستور را نمایش میدهد. | |
--insecure | هنگام استفاده از SSL، اتصالات ناامن سرور را مجاز کنید | |
--legacy | اگر از Apigee Edge Cloud استفاده میکنید، این پرچم را تنظیم کنید. این پرچم، مدیریت و URLهای زمان اجرا را برای Edge Cloud تنظیم میکند. | |
--mfa | توکن احراز هویت چند عاملی Apigee (فقط با --legacy استفاده میشود) | |
--opdk | اگر از Apigee Edge برای فضای ابری خصوصی استفاده میکنید، این پرچم را تنظیم کنید. | |
-o, --org | رشته | (الزامی) یک سازمان Apigee. شما باید مدیر سازمان باشید. |
-p, --password | رشته | (فقط برای احراز هویت اولیه لازم است) رمز عبور Apigee شما. میتوانید به صورت اختیاری رمز عبور را در یک فایل .netrc مشخص کنید. اگر این کار را انجام دهید، دیگر نیازی به ارائه رمز عبور خود در خط فرمان ندارید. همچنین به بخش استفاده از .netrc برای اعتبارنامهها مراجعه کنید. |
-r, --runtime | رشته | (فقط ابر خصوصی) URL زمان اجرا را برای نمونه ابر خصوصی شما مشخص میکند. |
-t, --token | رشته | (فقط برای احراز هویت با توکن OAuth مورد نیاز است) یک توکن OAuth یا SAML که از اطلاعات حساب Apigee خود تولید میکنید. برای اطلاعات بیشتر در مورد تولید توکنها، به بخش استفاده از get_token و دسترسی به API مدیریت با 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
تأیید یک اتصال
تأیید کنید که محصول API متصل مشخص شده و برنامههای توسعهدهنده مرتبط با آن، یک محصول سرویس از راه دور مرتبط با خود نیز دارند. اگر نام محصول API را مشخص نکنید، دستور تمام محصولات متصل را بررسی میکند.
کاربرد
برای فضای ابری عمومی Edge:
apigee-remote-service-cli bindings verify [product_name] -o [organization] -e [environment] -u [username] -p [password] -c [config]
برای ابر خصوصی لبه:
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. نکته : این پرچم به شما امکان میدهد اکثر پارامترهای دستور دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی دریافت کند. به استفاده از گزینه --config مراجعه کنید. |
-e, --env | رشته | (الزامی) محیطی در سازمان شما. |
-h, --help | راهنمای پارامترهای دستور را نمایش میدهد. | |
--insecure | هنگام استفاده از SSL، اتصالات ناامن سرور را مجاز کنید | |
--legacy | اگر از Apigee Edge Cloud استفاده میکنید، این پرچم را تنظیم کنید. این پرچم، مدیریت و URLهای زمان اجرا را برای Edge Cloud تنظیم میکند. | |
--mfa | توکن احراز هویت چند عاملی Apigee (فقط با --legacy استفاده میشود) | |
--opdk | اگر از Apigee Edge برای فضای ابری خصوصی استفاده میکنید، این پرچم را تنظیم کنید. | |
-o, --org | رشته | (الزامی) یک سازمان Apigee. شما باید مدیر سازمان باشید. |
-r, --runtime | رشته | (فقط ابر خصوصی) URL زمان اجرا را برای نمونه ابر خصوصی شما مشخص میکند. |
-t, --token | رشته | (فقط برای احراز هویت با توکن OAuth مورد نیاز است) یک توکن OAuth یا SAML که از اطلاعات حساب Apigee خود تولید میکنید. برای اطلاعات بیشتر در مورد تولید توکنها، به بخش استفاده از get_token و دسترسی به API مدیریت با 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 برای 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 و Apigee روی گوگل کلود موجود است. از این پرچم برای مشخص کردن مسیر فایل کلید حساب سرویس Google Cloud استفاده کنید، جایی که حساب سرویس نقش |
-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، الزامی است) آدرس اینترنتی پایگاه داده مدیریت Apigee شما. پیشفرض: https://api.enterprise.apigee.com |
-n, --namespace | رشته | پیکربندی را به عنوان یک Envoy ConfigMap در فضای نام مشخص شده منتشر کنید. پیشفرض: apigee |
--opdk | رشته | آپیجی OPDK. |
-o, --organization | رشته | (الزامی) سازمان Apigee شما. شما باید مدیر سازمان باشید. |
-p, --password | رشته | (فقط برای احراز هویت اولیه لازم است) رمز عبور Apigee شما. میتوانید به صورت اختیاری رمز عبور را در یک فایل .netrc مشخص کنید. اگر این کار را انجام دهید، دیگر نیازی به ارائه رمز عبور خود در خط فرمان ندارید. همچنین به بخش استفاده از .netrc برای اعتبارنامهها مراجعه کنید. |
--rotate-int | عدد صحیح | اگر n > 0 باشد، کلید خصوصی جدید ایجاد کن و n کلید عمومی نگه دار (فقط ترکیبی) |
-r, --runtime | رشته | (فقط ابر خصوصی) URL زمان اجرا را برای نمونه ابر خصوصی شما مشخص میکند. |
-s, --secret | رشته | رمزی را که از دستور apigee-remote-service-cli provision برگردانده میشود، مشخص میکند. |
--strength | عدد صحیح | (اختیاری) قدرت رمزگذاری برای گواهیهای SSL مورد استفاده در تهیه آداپتور را مشخص میکند. پیشفرض 2048 |
-t, --token | رشته | (فقط ترکیبی) توکن Apigee OAuth یا SAML. |
-u, --username | رشته | (فقط برای احراز هویت اولیه لازم است) نام کاربری Apigee شما (معمولاً یک آدرس ایمیل). میتوانید به صورت اختیاری نام کاربری را در یک فایل .netrc مشخص کنید. همچنین به بخش استفاده از .netrc برای اعتبارنامهها مراجعه کنید. |
-v, --verbose | (اختیاری) خروجی طولانی و مفصل تولید میکند. | |
--virtual-hosts | رشته | میزبانهای مجازی پیشفرض را که default,secure لغو میکند. اگر میزبانهای مجازی دیگری غیر از این پیشفرضها برای محیط سازمانی Edge خود مشخص کردهاید، از این گزینه استفاده کنید. برای کسب اطلاعات بیشتر در مورد میزبانهای مجازی، به مستندات Edge مراجعه کنید. |
--years | عدد صحیح | (اختیاری) تعداد سالهایی که طول میکشد تا گواهی SSL استفاده شده در فرآیند تأمین اعتبار منقضی شود. پیشفرض: ۱ |
مثال
حتماً خروجی دستور 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 معتبر که از طریق provisioning تولید شده است، نیاز دارد. به طور پیشفرض، فایلهای نمونه در دایرکتوری به نام ./samples نمایش داده میشوند. این دستور این دایرکتوری را برای شما ایجاد میکند.
اگر از Envoy بومی استفاده میکنید، این دستور میزبان سرویس هدف و نام دلخواه برای خوشه آن را دریافت میکند. همچنین اگر پوشهای حاوی tls.key و tls.crt از طریق --tls ارائه شود، اتصال SSL سفارشی را از پروکسی Envoy به خوشه سرویس راه دور تنظیم میکند.
اگر از Istio استفاده میکنید، که در آن پروکسی Envoy به عنوان یک واسطه عمل میکند، اگر هدف مشخص نشده باشد، مثال httpbin ایجاد خواهد شد. در غیر این صورت، شما مسئول تهیه فایلهای پیکربندی مربوط به استقرار سرویسهای هدف خود هستید.
پارامترها
| پارامترها | نوع | توضیحات |
|---|---|---|
-c, --config | رشته | (الزامی) مسیر فایل پیکربندی سرویس از راه دور Apigee. نکته : این پرچم به شما امکان میدهد اکثر پارامترهای دستور دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی دریافت کند. به استفاده از گزینه --config مراجعه کنید. |
-f, --force | دایرکتوری موجود را مجبور به رونویسی کنید. | |
-h, --help | راهنمای پارامترهای دستور را نمایش میدهد. | |
--host | میزبان سرویس هدف (پیشفرض "httpbin.org") | |
-n, --name | نام سرویس هدف (پیشفرض "httpbin") | |
--out | دایرکتوری که فایلهای پیکربندی نمونه در آن ایجاد میشوند. پیشفرض: ./samples | |
-t, --template | نام الگو. اگر در حال انجام استقرار Istio (فقط ترکیبی) هستید، یکی از گزینههای Istio موجود را انتخاب کنید. برای استقرارهای بومی Envoy از گزینه native استفاده کنید. گزینههای موجود عبارتند از:
| |
--tls | دایرکتوری که کلید TLS و فایلهای crt در آن ذخیره میشوند. |
مثال
apigee-remote-service-cli samples create -c ./config.yaml
دستورات توکن
شما میتوانید به جای استفاده از کلید API، از یک توکن JWT برای برقراری فراخوانیهای پروکسی API احراز هویت شده استفاده کنید. دستورات توکن به شما امکان میدهند توکنهای JWT را برای این منظور ایجاد، بررسی و تغییر دهید.
ایجاد یک توکن JWT
شما میتوانید از یک توکن JWT برای برقراری تماسهای پروکسی API احراز هویت شده به یک هدف سرویس از راه دور استفاده کنید. همچنین به بخش «استفاده از احراز هویت مبتنی بر JWT» مراجعه کنید.کاربرد
برای فضای ابری عمومی Edge:apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -o [org] -e [env]
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]
پارامترها
| پارامترها | نوع | توضیحات |
|---|---|---|
-c, --config | رشته | (الزامی) مسیر فایل پیکربندی سرویس راه دور Apigee. نکته : این پرچم به شما امکان میدهد اکثر پارامترهای دستور دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی دریافت کند. به استفاده از گزینه --config مراجعه کنید. |
-e, --env | رشته | (الزامی) محیطی در سازمان شما. |
-h, --help | راهنمای پارامترهای دستور را نمایش میدهد. | |
--insecure | هنگام استفاده از SSL، اتصالات ناامن سرور را مجاز کنید. | |
-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 را بررسی کنید. همچنین به Inspect a token مراجعه کنید.کاربرد
برای فضای ابری عمومی Edge:apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file]
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]
پارامترها
| پارامترها | نوع | توضیحات |
|---|---|---|
-c, --config | رشته | (الزامی) مسیر فایل پیکربندی سرویس راه دور Apigee. نکته : این پرچم به شما امکان میدهد اکثر پارامترهای دستور دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی دریافت کند. به استفاده از گزینه --config مراجعه کنید. |
-e, --env | رشته | (الزامی) محیطی در سازمان شما. |
-h, --help | راهنمای پارامترهای دستور را نمایش میدهد. | |
--insecure | هنگام استفاده از SSL، اتصالات ناامن سرور را مجاز کنید. | |
-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) آن داشته باشید. این فرآیند تولید یک جفت کلید جدید، چرخش کلید نامیده میشود. هنگامی که کلیدها را میچرخانید، یک جفت کلید خصوصی/عمومی جدید تولید و در 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]
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. نکته : این پرچم به شما امکان میدهد اکثر پارامترهای دستور دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی دریافت کند. به استفاده از گزینه --config مراجعه کنید. |
-e, --env | رشته | (الزامی) محیطی در سازمان شما. |
-h, --help | راهنمای پارامترهای دستور را نمایش میدهد. | |
--insecure | هنگام استفاده از SSL، اتصالات ناامن سرور را مجاز کنید | |
--truncate | عدد صحیح | تعداد گواهیهایی که باید در jwks نگهداری شوند (پیشفرض ۲) |
-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 برای اعتبارنامهها
اگر در Edge Public Cloud هستید و ورودی دستگاهapi.enterprise.apigee.com را دارید apigee-remote-service-cli به طور خودکار username و password (برای احراز هویت اولیه در صورت نیاز) را از یک فایل .netrc در دایرکتوری خانگی شما دریافت میکند. اگر در 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
دستور نسخه
نسخه CLI را چاپ کنید.
apigee-remote-service-cli version
استفاده از گزینه دستور --config
گزینه --config محل فایل پیکربندی تولید شده توسط دستور provision را مشخص میکند. یکی از مزایای مفید این گزینه این است که به شما امکان میدهد از اکثر پارامترهای دستور دیگر که CLI از فایل پیکربندی دریافت میکند، صرف نظر کنید. این گزینهها عبارتند از:- سازمان
- محیط زیست
- زمان اجرا
- مدیریت
- ناامن
- فضای نام
- میراث
- آپدک
برای مثال، میتوانید دستور 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