חומרי עזר

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

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

פישוט פקודות CLI באמצעות האפשרות ‑‑config

האפשרות ‑‑config מציינת את המיקום של קובץ config.yaml שנוצר על ידי הפקודה provision. יתרון חשוב של האפשרות הזו הוא שאפשר לדלג על רוב פרמטרי הפקודה האחרים, כי ה-CLI שולף אותם ישירות מקובץ config.yaml.

שימו לב: כל פרמטר שצוין בשורת הפקודה מבטל את הערכים בקובץ config.yaml.

האפשרויות האלה כוללות:
  • ארגון
  • environment
  • סביבת זמן ריצה
  • ניהול
  • לא מאובטח
  • מרחב שמות
  • מדורה קודם
  • opdk

אפשר להשתמש באפשרות הזו כשמשדרגים את המתאם, אבל במקרה כזה עדיין צריך לכלול את הדגל --force-proxy-install. לדוגמה, אפשר להריץ את הפקודה provision כך: 

apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml

שימו לב: אם לא משנים אף ערך בקובץ ההגדרות הישן, אין צורך לשמור קובץ חדש כי הוא יהיה זהה למקורי.

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

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

Usage

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

פרמטרים

פרמטרים נוכחות המוצרים שבהם נעשה שימוש תיאור
-c,
‑‑config 		אופציונלי הכול ‫(String) הנתיב לקובץ ההגדרות של Apigee Remote Service.
טיפ: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. אפשר לעיין במאמר ‑‑configשימוש באפשרות ‑‑config.
-e,
‑‑environment 		אופציונלי אם השדה --config קיים, אחרת הוא שדה חובה. הכול ‫(String) סביבה בארגון שלכם.
-h,
‑‑help 		אופציונלי הכול הצגת עזרה לגבי פרמטרים של פקודות.
‑‑insecure אופציונלי הכול אפשרות להשתמש בחיבורים לא מאובטחים לשרת כשמשתמשים ב-SSL.
‑‑legacy לא רלוונטי ‫Edge Public Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
-m,
‑‑management 		לא רלוונטי ‫Edge Private Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
‑‑mfa לא רלוונטי ‫Edge Public Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
‑‑opdk לא רלוונטי ‫Edge Private Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
-o,
‑‑organization 		אופציונלי אם השדה --config קיים, אחרת הוא שדה חובה. הכול ‫(String) ארגון Apigee. אתם צריכים להיות אדמינים בארגון.
-p,
‑‑password 		לא רלוונטי
(אימות בסיסי בלבד)		 ‫Edge Public Cloud ו-Private Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
-r,
‑‑runtime 		אופציונלי אם השדה --config קיים, אחרת הוא שדה חובה. Apigee Hybrid בלבד ‫(String) מציין את כתובת ה-URL של זמן הריצה עבור הענן הפרטי או מופע Apigee Hybrid. כתובת ה-URL חייבת להתחיל ב-https://. לדוגמה: https://apitest.example.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		לא רלוונטי ‫Edge Private Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
-t,
‑‑token 		נדרש
(אימות טוקן OAuth בלבד)		 הכול ‫(String) טוקן OAuth או SAML שנוצר מפרטי החשבון שלכם ב-Apigee. הטוקן מבטל את כל האישורים האחרים שסופקו.
-u,
‑‑username 		לא רלוונטי
(Basic Auth Only)		 ‫Edge Public Cloud ו-Private Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
-v,
‑‑verbose 		אופציונלי הכול (אופציונלי) יוצר פלט מפורט.

דוגמה

apigee-remote-service-cli bindings list -o myorg -e test --token $TOKEN \
-c config.yaml

פלט לדוגמה 

API 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.

Usage

apigee-remote-service-cli provision [flags]

פרמטרים

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

