مرجع

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

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

دستور اتصال لیست

تمام محصولات API که به سرویس راه دور متصل هستند را فهرست کنید.

کاربرد 

apigee-remote-service-cli bindings list [flags]

پارامترها

پارامترها حضور با محصولات استفاده می‌شود توضیحات
-c,
‑‑config		 مورد نیاز همه (رشته) مسیر فایل پیکربندی سرویس راه دور Apigee.
نکته : این پرچم به شما امکان می‌دهد اکثر پارامترهای دستور دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی دریافت کند. به استفاده از گزینه ‑‑config مراجعه کنید.
-e,
‑‑environment		 مورد نیاز همه (رشته) محیطی در سازمان شما.
-h,
‑‑help		 اختیاری همه راهنمای پارامترهای دستور را نمایش می‌دهد.
‑‑insecure اختیاری همه هنگام استفاده از SSL، اتصالات ناامن سرور را مجاز کنید.
‑‑legacy مورد نیاز فقط ابر عمومی Edge اگر از Apigee Edge برای فضای ابری عمومی استفاده می‌کنید، باید این پرچم را تنظیم کنید. URL های مدیریتی و زمان اجرا را برای Apigee Edge برای فضای ابری عمومی تنظیم می‌کند.
-m,
‑‑management		 مورد نیاز فقط ابر خصوصی اج (رشته) آدرس اینترنتی پایه مدیریت برای نصب Apigee Edge برای ابر خصوصی شما. پیش‌فرض: https://api.enterprise.apigee.com
‑‑mfa مورد نیاز فقط ابر عمومی Edge (رشته) توکن مجوز چند عاملی برای Apigee Edge شما برای ابر عمومی. فقط در صورتی لازم است که MFA در حساب Apigee Edge شما تنظیم شده باشد.
‑‑opdk مورد نیاز فقط ابر خصوصی اج اگر از Apigee Edge برای فضای ابری خصوصی استفاده می‌کنید، باید این پرچم را تنظیم کنید.
-o,
‑‑organization		 مورد نیاز همه (رشته) یک سازمان آپیجی. شما باید مدیر سازمان باشید.
-p,
‑‑password		 مورد نیاز
(فقط مجوز پایه)		 فقط فضای ابری عمومی و خصوصی Edge (رشته) رمز عبور Apigee شما. می‌توانید به صورت اختیاری رمز عبور را در یک فایل .netrc مشخص کنید. همچنین به بخش استفاده از .netrc برای اعتبارنامه‌ها مراجعه کنید.
-r,
‑‑runtime		 مورد نیاز فقط Edge Private Cloud و Apigee hybrid (رشته) آدرس اینترنتی (URL) زمان اجرا را برای ابر خصوصی یا نمونه ترکیبی Apigee شما مشخص می‌کند. این آدرس اینترنتی باید با https:// شروع شود. به عنوان مثال: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca		 اختیاری فقط ابر خصوصی اج (رشته) گواهی TLS سمت کلاینت، کلید خصوصی و CA ریشه را برای اتصال mTLS مشخص می‌کند.
-t,
‑‑token		 مورد نیاز
(فقط توکن OAuth برای احراز هویت)		 همه (رشته) یک توکن OAuth یا SAML که شما از اطلاعات حساب Apigee خود تولید می‌کنید. هرگونه اعتبارنامه ارائه شده دیگر را لغو می‌کند.
-u,
‑‑username		 مورد نیاز
(فقط مجوز پایه)		 فقط فضای ابری عمومی و خصوصی Edge (رشته) نام کاربری 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:

دستور راهنما

برای تمام دستورات 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 دو API Proxy را در سازمان Apigee Edge شما نصب می‌کند، یک گواهی‌نامه تنظیم می‌کند و اعتبارنامه‌هایی را تولید می‌کند که برای پیکربندی Apigee Adapter for Envoy به آنها نیاز خواهید داشت.

کاربرد 

apigee-remote-service-cli provision [flags]

پارامترها

پارامترها حضور با محصولات استفاده می‌شود توضیحات
‑‑analytics-sa اختیاری فقط هیبرید Apigee و Apigee X

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

