חומרי עזר

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X.
מידע

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

פקודה של קישורי רשימה

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

Usage

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

פרמטרים

פרמטרים נוכחות בשימוש עם מוצרים התיאור
-c,
‑‑config
נדרש הכול (מחרוזת) הנתיב לקובץ התצורה של Apigee Remote Service.
טיפ: הדגל הזה מאפשר לכם להשמיט את רוב הפרמטרים האחרים של הפקודות, כי ה-CLI יכול לשלוף אותם ישירות מקובץ התצורה. עיינו בקטע שימוש באפשרות ‑‑config.
-e,
‑‑environment
נדרש הכול (מחרוזת) סביבה בארגון שלכם.
-h,
‑‑help
אופציונלי הכול הצגת עזרה לגבי הפרמטרים של הפקודה.
‑‑insecure אופציונלי הכול אישור חיבורי שרת לא מאובטחים בעת שימוש ב-SSL.
‑‑legacy נדרש ענן ציבורי של Edge בלבד חובה להגדיר את הסימון הזה אם משתמשים ב-Apigee Edge לענן ציבורי. המדיניות מגדירה את כתובות ה-URL לניהול ולזמן הריצה עבור Apigee Edge לענן הציבורי.
-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 Edge, מגדירה אישור ויוצרת פרטי כניסה שיידרשו כדי להגדיר את Apigee Adapter ל-Envoy.

Usage

apigee-remote-service-cli provision [flags]

פרמטרים

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

(מחרוזת) משתמשים בסימון הזה כדי לציין את הנתיב לקובץ מפתח של חשבון שירות ב-Google Cloud, שבו לחשבון השירות יש את התפקיד Apigee Analytics Agent. המתאם משתמש ב-SA כדי להעלות נתוני ניתוח ישירות אל Apigee. אם משתמשים ב-Apigee hybrid, האפשרות הזו מאפשרת להתקין את זמן הריצה ההיברידי באשכול אחד ואת המתאם באשכול אחר.

-c,
‑‑config
נדרש הכול (מחרוזת) הנתיב לקובץ התצורה של Apigee Remote Service.
טיפ: הדגל הזה מאפשר לכם להשמיט את רוב הפרמטרים האחרים של הפקודות, כי ה-CLI יכול לשלוף אותם ישירות מקובץ התצורה. עיינו בקטע שימוש באפשרות ‑‑config.
-e,
‑‑environment
נדרש הכול (מחרוזת) סביבה בארגון שלכם.
-f, ‑‑force-proxy-install אופציונלי הכול (אופציונלי) מאלץ התקנה מחדש של שרת ה-Proxy של remote-service אם הוא כבר מותקן בארגון.
-h,
‑‑help
אופציונלי הכול הצגת עזרה לגבי הפרמטרים של הפקודה.
‑‑insecure אופציונלי הכול אישור חיבורי שרת לא מאובטחים בעת שימוש ב-SSL.
‑‑legacy נדרש ענן ציבורי של Edge בלבד חובה להגדיר את הסימון הזה אם משתמשים ב-Apigee Edge לענן ציבורי. המדיניות מגדירה את כתובות ה-URL לניהול ולזמן הריצה עבור Apigee Edge לענן הציבורי.
-m,
‑‑management
נדרש ענן פרטי של Edge בלבד (מחרוזת) כתובת ה-URL הבסיסית לניהול של Apigee Edge להתקנת ענן פרטי. ברירת מחדל: https://api.enterprise.apigee.com
‑‑mfa נדרש ענן ציבורי של Edge בלבד אסימון הרשאה רב-שלבי ל-Apigee Edge לענן הציבורי. נדרש רק אם MFA מוגדר בחשבון Apigee Edge שלך.
-n, ‑‑namespace אופציונלי הכול (מחרוזת) פלט הגדרה כ-Envoy ConfigMap במרחב השמות שצוין. ברירת מחדל: apigee
‑‑opdk נדרש ענן פרטי של Edge בלבד חובה להגדיר את הסימון הזה אם משתמשים ב-Apigee Edge לענן פרטי.
-o,
‑‑organization
נדרש הכול (מחרוזת) ארגון Apigee. עליך להיות מנהל מערכת בארגון כדי לנהל את ההקצאות.
-p,
‑‑password
נדרש
(אימות בסיסי בלבד)
ענן ציבורי ופרטי Edge בלבד (מחרוזת) סיסמת Apigee שלך. אפשר גם לציין את הסיסמה בקובץ
.netrc. במקרה כזה, לא צריך יותר להזין את הסיסמה בשורת הפקודה. למידע נוסף, ראו שימוש ב- .netrc לפרטי כניסה.
‑‑rotate-int אופציונלי Apigee היברידי בלבד (מספר שלם) אם 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.

Usage

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 Remote Service.
טיפ: הדגל הזה מאפשר לכם להשמיט את רוב הפרמטרים האחרים של הפקודות, כי ה-CLI יכול לשלוף אותם ישירות מקובץ התצורה. עיינו בקטע שימוש באפשרות ‑‑config.
-f, ‑‑force אופציונלי הכול אילוץ החלפה של הספרייה הקיימת.
-h, ‑‑help אופציונלי הכול הצגת עזרה לגבי הפרמטרים של הפקודה.
‑‑host נדרש רק לתבניות Envoy הכול (מחרוזת) המארח של שירות היעד (ברירת המחדל: httpbin.org)
-n, ‑‑name נדרש הכול (מחרוזת) השם של שירות היעד (ברירת המחדל: httpbin.org)
‑‑out אופציונלי הכול (מחרוזת) הספרייה שבה יש ליצור את קובצי התצורה לדוגמה.
ברירת המחדל: ./samples
‑‑tag נדרש עבור תבניות Istio בלבד הכול (מחרוזת) תג הגרסה של התמונה של מתאם Envoy. ברירת מחדל: 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.

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

פקודות אסימון

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

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

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

Usage

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 בלבד חובה להגדיר את הסימון הזה אם משתמשים ב-Apigee Edge לענן ציבורי. המדיניות מגדירה את כתובות ה-URL לניהול ולזמן הריצה עבור Apigee Edge לענן הציבורי.
‑‑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 באמצעות הפקודה הזו. כדאי גם לקרוא על בדיקת אסימון.

Usage

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 בלבד חובה להגדיר את הסימון הזה אם משתמשים ב-Apigee Edge לענן ציבורי. המדיניות מגדירה את כתובות ה-URL לניהול ולזמן הריצה עבור Apigee Edge לענן הציבורי.
‑‑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). התהליך הזה של יצירת זוג מפתחות חדש נקרא רוטציית מפתחות. כשמסובבים מפתחות, נוצר זוג מפתחות פרטי/ציבורי חדש ומאוחסן ב-KVM מסוג "istio" בסביבה או בארגון שלכם ב-Apigee. בנוסף, המפתח הציבורי הישן נשמר יחד עם הערך של מזהה המפתח המקורי שלו.

Usage

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 בלבד חובה להגדיר את הסימון הזה אם משתמשים ב-Apigee Edge לענן ציבורי. המדיניות מגדירה את כתובות ה-URL לניהול ולזמן הריצה עבור Apigee Edge לענן הציבורי.
‑‑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 לשירות מרוחק.

Usage

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 לפרטי כניסה

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:
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