חומרי עזר

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

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

List bindings command

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

שימוש

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

פרמטרים

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

שימוש

apigee-remote-service-cli provision [flags]

פרמטרים

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

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

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

פרמטרים

פרמטרים נוכחות השימוש במוצרים תיאור
‑‑adapter‑host נדרש רק לתבניות של Envoy הכול (מחרוזת) שם המארח של המתאם (ברירת מחדל: localhost)
-c, ‑‑config חובה הכול ‫(String) הנתיב לקובץ ההגדרות של Apigee Remote Service.
הערה: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. ‑‑config
-f, ‑‑force אופציונלי הכול להכריח את המערכת להחליף את הספרייה הקיימת.
-h, ‑‑help אופציונלי הכול הצגת עזרה לגבי פרמטרים של פקודה.
‑‑host נדרש רק לתבניות של Envoy הכול ‫(String) מארח שירות היעד (ברירת מחדל httpbin.org)
-n, ‑‑name חובה הכול ‫(String) שם שירות היעד (ברירת מחדל httpbin.org)
‑‑out אופציונלי הכול (מחרוזת) התיקייה שבה ייצרו קובצי ההגדרות לדוגמה.
ברירת מחדל: ./samples
‑‑tag נדרש רק לתבניות Istio הכול ‫(String) תג הגרסה של תמונת Envoy Adapter. ברירת מחדל: v2.0.0
-t, ‑‑template חובה הכול ‫(String) שם התבנית של Envoy או Istio. כדי לראות את רשימת התבניות הזמינות, מריצים את הפקודה apigee-remote-service samples templates.
‑‑tls אופציונלי, רק לתבניות של Envoy הכול ‫(String) הספרייה שמכילה את הקבצים 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 		חובה הכול ‫(String) הנתיב לקובץ ההגדרות של Apigee Remote Service.
הערה: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. ‑‑config
-e,
‑‑environment 		חובה הכול ‫(String) סביבה בארגון שלכם.
-h,
‑‑help 		אופציונלי הכול הצגת עזרה לגבי פרמטרים של פקודה.
--i, --id חובה הכול ‫(String) פרטי הכניסה של מפתח שנמצאים באפליקציית המפתחים של Apigee, כפי שמתואר במאמר בנושא איך מקבלים מפתח API.
‑‑insecure אופציונלי הכול אפשרות לחיבורים לא מאובטחים לשרת כשמשתמשים ב-SSL.
‑‑legacy חובה ‫Edge Public Cloud בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge for Public Cloud. מגדיר את כתובות ה-URL של הניהול ושל זמן הריצה ב-Apigee Edge for Public Cloud.
‑‑opdk חובה ‫Edge Private Cloud בלבד חובה להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge for Private Cloud.
-o,
‑‑organization 		חובה הכול (מחרוזת) ארגון Apigee. אתם צריכים להיות אדמינים בארגון.
-r,
‑‑runtime 		חובה רק ב-Edge Private Cloud וב-Apigee Hybrid ‫(String) מציין את כתובת ה-URL של זמן הריצה של הענן הפרטי או של מופע Apigee Hybrid. כתובת ה-URL חייבת להתחיל ב-https://. לדוגמה: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret חובה הכול ‫(String) פרטי הכניסה של Secret שנמצאים באפליקציית המפתחים של Apigee, כפי שמתואר במאמר בנושא איך מקבלים מפתח API.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		אופציונלי ‫Edge Private Cloud בלבד ‫(String) מציין את אישור ה-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 		חובה הכול ‫(String) הנתיב לקובץ ההגדרות של Apigee Remote Service.
הערה: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. ‑‑config
-e,
‑‑environment 		חובה הכול ‫(String) סביבה בארגון שלכם.
-f,
‑‑file 		חובה הכול ‫(String) קובץ הטוקן (ברירת מחדל: שימוש ב-stdin)
-h,
‑‑help 		אופציונלי הכול הצגת עזרה לגבי פרמטרים של פקודה.
‑‑insecure אופציונלי הכול אפשרות לחיבורים לא מאובטחים לשרת כשמשתמשים ב-SSL.
‑‑legacy חובה ‫Edge Public Cloud בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge for Public Cloud. מגדיר את כתובות ה-URL של הניהול ושל זמן הריצה ב-Apigee Edge for Public Cloud.
‑‑opdk חובה ‫Edge Private Cloud בלבד חובה להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge for Private Cloud.
-o,
‑‑organization 		חובה הכול (מחרוזת) ארגון Apigee. אתם צריכים להיות אדמינים בארגון.
-r,
‑‑runtime 		חובה רק ב-Edge Private Cloud וב-Apigee Hybrid ‫(String) מציין את כתובת ה-URL של זמן הריצה של הענן הפרטי או של מופע Apigee Hybrid. כתובת ה-URL חייבת להתחיל ב-https://. לדוגמה: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		אופציונלי ‫Edge Private Cloud בלבד ‫(String) מציין את אישור ה-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) המוצפנת שלו. התהליך הזה של יצירת זוג מפתחות חדש נקרא רוטציית מפתחות. כשמבצעים רוטציה של מפתחות, נוצר זוג חדש של מפתחות פרטיים/ציבוריים והוא מאוחסן ב-KVM ‏(Key-Value Map) ‏istio בארגון או בסביבה שלכם ב-Apigee. בנוסף, המפתח הציבורי הישן נשמר יחד עם ערך מזהה המפתח המקורי שלו.

שימוש

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

פרמטרים

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