חומרי עזר

המאמר הזה רלוונטי ל-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`
`-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 ו-Edge Private Cloud בלבד	הפרמטר הזה לא רלוונטי להתקנות של Apigee.
`-r, ‑‑runtime`	אופציונלי אם השדה `--config` קיים, אחרת הוא שדה חובה.	Apigee Hybrid בלבד	(מחרוזת) מציינת את כתובת ה-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`	לא רלוונטי (אימות בסיסי בלבד)	‫Edge Public Cloud ו-Edge 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`. ה-SA משמש את המתאם להעלאה ישירה של נתוני ניתוח ל-Apigee. האפשרות הזו מאפשרת למתאם להעלות נתונים של Analytics בלי שיהיו לו פרטי כניסה שמוגדרים כברירת מחדל באפליקציה במארח. אם לא מציינים את האפשרות הזו, המתאם משתמש בפרטי הכניסה של חשבון השירות שמוגדר כברירת מחדל.
`-c, ‑‑config`	אופציונלי	הכול	‫(String) הנתיב לקובץ התצורה של Apigee Remote Service. הערה: הדגל הזה מאפשר להשמיט את רוב הפרמטרים האחרים של הפקודה, כי ה-CLI יכול לשלוף אותם ישירות מקובץ התצורה. איך משתמשים באפשרות `--config`
`-e, ‑‑environment`	אופציונלי אם מצוין הערך `--config`, אחרת חובה.	הכול	‫(String) סביבה בארגון שלכם.
`-f, ‑‑force-proxy-install`	אופציונלי	הכול	(אופציונלי) מאלץ התקנה מחדש של שרת ה-proxy של `remote-service` אם הוא כבר מותקן בארגון. הערה לגבי שדרוג: אם אתם משדרגים לגרסה 1.1.0 או לגרסה מאוחרת יותר, אתם צריכים לכלול את הדגל `--force-proxy-install` כדי להחליף את שרת ה-proxy הקיים של השירות המרוחק שפריסתם ב-Apigee.
`-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 ו-Edge Private Cloud בלבד	הפרמטר הזה לא רלוונטי להתקנות של Apigee.
`‑‑rotate`	אופציונלי	Apigee Hybrid בלבד	‫(Integer) אם n > 0, המערכת יוצרת מפתח פרטי חדש ושומרת n מפתחות ציבוריים (רק במצב היברידי)
`-r, ‑‑runtime`	אופציונלי אם השדה `--config` קיים, אחרת הוא שדה חובה.	Apigee Hybrid בלבד	(מחרוזת) מציינת את כתובת ה-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`	לא רלוונטי (אימות בסיסי בלבד)	‫Edge Public Cloud ו-Edge 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 בלבד	הכול	(מחרוזת) מארח שירות היעד (ברירת מחדל `httpbin.org`)
`-n, ‑‑name`	אופציונלי	הכול	‫(String) שם שירות היעד (ברירת מחדל: `httpbin.org`)
`‑‑out`	אופציונלי	הכול	(מחרוזת) התיקייה שבה ייצרו קובצי ההגדרות לדוגמה. ברירת מחדל: `./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`
`-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 בלבד	(מחרוזת) מציינת את כתובת ה-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`
`-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 בלבד	(מחרוזת) מציינת את כתובת ה-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 ‏istio בארגון או בסביבה שלכם ב-Apigee. בנוסף, המפתח הציבורי הישן נשמר יחד עם ערך מזהה המפתח המקורי שלו.

Usage

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

פרמטרים

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

חומרי עזר קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

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

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

Usage

פרמטרים

דוגמה

פלט לדוגמה

פקודת עזרה

פקודת הקצאה

Usage

פרמטרים

דוגמה

הפקודה Samples

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

Usage

תיאור

פרמטרים

דוגמה

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

Usage

פרמטרים

דוגמה

פקודות טוקן

יצירת טוקן JWT

Usage

פרמטרים

דוגמה

תשובה

בדיקת טוקן JWT

Usage

פרמטרים

פרמטרים

דוגמה

תשובה

ביצוע רוטציה של טוקן JWT

Usage

פרמטרים

דוגמה

תשובה

יצירת טוקן פנימי

Usage

פרמטרים

פרמטרים

פקודת גרסה

קובץ תצורה

חומרי עזר

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