مرجع

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

«میانای خط فرمان» apigee-remote-service-cli به شما کمک می‌کند «وقث‌دهنده Apigee برای Envoy» را تدارک ببینید و مدیریت کنید.

فرمان فهرست پیوندها

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

کاربرد

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

پارامترها

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

فرمان راهنما

برای همه فرمان‌های 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 را در سازمان Apigee Edge شما نصب می‌کند، گواهینامه‌ای راه‌اندازی می‌کند، و اطلاعات اعتباری تولید می‌کند که برای پیکربندی «آداپتور Apigee برای Envoy» به آن‌ها نیاز خواهید داشت.

کاربرد

apigee-remote-service-cli provision [flags]

پارامترها

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

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

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

مثال

همان‌طور که مثال زیر نشان می‌دهد، مهم است که برونداد فرمان provision را در فایلی ضبط کنید که به‌عنوان ورودی برای سایر عملیات «آداپتور Apigee برای 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 معتبر به‌عنوان ورودی نیاز دارد. این فایل ورودی فایلی است که ازطریق آماده‌سازی تولید شده است. به‌طور پیش‌فرض، فایل‌های نمونه در دایرکتوری‌ای به‌نام ./samples برونداد می‌شوند. این فرمان این دایرکتوری را برای شما ایجاد می‌کند.

اگر از Envoy بومی استفاده می‌کنید، این فرمان میزبان سرویس هدف و نام موردنظر را برای خوشه‌اش می‌گیرد. اگر پوشه‌ای حاوی tls.key و tls.crt ازطریق --tls ارائه شود، اتصال SSL سفارشی را نیز از پراکسی Envoy به خوشه سرویس راه دور تنظیم می‌کند.

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

پارامترها

پارامترها حضور استفاده‌شده با محصولات شرح
‑‑adapter‑host فقط برای الگوهای Envoy الزامی است همه (رشته) نام میزبان آداپتور (پیش‌فرض: localhost)
-c, ‑‑config الزامی همه (رشته) مسیر فایل پیکربندی «سرویس از دور Apigee».
نکته: این پرچم به شما امکان می‌دهد اکثر پارامترهای فرمان دیگر را حذف کنید، زیرا «میانای خط فرمان» می‌تواند آن‌ها را مستقیماً از فایل پیکربندی بکشد. استفاده از گزینه ‑‑config را ببینید.
-f, ‑‑force اختیاری همه فهرست راهنمای موجود را مجبور به رونویسی کنید.
-h, ‑‑help اختیاری همه راهنمای پارامترهای فرمان را نمایش می‌دهد.
‑‑host فقط برای الگوهای Envoy الزامی است همه (رشته) میزبان سرویس هدف (پیش‌فرض httpbin.org)
-n, ‑‑name الزامی همه (رشته) نام سرویس هدف (پیش‌فرض httpbin.org)
‑‑out اختیاری همه (رشته) دایرکتوری که فایل‌های پیکربندی نمونه در آن ایجاد می‌شود.
پیش‌فرض: ./samples
‑‑tag فقط برای الگوهای Istio الزامی است همه (رشته) برچسب نسخه تصویر «وقث‌دهنده Envoy». پیش‌فرض: 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

فرمان‌های کد

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

ایجاد کردن نشان JWT

می‌توانید از یک نشان JWT برای برقراری تماس‌های پراکسی API اصیل‌سازی‌شده به هدف سرویس راه دور استفاده کنید. همچنین استفاده از اصالت‌سنجی مبتنی بر JWT را ببینید.

کاربرد

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

پارامترها

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

کاربرد

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

پارامترها

پارامترها

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

کاربرد

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

پارامترها

پارامترها

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

فرمان نسخه

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

apigee-remote-service-cli version

استفاده از .netrc برای اعتبارنامه‌ها

اگر در «ابر عمومی Edge» هستید و ورودی‌ای برای ماشین api.enterprise.apigee.com دارید، apigee-remote-service-cli به‌طور خودکار username و password (برای اصالت‌سنجی پایه درصورت نیاز) را از فایل .netrc در دایرکتوری خانه شما برمی‌دارد. اگر در Apigee Private Cloud هستید، مقدار ماشین همان نشانی وب 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 آن‌ها را از فایل پیکربندی می‌کشد. این گزینه‌ها شامل موارد زیر است:
  • سازمان
  • محیط
  • زمان اجرا
  • مدیریت
  • ناامن
  • فضای نام
  • قدیمی
  • 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
  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