חומרי עזר

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

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

הפקודה Listings

רשימה של כל מוצרי ה-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 ל-Public Cloud.
-m,
‑‑management 		חובה ענן פרטי של Edge בלבד (מחרוזת) כתובת ה-URL של בסיס הניהול של Apigee Edge להתקנת ענן פרטי. ברירת מחדל: https://api.enterprise.apigee.com
‑‑mfa חובה ענן ציבורי של Edge בלבד (מחרוזת) אסימון הרשאה רב-שלבי עבור Apigee Edge עבור ענן ציבורי. נדרש רק אם MFA מוגדרת בחשבון Apigee Edge שלך.
‑‑opdk חובה ענן פרטי של Edge בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן פרטי.
-o,
‑‑organization 		חובה הכול (מחרוזת) ארגון ב-Apigee. אתם צריכים להיות מנהלי חשבון ארגוני.
-p,
‑‑password 		נדרש
(אימות בסיסי בלבד)		 ענן ציבורי ופרטי של Edge בלבד (מחרוזת) הסיסמה שלך ב-Apigee. אפשר לציין הסיסמה בקובץ .netrc. עוד באותו הקשר שימוש ב- .netrc לפרטי כניסה
-r,
‑‑runtime 		חובה ענן פרטי של Edge ו-Apigee היברידיות בלבד (מחרוזת) מציינת את כתובת ה-URL של סביבת זמן הריצה של המכונה של הענן הפרטי או של Apigee היברידי. כתובת ה-URL חייבת להתחיל במחרוזת https://. לדוגמה: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		אופציונלי ענן פרטי של Edge בלבד (מחרוזת) מציין אישור TLS בצד הלקוח, מפתח פרטי ורשות אישורים בסיסית עבור חיבור 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 ארגון קצה, הגדרת אישור ויצירת פרטי כניסה שצריך כדי להגדיר את מתאם Apigee ל-Envoy.

שימוש

apigee-remote-service-cli provision [flags]

פרמטרים

פרמטרים נוכחות בשימוש עם המוצרים תיאור
‑‑analytics-sa אופציונלי Apigee hybrid ו-Apigee X בלבד

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

אם משתמשים ב-Istio, שבו שרת ה-proxy של 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 כדי לבצע קריאות מאומתות ל-proxy ל-API. פקודות האסימון מאפשרות ליצור, לבדוק ולסובב אסימוני JWT למטרה הזו.

יצירת אסימון JWT

אפשר להשתמש באסימון JWT כדי לבצע קריאות מאומתות של שרת proxy ל-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 ל-Public Cloud.
‑‑opdk חובה ענן פרטי של Edge בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן פרטי.
-o,
‑‑organization 		חובה הכול (מחרוזת) ארגון ב-Apigee. אתם צריכים להיות מנהלי חשבון ארגוני.
-r,
‑‑runtime 		חובה ענן פרטי של Edge ו-Apigee היברידיות בלבד (מחרוזת) מציינת את כתובת ה-URL של סביבת זמן הריצה של המכונה של הענן הפרטי או של Apigee היברידי. כתובת ה-URL חייבת להתחיל במחרוזת https://. לדוגמה: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret חובה הכול (מחרוזת) פרטי הכניסה הסוד שנמצאו באפליקציה למפתחים של Apigee כפי שמתואר ב איך מקבלים מפתח API
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		אופציונלי ענן פרטי של Edge בלבד (מחרוזת) מציין אישור TLS בצד הלקוח, מפתח פרטי ורשות אישורים בסיסית עבור חיבור 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 בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן ציבורי. הגדרת כתובות ה-URL לניהול ולזמן הריצה ב-Apigee Edge ל-Public Cloud.
‑‑opdk חובה ענן פרטי של Edge בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן פרטי.
-o,
‑‑organization 		חובה הכול (מחרוזת) ארגון ב-Apigee. אתם צריכים להיות מנהלי חשבון ארגוני.
-r,
‑‑runtime 		חובה ענן פרטי של Edge ו-Apigee היברידיות בלבד (מחרוזת) מציינת את כתובת ה-URL של סביבת זמן הריצה של המכונה של הענן הפרטי או של Apigee היברידי. כתובת ה-URL חייבת להתחיל במחרוזת https://. לדוגמה: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		אופציונלי ענן פרטי של Edge בלבד (מחרוזת) מציין אישור TLS בצד הלקוח, מפתח פרטי ורשות אישורים בסיסית עבור חיבור 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). התהליך הזה של זוג מפתחות חדש נקרא רוטציית מפתחות. כשמבצעים רוטציה למפתחות, זוג מפתחות פרטי/ציבורי חדש נוצרת ונשמרת ב-"istio" KVM בארגון או בסביבה שלכם ב-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 ל-Public Cloud.
‑‑opdk חובה ענן פרטי של Edge בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן פרטי.
-o,
‑‑organization 		חובה ענן ציבורי ופרטי של Edge בלבד (מחרוזת) ארגון ב-Apigee. אתם צריכים להיות מנהלי חשבון ארגוני.
-r,
‑‑runtime 		חובה ענן פרטי של Edge בלבד (מחרוזת) מציינת את כתובת ה-URL של סביבת זמן הריצה של המכונה של הענן הפרטי או של Apigee היברידי. כתובת ה-URL חייבת להתחיל במחרוזת https://. לדוגמה: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret חובה הכול (מחרוזת) סוד ההקצאה.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		אופציונלי ענן פרטי של Edge בלבד (מחרוזת) מציין אישור TLS בצד הלקוח, מפתח פרטי ורשות אישורים בסיסית עבור חיבור 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.
טיפ: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של פקודות, כי ה-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 בלבד (אופציונלי) יוצר פלט מפורט.

פקודת הגרסה

מדפיסים את גרסת ה-CLI.

apigee-remote-service-cli version

שימוש ב- .netrc לפרטי כניסה

apigee-remote-service-cli אוסף באופן אוטומטי את username ואת password (לאימות בסיסי, כשנדרש) מ-.netrc בספריית הבית שלכם אם אתם משתמשים ב-Edge Public Cloud ויש לכם רשומה במחשב api.enterprise.apigee.com. אם אתם משתמשים בענן פרטי של Apigee, ערך המכונה זהה לכתובת ה-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 שולף אותן מקובץ התצורה. האפשרויות האלה כוללות:
  • ארגון
  • 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