‫(String) משתמשים בדגל הזה כדי לציין את הנתיב לקובץ מפתח של חשבון שירות ב-Google Cloud, שבו לחשבון השירות יש תפקיד Apigee Analytics Agent. המתאם משתמש בחשבון השירות כדי להעלות נתונים אנליטיים ישירות ל-Apigee. האפשרות הזו מאפשרת למתאם להעלות נתונים אנליטיים בלי שיהיו פרטי כניסה שמוגדרים כברירת מחדל לאפליקציה במארח. אם לא מציינים את האפשרות הזו, המתאם משתמש בפרטי הכניסה של חשבון השירות שמוגדר כברירת מחדל.
-c,
‑‑config 		אופציונלי הכול ‫(String) הנתיב לקובץ ההגדרות של Apigee Remote Service.
טיפ: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. אפשר לעיין במאמר --configשימוש באפשרות --config.
-e,
‑‑environment 		אופציונלי אם השדה --config קיים, אחרת הוא שדה חובה. הכול ‫(String) סביבה בארגון שלכם.
-f, ‑‑force-proxy-install אופציונלי הכול (אופציונלי) מאלץ את התקנת ה-proxy של remote-service מחדש אם הוא כבר מותקן בארגון.
-h,
‑‑help 		אופציונלי הכול הצגת עזרה לגבי פרמטרים של פקודות.
‑‑insecure אופציונלי הכול אפשרות להשתמש בחיבורים לא מאובטחים לשרת כשמשתמשים ב-SSL.
‑‑legacy לא רלוונטי ‫Edge Public Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
-m,
‑‑management 		לא רלוונטי ‫Edge Private Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
‑‑mfa לא רלוונטי ‫Edge Public Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
-n, ‑‑namespace אופציונלי אם מצוין --config. ברירת המחדל היא apigee. לפריסות Kubernetes בלבד ‫(String) פליטת ההגדרה כ-Envoy ConfigMap במרחב השמות שצוין. ברירת מחדל: apigee
‑‑opdk לא רלוונטי ‫Edge Private Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
-o,
‑‑organization 		אופציונלי אם השדה --config קיים, אחרת הוא שדה חובה. הכול ‫(String) ארגון Apigee. כדי להקצות משאבים, צריך להיות אדמין בארגון.
-p,
‑‑password 		לא רלוונטי
(אימות בסיסי בלבד)		 ‫Edge Public Cloud ו-Private Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
‑‑rotate אופציונלי ‫Apigee Hybrid בלבד ‫(Integer) אם n > 0, המערכת יוצרת מפתח פרטי חדש ושומרת n מפתחות ציבוריים (רק היברידי)
-r,
‑‑runtime 		אופציונלי אם השדה --config קיים, אחרת הוא שדה חובה. Apigee Hybrid בלבד ‫(String) מציין את כתובת ה-URL של זמן הריצה של מופע Apigee Hybrid. כתובת ה-URL חייבת להתחיל ב-https://. לדוגמה: https://apitest.example.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		לא רלוונטי ‫Edge Private Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
-t,
‑‑token 		נדרש
(אימות טוקן OAuth בלבד)		 הכול ‫(String) טוקן OAuth או SAML שנוצר מפרטי החשבון שלכם ב-Apigee. הטוקן מבטל את כל האישורים האחרים שסופקו.
-u,
‑‑username 		לא רלוונטי
(Basic Auth Only)		 ‫Edge Public Cloud ו-Private Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
-v,
‑‑verbose 		אופציונלי הכול (אופציונלי) יוצר פלט מפורט.
‑‑virtual-hosts לא רלוונטי ‫Edge Private Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.

דוגמה

כפי שמוצג בדוגמה הבאה, חשוב לשמור את הפלט של הפקודה provision בקובץ, שמשמש כקלט לפעולות אחרות של Apigee Adapter ל-Envoy.

דוגמה: 

apigee-remote-service-cli provision --legacy --mfa $MFA --username $USER --password $PASSWORD \
--organization $ORG --environment $ENV > config.yaml

הפקודה Samples

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

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

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

Usage

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 הכול ‫(String) שם המארח של המתאם (ברירת מחדל: localhost)
-c, ‑‑config חובה הכול ‫(String) הנתיב לקובץ ההגדרות של Apigee Remote Service.
הערה: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. --config
-f, ‑‑force אופציונלי הכול כופה החלפה של הספרייה הקיימת.
-h, ‑‑help אופציונלי הכול הצגת עזרה לגבי פרמטרים של פקודות.
‑‑host משמש רק לתבניות של Envoy הכול ‫(String) מארח שירות היעד (ברירת מחדל httpbin.org)
-n, ‑‑name אופציונלי הכול ‫(String) שם שירות היעד (ברירת מחדל httpbin.org)
‑‑out אופציונלי הכול ‫(String) התיקייה שבה ייצרו קובצי ההגדרות לדוגמה.
ברירת מחדל: ./samples
‑‑tag משמש רק לתבניות של Istio הכול ‫(String) תג הגרסה של תמונת Envoy Adapter. ברירת מחדל: הגרסה הנוכחית
-t, ‑‑template אופציונלי הכול ‫(String) שם התבנית של Envoy או Istio. כדי לראות את רשימת התבניות הזמינות, מריצים את הפקודה apigee-remote-service samples templates. ברירת מחדל: istio-1.9. ברירת המחדל פועלת בכל הגרסאות של Istio מגרסה 1.9 ואילך.
‑‑tls אופציונלי, רק לתבניות של Envoy הכול ‫(String) הספרייה שמכילה את הקבצים tls.key ו-tls.crt שמשמשים לשירות המתאם.

