חומרי עזר

אתם מציגים את מסמכי התיעוד של Apigee Edge.
לעיון במאמרי העזרה של Apigee X. מידע

ממשק שורת הפקודה (CLI) של apigee-remote-service-cli עוזר לכם להקצות ולנהל את Apigee Adapter ל-Envoy.

הפקודה List bindings

רשימה של כל מוצרי ה-API המשויכים לשירות המרוחק.

שימוש

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

פרמטרים

פרמטרים נוכחות שימוש במוצרים תיאור
-c,
‑‑config 		חובה הכול (מחרוזת) הנתיב לקובץ התצורה של השירות מרחוק של Apigee.
טיפ: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול למשוך אותם ישירות מקובץ התצורה. שימוש באפשרות ‑‑config
-e,
‑‑environment 		חובה הכול (מחרוזת) סביבה בארגון.
-h,
‑‑help 		אופציונלי הכול הצגת עזרה לגבי הפרמטרים של הפקודה.
‑‑insecure אופציונלי הכול מתן הרשאה לחיבורי שרת לא מאובטחים כשמשתמשים ב-SSL.
‑‑legacy חובה Edge Public Cloud בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן ציבורי. הגדרת כתובות ה-URL לניהול ולזמן ריצה של Apigee Edge for Public Cloud.
-m,
‑‑management 		חובה Edge Private Cloud בלבד (מחרוזת) כתובת ה-URL הבסיסית לניהול של התקנת Apigee Edge לענן פרטי. ברירת מחדל: https://api.enterprise.apigee.com
‑‑mfa חובה ענן ציבורי של Edge בלבד (מחרוזת) אסימון אימות רב-גורמי ל-Apigee Edge for Public Cloud. נדרש רק אם MFA מוגדר בחשבון Apigee Edge שלך.
‑‑opdk חובה ענן פרטי של Edge בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן פרטי.
-o,
‑‑organization 		חובה הכול (מחרוזת) ארגון ב-Apigee. צריכה להיות לכם הרשאת אדמין ארגוני.
-p,
‑‑password 		חובה
(אימות בסיסי בלבד)		 Edge Public ו-Edge Private Cloud בלבד (מחרוזת) הסיסמה שלכם ל-Apigee. אפשר לציין את הסיסמה בקובץ .netrc. למידע נוסף, ראו שימוש ב- .netrc לפרטי כניסה.
-r,
‑‑runtime 		חובה Edge Private Cloud ו-Apigee היברידי בלבד (מחרוזת) מציינת את כתובת ה-URL של סביבת זמן הריצה בענן הפרטי או במכונה ההיברידית של Apigee. כתובת ה-URL חייבת להתחיל ב-https://. לדוגמה: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		אופציונלי ענן פרטי של Edge בלבד (מחרוזת) מציין אישור TLS, מפתח פרטי ורשות אישורים ברמה הבסיסית (root) מצד הלקוח לחיבור 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 מתקינה שני שרתים proxy של 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, האפשרות הזו מאפשרת להתקין את זמן הריצה ההיברידי באשכול אחד ואת המתאם באשכול אחר.
-c,
‑‑config 		חובה הכול (מחרוזת) הנתיב לקובץ התצורה של השירות מרחוק של Apigee.
טיפ: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול למשוך אותם ישירות מקובץ התצורה. שימוש באפשרות ‑‑config
-e,
‑‑environment 		חובה הכול (מחרוזת) סביבה בארגון.
-f, ‑‑force-proxy-install אופציונלי הכול (אופציונלי) מאלץ את שרת ה-proxy של remote-service להתקנה מחדש אם הוא כבר מותקן בארגון.
-h,
‑‑help 		אופציונלי הכול הצגת עזרה לגבי הפרמטרים של הפקודה.
‑‑insecure אופציונלי הכול מתן הרשאה לחיבורי שרת לא מאובטחים כשמשתמשים ב-SSL.
‑‑legacy חובה Edge Public Cloud בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן ציבורי. הגדרת כתובות ה-URL לניהול ולזמן ריצה של Apigee Edge for Public Cloud.
-m,
‑‑management 		חובה Edge Private Cloud בלבד (מחרוזת) כתובת ה-URL הבסיסית לניהול של התקנת Apigee Edge לענן פרטי. ברירת מחדל: https://api.enterprise.apigee.com
‑‑mfa חובה Edge Public Cloud בלבד אסימון אימות רב-שלבי ל-Apigee Edge for Public Cloud. נדרש רק אם מוגדרת אימות דו-שלבי בחשבון Apigee Edge.
-n, ‑‑namespace אופציונלי הכול (מחרוזת) הפקת תצורה כ-ConfigMap של Envoy במרחב השמות שצוין. ברירת מחדל: apigee
‑‑opdk חובה ענן פרטי של Edge בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן פרטי.
-o,
‑‑organization 		חובה הכול (מחרוזת) ארגון ב-Apigee. רק מנהלי מערכת בארגון יכולים לנהל את ההקצאות.
-p,
‑‑password 		נדרש
(אימות בסיסי בלבד)		 Edge Public ו-Edge Private Cloud בלבד (מחרוזת) הסיסמה שלך ב-Apigee. אפשר לציין את הסיסמה בקובץ
.netrc. אם תעשו זאת, לא תצטרכו לספק את הסיסמה בשורת הפקודה. מידע נוסף זמין במאמר שימוש ב-netrc .‎ לפרטי כניסה.
‑‑rotate-int אופציונלי Apigee Hybrid בלבד (מספר שלם) אם הערך של n גדול מ-0, צריך ליצור מפתח פרטי חדש ולהשאיר את n המפתחות הציבוריים (היברידי בלבד).
-r,
‑‑runtime 		חובה Edge Private Cloud ו-Apigee היברידי בלבד (מחרוזת) מציינת את כתובת ה-URL של סביבת זמן הריצה בענן הפרטי או במכונה ההיברידית של Apigee. כתובת ה-URL חייבת להתחיל ב-https://. לדוגמה: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		אופציונלי ענן פרטי של Edge בלבד (מחרוזת) מציין אישור TLS, מפתח פרטי ורשות אישורים ברמה הבסיסית (root) מצד הלקוח לחיבור mTLS.
-t,
‑‑token 		חובה
(אימות באמצעות אסימון OAuth בלבד)		 הכול (מחרוזת) אסימון OAuth או SAML שיוצרים מפרטי החשבון ב-Apigee. ביטול של כל פרטי כניסה אחרים שסופקו.
-u,
‑‑username 		חובה
(אימות בסיסי בלבד)		 ענן ציבורי ופרטי של Edge בלבד (מחרוזת) שם המשתמש שלכם ב-Apigee (בדרך כלל כתובת אימייל). אפשר לציין את שם המשתמש בקובץ .netrc. אפשר גם לעיין במאמר שימוש ב-netrc .‎ לפרטי כניסה.
-v,
‑‑verbose 		אופציונלי הכול (אופציונלי) יוצר פלט מפורט.
‑‑virtual-hosts אופציונלי ענן פרטי של Edge בלבד (מחרוזת) המדיניות הזו מבטלת את המארחים הווירטואליים שמוגדרים כברירת מחדל, 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

