ارجاع

شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید .
اطلاعات

رابط خط فرمان apigee-remote-service-cli (CLI) به شما در تهیه و مدیریت Apigee Adapter برای Envoy کمک می کند.

دستورات الزام آور

Binding یک سرویس مستقر در مش Istio را با یک محصول Apigee API مرتبط می کند. CLI به شما امکان می دهد پیوندها را ایجاد، حذف، فهرست و تأیید کنید.

یک صحافی اضافه کنید

اتصال هدف سرویس از راه دور را به محصول 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 Remote Service.
نکته : این پرچم به شما اجازه می دهد تا اکثر پارامترهای دستوری دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی خارج کند. به استفاده از گزینه --config مراجعه کنید.
-e, --env رشته (الزامی) یک محیط در سازمان شما.
-h, --help راهنمایی برای پارامترهای فرمان را نمایش می دهد.
--insecure هنگام استفاده از SSL، اتصالات سرور ناامن را مجاز کنید
--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 و دسترسی به 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 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 هنگام استفاده از SSL، اتصالات سرور ناامن را مجاز کنید
--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 و دسترسی به 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:

یک اتصال را بردارید

اتصال Remote Service for Envoy را از محصول API حذف کنید.

استفاده

برای 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 هنگام استفاده از SSL، اتصالات سرور ناامن را مجاز کنید
--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 و دسترسی به 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 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.
نکته : این پرچم به شما اجازه می دهد تا اکثر پارامترهای دستوری دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی خارج کند. به استفاده از گزینه --config مراجعه کنید.
-e, --env رشته (الزامی) یک محیط در سازمان شما.
-h, --help راهنمایی برای پارامترهای فرمان را نمایش می دهد.
--insecure هنگام استفاده از SSL، اتصالات سرور ناامن را مجاز کنید
--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 و دسترسی به 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 برای 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 در دسترس است.

از این پرچم برای تعیین مسیر فایل کلید حساب سرویس Google Cloud استفاده کنید، جایی که حساب سرویس دارای نقش Apigee Analytics Agent است. SA توسط آداپتور برای آپلود مستقیم داده های تجزیه و تحلیل در Apigee استفاده می شود. اگر از Apigee hybrid استفاده می‌کنید، این گزینه به شما اجازه می‌دهد تا زمان اجرا هیبریدی را در یک کلاستر و آداپتور را در خوشه دیگر نصب کنید.

-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 شما. پیش فرض: https://api.enterprise.apigee.com
-n, --namespace رشته پیکربندی را به عنوان یک Envoy ConfigMap در فضای نام مشخص شده ارسال کنید. پیش فرض: apigee
--opdk رشته Apigee OPDK.
-o, --organization رشته (الزامی) سازمان Apigee شما. شما باید یک مدیر سازمان باشید.
-p, --password رشته (فقط برای احراز هویت اولیه لازم است) رمز عبور Apigee شما. شما می توانید به صورت اختیاری رمز عبور را در یک فایل .netrc مشخص کنید. در صورت انجام این کار، نیازی به ارائه رمز عبور خود در خط فرمان ندارید. همچنین استفاده از netrc. برای اعتبارنامه را ببینید.
--rotate-int بین المللی اگر n > 0 باشد، کلید خصوصی جدید ایجاد کنید و n کلید عمومی را نگه دارید (فقط ترکیبی)
-r, --runtime رشته (فقط Private Cloud) URL زمان اجرا را برای نمونه Private Cloud شما مشخص می کند.
-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 مورد استفاده در تهیه. پیش فرض: 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 بومی استفاده می کنید، فرمان میزبان سرویس هدف و نام دلخواه را برای خوشه آن می گیرد. همچنین اگر پوشه ای حاوی tls.key و tls.crt از طریق --tls ارائه شود، اتصال SSL سفارشی را از پروکسی Envoy به خوشه خدمات راه دور تنظیم می کند.

اگر از Istio استفاده می کنید، جایی که پروکسی Envoy به عنوان یک سایدکار عمل می کند، اگر هدف نامشخص باشد، مثال httpbin ایجاد می شود. در غیر این صورت، شما مسئول تهیه فایل های پیکربندی مربوط به استقرار سرویس های مورد نظر خود هستید.

پارامترها

پارامترها تایپ کنید توضیحات
-c, --config رشته (الزامی) مسیر فایل پیکربندی Apigee Remote Service.
نکته : این پرچم به شما اجازه می دهد تا اکثر پارامترهای دستوری دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی خارج کند. به استفاده از گزینه --config مراجعه کنید.
-f, --force دایرکتوری موجود را مجبور به رونویسی کنید.
-h, --help راهنمایی برای پارامترهای فرمان را نمایش می دهد.
--host میزبان سرویس هدف (پیش‌فرض "httpbin.org")
-n, --name نام سرویس هدف (پیش‌فرض "httpbin")
--out دایرکتوری که در آن فایل های پیکربندی نمونه ایجاد می شود. پیش فرض: ./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

دستورات رمزی

می توانید به جای استفاده از کلید API از یک نشانه JWT برای برقراری تماس های پروکسی API احراز هویت شده استفاده کنید. دستورات توکن به شما امکان می دهد توکن های JWT را برای این منظور ایجاد، بازرسی و بچرخانید.

یک توکن JWT ایجاد کنید

می‌توانید از یک توکن JWT برای برقراری تماس‌های پروکسی API احراز هویت شده با هدف سرویس راه دور استفاده کنید. همچنین استفاده از احراز هویت مبتنی بر 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 هنگام استفاده از 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 Remote Service.
نکته : این پرچم به شما اجازه می دهد تا اکثر پارامترهای دستوری دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی خارج کند. به استفاده از گزینه --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 Remote Service.
نکته : این پرچم به شما اجازه می دهد تا اکثر پارامترهای دستوری دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی خارج کند. به استفاده از گزینه --config مراجعه کنید.
-e, --env رشته (الزامی) یک محیط در سازمان شما.
-h, --help راهنمایی برای پارامترهای فرمان را نمایش می دهد.
--insecure هنگام استفاده از SSL، اتصالات سرور ناامن را مجاز کنید
--truncate بین المللی تعداد گواهی برای نگهداری در jwks (پیش‌فرض 2)
-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 برای اعتبار

اگر در Edge Public Cloud هستید و ورودی برای دستگاه api.enterprise.apigee.com دارید apigee-remote-service-cli به طور خودکار username و password (برای احراز هویت اولیه در صورت نیاز) را از یک فایل .netrc در فهرست اصلی خود انتخاب می کند. 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

دستور نسخه

نسخه CLI را چاپ کنید.

apigee-remote-service-cli version

با استفاده از گزینه دستور --config

گزینه --config محل فایل کانفیگ تولید شده توسط دستور provision را مشخص می کند. یک مزیت مفید این گزینه این است که به شما امکان می دهد از اکثر پارامترهای دستوری دیگر که CLI از فایل پیکربندی خارج می کند صرف نظر کنید. این گزینه ها عبارتند از:
  • سازمان
  • محیط زیست
  • زمان اجرا
  • مدیریت
  • ناامن
  • فضای نام
  • میراث
  • 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