דוגמה 

apigee-remote-service-cli samples create -c ./config.yaml

הצגת אפשרויות התבניות הזמינות

מציגה את רשימת התבניות שאפשר להשתמש בהן עם הפרמטר --templates בפקודה samples.

Usage

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.

Usage

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

פרמטרים

פרמטרים נוכחות המוצרים שבהם נעשה שימוש תיאור
-c,
‑‑config 		חובה הכול ‫(String) הנתיב לקובץ ההגדרות של Apigee Remote Service.
טיפ: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. אפשר לעיין במאמר --configשימוש באפשרות --config.
-e,
‑‑environment 		אופציונלי אם השדה --config קיים, אחרת הוא שדה חובה. הכול ‫(String) סביבה בארגון שלכם.
-h,
‑‑help 		אופציונלי הכול הצגת עזרה לגבי פרמטרים של פקודות.
--i, --id חובה הכול ‫(String) פרטי הכניסה של מפתח שנמצאים באפליקציית המפתחים של Apigee, כפי שמתואר במאמר בנושא איך מקבלים מפתח API.
‑‑insecure אופציונלי הכול אפשרות להשתמש בחיבורים לא מאובטחים לשרת כשמשתמשים ב-SSL.
‑‑legacy לא רלוונטי ‫Edge Public Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
‑‑opdk לא רלוונטי ‫Edge Private Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
-o,
‑‑organization 		אופציונלי אם השדה --config קיים, אחרת הוא שדה חובה. הכול ‫(String) ארגון Apigee. אתם צריכים להיות אדמינים בארגון.
-r,
‑‑runtime 		אופציונלי אם השדה --config קיים, אחרת הוא שדה חובה. Apigee Hybrid בלבד ‫(String) מציין את כתובת ה-URL של זמן הריצה עבור הענן הפרטי או מופע Apigee Hybrid. כתובת ה-URL חייבת להתחיל ב-https://. לדוגמה: https://apitest.example.net
--s, ‑‑secret חובה הכול ‫(String) פרטי הכניסה Secret שנמצאים באפליקציית המפתחים של Apigee, כפי שמתואר במאמר בנושא איך מקבלים מפתח API.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		לא רלוונטי ‫Edge Private Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
-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 באמצעות הפקודה הזו. אפשר לעיין גם במאמר בדיקת אסימון.

Usage

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

פרמטרים

פרמטרים

פרמטרים נוכחות המוצרים שבהם נעשה שימוש תיאור
-c,
‑‑config 		חובה הכול ‫(String) הנתיב לקובץ ההגדרות של Apigee Remote Service.
טיפ: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. אפשר לעיין במאמר ‑‑configשימוש באפשרות ‑‑config.
-e,
‑‑environment 		אופציונלי אם קיים הערך --config, אחרת חובה. הכול ‫(String) סביבה בארגון שלכם.
-f,
‑‑file 		חובה הכול ‫(String) קובץ האסימון (ברירת מחדל: שימוש ב-stdin)
-h,
‑‑help 		אופציונלי הכול הצגת עזרה לגבי פרמטרים של פקודות.
‑‑insecure אופציונלי הכול אפשרות להשתמש בחיבורים לא מאובטחים לשרת כשמשתמשים ב-SSL.
‑‑legacy לא רלוונטי ‫Edge Public Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
‑‑opdk לא רלוונטי ‫Edge Private Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
-o,
‑‑organization 		אופציונלי אם השדה --config קיים, אחרת הוא שדה חובה. הכול ‫(String) ארגון Apigee. אתם צריכים להיות אדמינים בארגון.
-r,
‑‑runtime 		אופציונלי אם השדה --config קיים, אחרת הוא שדה חובה. Apigee Hybrid בלבד ‫(String) מציין את כתובת ה-URL של זמן הריצה עבור הענן הפרטי או מופע Apigee Hybrid. כתובת ה-URL חייבת להתחיל ב-https://. לדוגמה: https://apitest.example.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		לא רלוונטי ‫Edge Private Cloud בלבד הפרמטר הזה לא רלוונטי להתקנות של Apigee.
-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. בנוסף, המפתח הציבורי הישן נשמר יחד עם ערך מזהה המפתח המקורי שלו.