-c,
‑‑config		 مورد نیاز همه (رشته) مسیر فایل پیکربندی سرویس راه دور Apigee.
نکته : این پرچم به شما امکان می‌دهد اکثر پارامترهای دستور دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی دریافت کند. به استفاده از گزینه ‑‑config مراجعه کنید.
-e,
‑‑environment		 مورد نیاز همه (رشته) محیطی در سازمان شما.
-f, ‑‑force-proxy-install اختیاری همه (اختیاری) اگر پروکسی remote-service از قبل در سازمان شما نصب شده باشد، آن را مجبور به نصب مجدد می‌کند.
-h,
‑‑help		 اختیاری همه راهنمای پارامترهای دستور را نمایش می‌دهد.
‑‑insecure اختیاری همه هنگام استفاده از SSL، اتصالات ناامن سرور را مجاز کنید.
‑‑legacy مورد نیاز فقط ابر عمومی Edge اگر از Apigee Edge برای فضای ابری عمومی استفاده می‌کنید، باید این پرچم را تنظیم کنید. URL های مدیریتی و زمان اجرا را برای Apigee Edge برای فضای ابری عمومی تنظیم می‌کند.
-m,
‑‑management		 مورد نیاز فقط ابر خصوصی اج (رشته) آدرس اینترنتی پایه مدیریت برای نصب Apigee Edge برای ابر خصوصی شما. پیش‌فرض: https://api.enterprise.apigee.com
‑‑mfa مورد نیاز فقط ابر عمومی Edge توکن مجوز چند عاملی برای Apigee Edge شما برای فضای ابری عمومی. فقط در صورتی لازم است که MFA در حساب Apigee Edge شما تنظیم شده باشد.
-n, ‑‑namespace اختیاری همه (رشته) پیکربندی را به عنوان یک Envoy ConfigMap در فضای نام مشخص شده منتشر می‌کند. پیش‌فرض: apigee
‑‑opdk مورد نیاز فقط ابر خصوصی اج اگر از Apigee Edge برای فضای ابری خصوصی استفاده می‌کنید، باید این پرچم را تنظیم کنید.
-o,
‑‑organization		 مورد نیاز همه (رشته) یک سازمان آپیجی. برای ارائه خدمات باید مدیر سازمان باشید.
-p,
‑‑password		 مورد نیاز
(فقط مجوز پایه)		 فقط فضای ابری عمومی و خصوصی Edge (رشته) رمز عبور Apigee شما. می‌توانید به صورت اختیاری رمز عبور را در یک
فایل .netrc . اگر این کار را انجام دهید، دیگر نیازی به ارائه رمز عبور خود در خط فرمان ندارید. همچنین به بخش استفاده از .netrc برای اعتبارنامه‌ها مراجعه کنید.
‑‑rotate-int اختیاری فقط هیبرید آپیجی (عدد صحیح) اگر n > 0، کلید خصوصی جدید ایجاد کن و n کلید عمومی نگه دار (فقط ترکیبی)
-r,
‑‑runtime		 مورد نیاز فقط Edge Private Cloud و Apigee hybrid (رشته) آدرس اینترنتی (URL) زمان اجرا را برای ابر خصوصی یا نمونه ترکیبی Apigee شما مشخص می‌کند. این آدرس اینترنتی باید با https:// شروع شود. به عنوان مثال: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca		 اختیاری فقط ابر خصوصی اج (رشته) گواهی TLS سمت کلاینت، کلید خصوصی و CA ریشه را برای اتصال mTLS مشخص می‌کند.
-t,
‑‑token		 مورد نیاز
(فقط توکن OAuth برای احراز هویت)		 همه (رشته) یک توکن OAuth یا SAML که شما از اطلاعات حساب Apigee خود تولید می‌کنید. هرگونه اعتبارنامه ارائه شده دیگر را لغو می‌کند.
-u,
‑‑username		 مورد نیاز
(فقط مجوز پایه)		 فقط فضای ابری عمومی و خصوصی Edge (رشته) نام کاربری Apigee شما (معمولاً یک آدرس ایمیل). می‌توانید به صورت اختیاری نام کاربری را در یک فایل .netrc مشخص کنید. همچنین به بخش استفاده از .netrc برای اعتبارنامه‌ها مراجعه کنید.
-v,
‑‑verbose		 اختیاری همه (اختیاری) خروجی طولانی و مفصل تولید می‌کند.
‑‑virtual-hosts اختیاری فقط ابر خصوصی اج (رشته) میزبان‌های مجازی پیش‌فرض را که default,secure لغو می‌کند. اگر میزبان‌های مجازی دیگری غیر از این پیش‌فرض‌ها برای محیط سازمانی Edge خود مشخص کرده‌اید، از این گزینه استفاده کنید.

مثال