הפקודה Samples

יצירת קובצי תצורה לדוגמה ורישום שלהם.

יצירת קובצי תצורה לדוגמה

יצירת קובצי תצורה לדוגמה לפריסות מקוריות של Envoy ו-Istio.

שימוש

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

תיאור

הפקודה הזו דורשת קובץ config.yaml תקין כקלט. קובץ הקלט הזה הוא הקובץ שנוצר באמצעות הקצאה. כברירת מחדל, קובצי הדוגמה מועברים לספרייה בשם ./samples. הפקודה יוצרת את הספרייה הזו בשבילכם.

אם משתמשים ב-Envoy מקורי, הפקודה מקבלת את מארח השירות היעד ואת השם הרצוי לאשכולות שלו. הוא גם מגדיר חיבור SSL בהתאמה אישית Proxy של Envoy לאשכול השירות המרוחק, אם תיקייה שמכילה את tls.key ואת tls.crt מסופקת דרך --tls.

אם אתם משתמשים ב-Istio, שבו שרת ה-Proxy של Envoy פועל בתור sidecar, אם לא מציינים יעד, המערכת תיצור את הדוגמה httpbin. אם לא, אתם אחראים להכין את קובצי ההגדרות שקשורים לפריסה של שירותי היעד.

פרמטרים

