این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

ارجاع

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

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

دستور List bindings

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

استفاده

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

پارامترها

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

استفاده

apigee-remote-service-cli provision [flags]

پارامترها

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

مثال

همانطور که مثال زیر نشان می دهد، مهم است که خروجی دستور provision را در یک فایل ضبط کنید، که به عنوان ورودی برای سایر عملیات Apigee Adapter برای 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 Remote Service. نکته : این پرچم به شما اجازه می دهد تا اکثر پارامترهای دستوری دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی خارج کند. به استفاده از گزینه `‑‑config` مراجعه کنید.
`-f, ‑‑force`	اختیاری	همه	دایرکتوری موجود را مجبور به رونویسی کنید.
`-h, ‑‑help`	اختیاری	همه	راهنمایی برای پارامترهای فرمان را نمایش می دهد.
`‑‑host`	فقط برای قالب های Envoy مورد نیاز است	همه	(رشته) میزبان سرویس هدف (پیش فرض `httpbin.org` )
`-n, ‑‑name`	مورد نیاز	همه	(رشته) نام سرویس هدف (پیش فرض `httpbin.org` )
`‑‑out`	اختیاری	همه	(رشته) دایرکتوری که در آن فایل های پیکربندی نمونه ایجاد می شود. پیش فرض: `./samples`
`‑‑tag`	فقط برای قالب های ایستیو مورد نیاز است	همه	(رشته) تگ نسخه تصویر آداپتور Envoy. پیش فرض: `v2.0.0`
`-t, ‑‑template`	مورد نیاز	همه	(رشته) نام قالب فرستاده یا ایستیو. برای مشاهده لیست قالب های موجود، دستور `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 Remote Service. نکته : این پرچم به شما اجازه می دهد تا اکثر پارامترهای دستوری دیگر را حذف کنید، زیرا CLI قادر است آنها را مستقیماً از فایل پیکربندی خارج کند. به استفاده از گزینه `‑‑config` مراجعه کنید.
`-e, ‑‑environment`	مورد نیاز	همه	(رشته) محیطی در سازمان شما.
`-h, ‑‑help`	اختیاری	همه	راهنمایی برای پارامترهای فرمان را نمایش می دهد.
`--i, --id`	مورد نیاز	همه	(رشته) اعتبار کلید موجود در برنامه توسعه دهنده Apigee همانطور که در نحوه به دست آوردن یک کلید API توضیح داده شده است.
`‑‑insecure`	اختیاری	همه	هنگام استفاده از SSL، اتصالات سرور ناامن را مجاز کنید.
`‑‑legacy`	مورد نیاز	فقط Edge Public Cloud	اگر از Apigee Edge برای Public Cloud استفاده می کنید، باید این پرچم را تنظیم کنید. URL های مدیریت و زمان اجرا را برای Apigee Edge برای Public Cloud تنظیم می کند.
`‑‑opdk`	مورد نیاز	فقط Edge Private Cloud	اگر از Apigee Edge برای Private Cloud استفاده می کنید، باید این پرچم را تنظیم کنید.
`-o, ‑‑organization`	مورد نیاز	همه	(رشته) سازمان Apigee. شما باید یک مدیر سازمان باشید.
`-r, ‑‑runtime`	مورد نیاز	فقط Edge Private Cloud و Apigee هیبریدی	(رشته) URL زمان اجرا را برای نمونه ترکیبی Private Cloud یا Apigee شما مشخص می کند. URL باید با `https://` شروع شود. به عنوان مثال: `https://apitest.apigee-hybrid-docs.net`
`--s, ‑‑secret`	مورد نیاز	همه	(رشته) اعتبار مخفی موجود در برنامه توسعه دهنده Apigee همانطور که در نحوه به دست آوردن یک کلید API توضیح داده شده است.
`‑‑tls‑cert ‑‑tls‑key ‑‑tls‑ca`	اختیاری	فقط Edge Private Cloud	(رشته) گواهی 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 را بررسی کنید. همچنین به بررسی یک نشانه مراجعه کنید.

استفاده

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

پارامترها

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

دستور نسخه

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

apigee-remote-service-cli version

استفاده از 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

با استفاده از گزینه دستور `‑‑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

ارجاع

دستور List bindings

استفاده

پارامترها

مثال

خروجی نمونه

فرمان راهنما

دستور تامین

استفاده

پارامترها

مثال

دستور نمونه ها

فایل های پیکربندی نمونه ایجاد کنید

استفاده

توضیحات

پارامترها

مثال

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

استفاده

پارامترها

مثال

دستورات توکن

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

استفاده

پارامترها

مثال

خروجی

یک توکن JWT را بررسی کنید

استفاده

پارامترها

پارامترها

مثال

خروجی

یک توکن JWT را بچرخانید

استفاده

پارامترها

مثال

خروجی

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

استفاده

پارامترها

پارامترها

دستور نسخه

استفاده از netrc برای اعتبار

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

فایل پیکربندی

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