همانطور که مثال زیر نشان می‌دهد، مهم است که خروجی دستور 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 ایجاد خواهد شد. در غیر این صورت، شما مسئول تهیه فایل‌های پیکربندی مربوط به استقرار سرویس‌های هدف خود هستید.

پارامترها

پارامترها حضور با محصولات استفاده می‌شود توضیحات
‑‑adapter‑host فقط برای قالب‌های Envoy مورد نیاز است همه (رشته) نام میزبان آداپتور (پیش‌فرض: localhost )
-c, ‑‑config مورد نیاز همه (رشته) مسیر فایل پیکربندی سرویس راه دور Apigee.
نکته : این پرچم به شما امکان می‌دهد اکثر پارامترهای دستور دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی دریافت کند. به استفاده از گزینه ‑‑config مراجعه کنید.
-f, ‑‑force اختیاری همه دایرکتوری موجود را مجبور به رونویسی کنید.
-h, ‑‑help اختیاری همه راهنمای پارامترهای دستور را نمایش می‌دهد.
‑‑host فقط برای قالب‌های Envoy مورد نیاز است همه (رشته) میزبان سرویس هدف (پیش‌فرض httpbin.org )
-n, ‑‑name مورد نیاز همه (رشته) نام سرویس هدف (پیش‌فرض httpbin.org )
‑‑out اختیاری همه (رشته) دایرکتوری که فایل‌های پیکربندی نمونه در آن ایجاد می‌شوند.
پیش‌فرض: ./samples
‑‑tag فقط برای قالب‌های Istio مورد نیاز است همه (رشته) برچسب نسخه تصویر Envoy Adapter. پیش‌فرض: v2.0.0
-t, ‑‑template مورد نیاز همه (رشته) نام الگوی Envoy یا Istio. برای مشاهده لیست الگوهای موجود، دستور apigee-remote-service samples templates اجرا کنید.
‑‑tls اختیاری، فقط برای قالب‌های Envoy همه (رشته) دایرکتوری حاوی فایل‌های tls.key و tls.crt که برای سرویس آداپتور استفاده می‌شوند.

مثال 

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

گزینه‌های قالب موجود را فهرست کنید

قالب‌های موجود برای استفاده با پارامتر --templates برای دستور samples را فهرست می‌کند.

کاربرد 

apigee-remote-service-cli samples templates

پارامترها

هیچ کدام.

مثال 

apigee-remote-service-cli samples templates
Supported templates (native is deprecated):
  envoy-1.15
  envoy-1.16
  envoy-1.17
  istio-1.7
  istio-1.8
  istio-1.9

دستورات توکن

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

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

شما می‌توانید از یک توکن JWT برای برقراری تماس‌های پروکسی API احراز هویت شده به یک هدف سرویس از راه دور استفاده کنید. همچنین به بخش «استفاده از احراز هویت مبتنی بر JWT» مراجعه کنید.

کاربرد 

apigee-remote-service-cli token create [flags]

پارامترها

پارامترها حضور با محصولات استفاده می‌شود توضیحات
-c,
‑‑config		 مورد نیاز همه (رشته) مسیر فایل پیکربندی سرویس راه دور Apigee.
نکته : این پرچم به شما امکان می‌دهد اکثر پارامترهای دستور دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی دریافت کند. به استفاده از گزینه ‑‑config مراجعه کنید.
-e,
‑‑environment		 مورد نیاز همه (رشته) محیطی در سازمان شما.
-h,
‑‑help		 اختیاری همه راهنمای پارامترهای دستور را نمایش می‌دهد.
--i, --id مورد نیاز همه (رشته) اعتبارنامه کلید موجود در برنامه توسعه‌دهنده Apigee، همانطور که در نحوه دریافت کلید API توضیح داده شده است.
‑‑insecure اختیاری همه هنگام استفاده از SSL، اتصالات ناامن سرور را مجاز کنید.
‑‑legacy مورد نیاز فقط ابر عمومی Edge اگر از Apigee Edge برای فضای ابری عمومی استفاده می‌کنید، باید این پرچم را تنظیم کنید. URL های مدیریتی و زمان اجرا را برای Apigee Edge برای فضای ابری عمومی تنظیم می‌کند.
‑‑opdk مورد نیاز فقط ابر خصوصی اج اگر از Apigee Edge برای فضای ابری خصوصی استفاده می‌کنید، باید این پرچم را تنظیم کنید.
-o,
‑‑organization		 مورد نیاز همه (رشته) یک سازمان آپیجی. شما باید مدیر سازمان باشید.
-r,
‑‑runtime		 مورد نیاز فقط Edge Private Cloud و Apigee hybrid (رشته) آدرس اینترنتی (URL) زمان اجرا را برای ابر خصوصی یا نمونه ترکیبی Apigee شما مشخص می‌کند. این آدرس اینترنتی باید با https:// شروع شود. به عنوان مثال: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret مورد نیاز همه (رشته) اعتبارنامه مخفی موجود در برنامه توسعه‌دهنده Apigee، همانطور که در نحوه دریافت کلید API توضیح داده شده است.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca		 اختیاری فقط ابر خصوصی اج (رشته) گواهی TLS سمت کلاینت، کلید خصوصی و CA ریشه را برای اتصال mTLS مشخص می‌کند.
-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 مراجعه کنید.