Usage

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

פרמטרים

פרמטרים נוכחות המוצרים שבהם נעשה שימוש תיאור
-c,
‑‑config 		חובה הכול ‫(String) הנתיב לקובץ ההגדרות של Apigee Remote Service.
טיפ: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. אפשר לעיין במאמר --configשימוש באפשרות --config.
-e,
‑‑environment 		אופציונלי אם קיים הערך --config, אחרת חובה. הכול ‫(String) סביבה בארגון שלכם.
-h,
‑‑help 		לא רלוונטי ‫Edge Public Cloud ו-Private Cloud בלבד הצגת עזרה לגבי פרמטרים של פקודות.
--k, --key לא רלוונטי ‫Edge Public Cloud ו-Private Cloud בלבד ‫(String) מפתח ההקצאה.
‑‑insecure לא רלוונטי ‫Edge Public Cloud ו-Private Cloud בלבד אפשרות להשתמש בחיבורים לא מאובטחים לשרת כשמשתמשים ב-SSL.
‑‑legacy לא רלוונטי ‫Edge Public Cloud בלבד צריך להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן ציבורי. מגדיר את כתובות ה-URL של הניהול וזמן הריצה עבור Apigee Edge for Public Cloud.
‑‑opdk לא רלוונטי ‫Edge Private Cloud בלבד חובה להגדיר את הדגל הזה אם משתמשים ב-Apigee Edge לענן פרטי.
-o,
‑‑organization 		אופציונלי אם השדה --config קיים, אחרת הוא שדה חובה. ‫Edge Public Cloud ו-Private Cloud בלבד ‫(String) ארגון Apigee. אתם צריכים להיות אדמינים בארגון.
-r,
‑‑runtime 		לא רלוונטי ‫Edge Private Cloud בלבד ‫(String) מציין את כתובת ה-URL של זמן הריצה עבור הענן הפרטי או מופע Apigee Hybrid. כתובת ה-URL חייבת להתחיל ב-https://. לדוגמה: https://apitest.example.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 של שירות מרוחק.

Usage

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

פרמטרים

פרמטרים

פרמטרים נוכחות המוצרים שבהם נעשה שימוש תיאור
-c,
‑‑config 		חובה Apigee Hybrid בלבד ‫(String) הנתיב לקובץ ההגדרות של Apigee Remote Service.
טיפ: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ ההגדרות. אפשר לעיין במאמר --configשימוש באפשרות --config.
-d,
‑‑duration 		חובה Apigee Hybrid בלבד (מחרוזת) משך הזמן שתוקף טוקן ה-JWT הפנימי תקף מרגע היצירה (ברירת מחדל: 10m0s (10 דקות)).
-e,
‑‑environment 		אופציונלי אם השדה --config קיים, אחרת הוא שדה חובה. Apigee Hybrid בלבד ‫(String) סביבה בארגון שלכם.
-h,
‑‑help 		אופציונלי Apigee Hybrid בלבד הצגת עזרה לגבי פרמטרים של פקודות.
‑‑insecure אופציונלי Apigee Hybrid בלבד אפשרות להשתמש בחיבורים לא מאובטחים לשרת כשמשתמשים ב-SSL.
-o,
‑‑organization 		אופציונלי אם קיים הערך --config, אחרת חובה. Apigee Hybrid בלבד ‫(String) ארגון Apigee. אתם צריכים להיות אדמינים בארגון.
-r,
‑‑runtime 		אופציונלי אם השדה --config קיים, אחרת הוא שדה חובה. Apigee Hybrid בלבד ‫(String) מציין את כתובת ה-URL של זמן הריצה של מופע Apigee Hybrid. כתובת ה-URL חייבת להתחיל ב-https://. לדוגמה: https://apitest.example.net
-v,
‑‑verbose 		אופציונלי Apigee Hybrid בלבד (אופציונלי) יוצר פלט מפורט.

פקודת גרסה

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

apigee-remote-service-cli version

קובץ תצורה

בקטע הזה מוצגת דוגמה לקובץ הגדרות עם כל האפשרויות הזמינות. 

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