פרמטרים נוכחות שימוש במוצרים תיאור
‑‑adapter‑host נדרש בתבניות של Envoy בלבד הכול (מחרוזת) שם המארח של המתאם (ברירת המחדל: localhost)
-c, ‑‑config חובה הכול (מחרוזת) הנתיב לקובץ התצורה של שירות Apigee Remote.
טיפ: הדגל הזה מאפשר להשמיט את רוב הפרמטרים של הפקודות, כי ה-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

פקודות של אסימונים

אפשר להשתמש באסימון JWT כדי לבצע קריאות proxy מאומתות ל-API במקום להשתמש במפתח API. הפקודות של האסימונים מאפשרות ליצור, לבדוק ולבצע רוטציה של אסימוני JWT למטרה הזו.

יצירת טוקן JWT

אפשר להשתמש באסימון JWT כדי לבצע קריאות proxy מאומתות של 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 לענן ציבורי. הגדרת כתובות ה-URL לניהול ולזמן ריצה של Apigee Edge for Public Cloud.
‑‑opdk חובה ענן פרטי של Edge בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן פרטי.
-o,
‑‑organization 		חובה הכול (מחרוזת) ארגון ב-Apigee. אתם צריכים להיות מנהלי חשבון ארגוני.
-r,
‑‑runtime 		חובה Edge Private Cloud ו-Apigee היברידי בלבד (מחרוזת) מציינת את כתובת ה-URL של סביבת זמן הריצה בענן הפרטי או במכונה ההיברידית של Apigee. כתובת ה-URL חייבת להתחיל ב-https://. לדוגמה: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret חובה הכול (מחרוזת) פרטי הכניסה של Secret שנמצאים באפליקציית המפתחים של Apigee, כפי שמתואר בקטע איך מקבלים מפתח API.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		אופציונלי ענן פרטי של Edge בלבד (מחרוזת) מציין אישור TLS, מפתח פרטי ורשות אישורים ברמה הבסיסית (root) מצד הלקוח לחיבור 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.
טיפ: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול למשוך אותם ישירות מקובץ התצורה. ראו שימוש באפשרות ‑‑config.
-e,
‑‑environment 		חובה הכול (מחרוזת) סביבה בארגון.
-f,
‑‑file 		חובה הכול (מחרוזת) קובץ האסימונים (ברירת המחדל: שימוש ב-stdin)
-h,
‑‑help 		אופציונלי הכול הצגת עזרה לגבי הפרמטרים של הפקודה.
‑‑insecure אופציונלי הכול מתן הרשאה לחיבורי שרת לא מאובטחים כשמשתמשים ב-SSL.
‑‑legacy חובה Edge Public Cloud בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן ציבורי. הגדרת כתובות ה-URL לניהול ולזמן ריצה של Apigee Edge for Public Cloud.
‑‑opdk חובה ענן פרטי של Edge בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן פרטי.
-o,
‑‑organization 		חובה הכול (מחרוזת) ארגון ב-Apigee. אתם צריכים להיות מנהלי חשבון ארגוני.
-r,
‑‑runtime 		חובה Edge Private Cloud ו-Apigee היברידי בלבד (מחרוזת) מציינת את כתובת ה-URL של סביבת זמן הריצה בענן הפרטי או במכונה ההיברידית של Apigee. כתובת ה-URL חייבת להתחיל ב-https://. לדוגמה: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		אופציונלי ענן פרטי של Edge בלבד (מחרוזת) מציין אישור TLS, מפתח פרטי ורשות אישורים ברמה הבסיסית (root) מצד הלקוח לחיבור 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 Public ו-Edge Private Cloud בלבד הצגת עזרה לגבי הפרמטרים של הפקודה.
--k, --key חובה Edge Public ו-Edge Private Cloud בלבד (מחרוזת) מפתח ההקצאה.
‑‑insecure אופציונלי Edge Public ו-Edge Private Cloud בלבד מתן הרשאה לחיבורי שרת לא מאובטחים כשמשתמשים ב-SSL.
‑‑legacy חובה Edge Public Cloud בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן ציבורי. הגדרת כתובות ה-URL לניהול ולזמן ריצה של Apigee Edge for Public Cloud.
‑‑opdk חובה ענן פרטי של Edge בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן פרטי.
-o,
‑‑organization 		חובה Edge Public ו-Edge Private Cloud בלבד (מחרוזת) ארגון ב-Apigee. צריכה להיות לכם הרשאת אדמין ארגוני.
-r,
‑‑runtime 		חובה Edge Private Cloud בלבד (מחרוזת) מציינת את כתובת ה-URL של סביבת זמן הריצה בענן הפרטי או במכונה ההיברידית של Apigee. כתובת ה-URL חייבת להתחיל ב-https://. לדוגמה: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret חובה הכול (מחרוזת) הסוד להקצאה.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		אופציונלי ענן פרטי של Edge בלבד (מחרוזת) מציין אישור TLS, מפתח פרטי ורשות אישורים ברמה הבסיסית (root) מצד הלקוח לחיבור 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 Hybrid בלבד (מחרוזת) הנתיב לקובץ התצורה של Apigee Remote Service.
טיפ: הדגל הזה מאפשר להשמיט את רוב הפרמטרים של הפקודות, כי ה-CLI יכול לשלוף אותם ישירות מקובץ התצורה. ראו שימוש באפשרות ‑‑config.
-d,
‑‑duration 		חובה Apigee Hybrid בלבד (מחרוזת) משך הזמן התקף של אסימון ה-JWT הפנימי מיום היצירה שלו (ברירת המחדל: 10m0s (10 דקות)).
-e,
‑‑environment 		חובה Apigee hybrid בלבד (מחרוזת) סביבה בארגון.
-h,
‑‑help 		אופציונלי Apigee Hybrid בלבד הצגת עזרה לגבי הפרמטרים של הפקודה.
‑‑insecure אופציונלי Apigee Hybrid בלבד מתן הרשאה לחיבורי שרת לא מאובטחים כשמשתמשים ב-SSL.
-o,
‑‑organization 		חובה Apigee hybrid בלבד (מחרוזת) ארגון ב-Apigee. אתם צריכים להיות מנהלי חשבון ארגוני.
-r,
‑‑runtime 		חובה Apigee Hybrid בלבד (מחרוזת) מציין את כתובת ה-URL של סביבת זמן הריצה למכונה ההיברידית של Apigee. כתובת ה-URL חייבת להתחיל ב-https://. לדוגמה: https://apitest.apigee-hybrid-docs.net
-v,
‑‑verbose 		אופציונלי Apigee Hybrid בלבד (אופציונלי) יוצר פלט מפורט.

פקודה לקבלת גרסת ה-API

מדפיסים את גרסת ה-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: 
machine http://192.162.55.100
login jdoe@google.com
password abc123

שימוש באפשרות הפקודה ‑‑config

האפשרות ‑‑config מציינת את המיקום של קובץ התצורה שנוצר באמצעות הפקודה provision. היתרון של האפשרות הזו הוא שאפשר לדלג על רוב הפרמטרים האחרים של הפקודה, שה-CLI שולף מקובץ התצורה. האפשרויות האלה כוללות:
  • ארגון
  • environment
  • זמן ריצה
  • סרטונים
  • לא מאובטח
  • מרחב שמות
  • מדור קודם
  • 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