کاربرد 

apigee-remote-service-cli token inspect [flags]

پارامترها

پارامترها

پارامترها حضور با محصولات استفاده می‌شود توضیحات
-c,
‑‑config		 مورد نیاز همه (رشته) مسیر فایل پیکربندی سرویس راه دور Apigee.
نکته : این پرچم به شما امکان می‌دهد اکثر پارامترهای دستور دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی دریافت کند. به استفاده از گزینه ‑‑config مراجعه کنید.
-e,
‑‑environment		 مورد نیاز همه (رشته) محیطی در سازمان شما.
-f,
‑‑file		 مورد نیاز همه (رشته) فایل توکن (پیش‌فرض: stdin استفاده می‌کند)
-h,
‑‑help		 اختیاری همه راهنمای پارامترهای دستور را نمایش می‌دهد.
‑‑insecure اختیاری همه هنگام استفاده از SSL، اتصالات ناامن سرور را مجاز کنید.
‑‑legacy مورد نیاز فقط ابر عمومی Edge اگر از Apigee Edge برای فضای ابری عمومی استفاده می‌کنید، باید این پرچم را تنظیم کنید. URL های مدیریتی و زمان اجرا را برای Apigee Edge برای فضای ابری عمومی تنظیم می‌کند.
‑‑opdk مورد نیاز فقط ابر خصوصی اج اگر از Apigee Edge برای فضای ابری خصوصی استفاده می‌کنید، باید این پرچم را تنظیم کنید.
-o,
‑‑organization		 مورد نیاز همه (رشته) یک سازمان آپیجی. شما باید مدیر سازمان باشید.
-r,
‑‑runtime		 مورد نیاز فقط Edge Private Cloud و Apigee hybrid (رشته) آدرس اینترنتی (URL) زمان اجرا را برای ابر خصوصی یا نمونه ترکیبی Apigee شما مشخص می‌کند. این آدرس اینترنتی باید با https:// شروع شود. به عنوان مثال: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca		 اختیاری فقط ابر خصوصی اج (رشته) گواهی TLS سمت کلاینت، کلید خصوصی و CA ریشه را برای اتصال mTLS مشخص می‌کند.
-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 در نقشه کلید-مقدار رمزگذاری شده (KVM) آن داشته باشید. این فرآیند تولید یک جفت کلید جدید، چرخش کلید نامیده می‌شود. هنگامی که کلیدها را می‌چرخانید، یک جفت کلید خصوصی/عمومی جدید تولید و در KVM "istio" در سازمان/محیط Apigee شما ذخیره می‌شود. علاوه بر این، کلید عمومی قدیمی به همراه مقدار شناسه کلید اصلی آن حفظ می‌شود.

کاربرد 

apigee-remote-service-cli token rotate-cert [flags]

پارامترها

پارامترها حضور با محصولات استفاده می‌شود توضیحات
-c,
‑‑config		 مورد نیاز همه (رشته) مسیر فایل پیکربندی سرویس راه دور Apigee.
نکته : این پرچم به شما امکان می‌دهد اکثر پارامترهای دستور دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی دریافت کند. به استفاده از گزینه ‑‑config مراجعه کنید.
-e,
‑‑environment		 مورد نیاز همه (رشته) محیطی در سازمان شما.
-h,
‑‑help		 اختیاری فقط فضای ابری عمومی و خصوصی Edge راهنمای پارامترهای دستور را نمایش می‌دهد.
--k, --key مورد نیاز فقط فضای ابری عمومی و خصوصی Edge (رشته) کلید تأمین.
‑‑insecure اختیاری فقط فضای ابری عمومی و خصوصی Edge هنگام استفاده از SSL، اتصالات ناامن سرور را مجاز کنید.
‑‑legacy مورد نیاز فقط ابر عمومی Edge اگر از Apigee Edge برای فضای ابری عمومی استفاده می‌کنید، باید این پرچم را تنظیم کنید. URL های مدیریتی و زمان اجرا را برای Apigee Edge برای فضای ابری عمومی تنظیم می‌کند.
‑‑opdk مورد نیاز فقط ابر خصوصی اج اگر از Apigee Edge برای فضای ابری خصوصی استفاده می‌کنید، باید این پرچم را تنظیم کنید.
-o,
‑‑organization		 مورد نیاز فقط فضای ابری عمومی و خصوصی Edge (رشته) یک سازمان آپیجی. شما باید مدیر سازمان باشید.
-r,
‑‑runtime		 مورد نیاز فقط ابر خصوصی اج (رشته) آدرس اینترنتی (URL) زمان اجرا را برای ابر خصوصی یا نمونه ترکیبی Apigee شما مشخص می‌کند. این آدرس اینترنتی باید با https:// شروع شود. به عنوان مثال: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret مورد نیاز همه (رشته) راز تدارکات.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca		 اختیاری فقط ابر خصوصی اج (رشته) گواهی TLS سمت کلاینت، کلید خصوصی و CA ریشه را برای اتصال mTLS مشخص می‌کند.
--t, ‑‑truncate مورد نیاز همه (عدد صحیح) تعداد گواهی‌هایی که باید در JWKS نگهداری شوند (پیش‌فرض ۲).
-v,
‑‑verbose		 اختیاری همه (اختیاری) خروجی طولانی و مفصل تولید می‌کند.

مثال 

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

خروجی 

certificate successfully rotated

ایجاد توکن داخلی

یک توکن JWT برای تأیید فراخوانی‌های API سرویس از راه دور ایجاد کنید.

کاربرد 

apigee-remote-service-cli token internal [flags]

پارامترها

پارامترها

پارامترها حضور با محصولات استفاده می‌شود توضیحات
-c,
‑‑config		 مورد نیاز فقط هیبرید آپیجی (رشته) مسیر فایل پیکربندی سرویس راه دور Apigee.
نکته : این پرچم به شما امکان می‌دهد اکثر پارامترهای دستور دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی دریافت کند. به استفاده از گزینه ‑‑config مراجعه کنید.
-d,
‑‑duration		 مورد نیاز فقط هیبرید آپیجی (رشته) زمان معتبر JWT داخلی از زمان ایجاد (پیش‌فرض: 10m0s (10 دقیقه)).
-e,
‑‑environment		 مورد نیاز فقط هیبرید آپیجی (رشته) محیطی در سازمان شما.
-h,
‑‑help		 اختیاری فقط هیبرید آپیجی راهنمای پارامترهای دستور را نمایش می‌دهد.
‑‑insecure اختیاری فقط هیبرید آپیجی هنگام استفاده از SSL، اتصالات ناامن سرور را مجاز کنید.
-o,
‑‑organization		 مورد نیاز فقط هیبرید آپیجی (رشته) یک سازمان آپیجی. شما باید مدیر سازمان باشید.
-r,
‑‑runtime		 مورد نیاز فقط هیبرید آپیجی (رشته) آدرس اینترنتی (URL) زمان اجرا را برای نمونه هیبریدی Apigee شما مشخص می‌کند. این آدرس اینترنتی باید با https:// شروع شود. برای مثال: https://apitest.apigee-hybrid-docs.net
-v,
‑‑verbose		 اختیاری فقط هیبرید آپیجی (اختیاری) خروجی طولانی و مفصل تولید می‌کند.

دستور نسخه

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

apigee-remote-service-cli version

استفاده از .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
برای مثال در Edge Private Cloud: 
machine http://192.162.55.100
login jdoe@google.com
password abc123

استفاده از گزینه دستور ‑‑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
  tls:
    ca_file: /opt/apigee/tls/ca.crt
    cert_file: /opt/apigee/tls/tls.crt
    key_file: /opt/apigee/tls/tls.key
    allow_unverified_ssl_cert: false
products:
  refresh_rate: 2m
analytics:
  legacy_endpoint: false
  file_limit: 1024
  send_channel_size: 10
  collection_interval: 10s
auth:
  api_key_claim: claim
  api_key_cache_duration: 30m
  api_key_header: x-api-key
  api_header: :authority
  allow_unauthorized: false
  jwt_provider_key: https://org-test.apigee.net/remote-token/token
  append_metadata_headers: true