שימוש בכלי השירות apigee-adminapi.sh

Edge for Private Cloud v4.18.01

משתמשים ב-apigee-adminapi.sh לביצוע אותן משימות תצורה של Edge שאתם מבצעים על ידי ביצוע קריאות Management API. היתרון של הכלי apigee-adminapi.sh הוא שהוא:

• להשתמש בממשק שורת פקודה פשוט
• הטמעת השלמה של פקודות מבוססות-כרטיסייה
• מידע על עזרה ושימוש
• אפשר להציג את קריאת ה-API המתאימה אם תחליטו לנסות את ה-API

כלי השירות apigee-adminapi.sh הוא לא תחליף לכלי apigee-provision. הכלי apigee-provision משתמש בפועל בכלי apigee-adminapi.sh כדי לבצע את המשימות שלו.

ההבדלים העיקריים בין שני סוגי ההמרות הם:

• הכלי apigee-adminapi.sh מבצע פונקציות אטומיות שמחליפות קריאות בודדות ל-Edge API. לדוגמה, כדי ליצור לארגון, לסביבה ומארח וירטואלי נדרשים שלוש פקודות apigee-adminapi.sh נפרדות שמתאימות לשלוש קריאות ל-API.
• הכלי apigee-provision נועד לבצע פעולה מלאה ברמה גבוהה בפקודה אחת. עבור לדוגמה, אפשר ליצור ארגון, סביבה ומארח וירטואלי באמצעות שם משתמש אחד פקודת apigee-provision של העברת קובץ תצורה עם כל המידע הדרוש.

במסמכי התיעוד של Edge נעשה שימוש בשתי האפשרויות האלה במקרים המתאימים.

התקנה של apigee-adminapi.sh

כלי השירות apigee-adminapi.sh הוא מותקנת אוטומטית כשמתקינים את apigee-provision או את הכלי apigee-validator.

הכלי מותקן במיקום הבא:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

תחביר apigee-adminapi.sh

כלי השירות apigee-adminapi.sh משתמשת בתחביר פשוט של שורת פקודה. תמיד אפשר להשתמש במקש Tab כדי להציג הנחיה אפשרויות הפקודות הזמינות.

כדי לראות את כל הפקודות האפשריות, מפעילים את השירות ללא אפשרויות:

> apigee-adminapi.sh 

אם תקישו על מקש Tab לאחר הקלדת apigee-adminapi.sh, תוצג רשימה של אפשרויות אפשרויות:

analytics  classification  logsessions  regions  securityprofile  userroles
buildinfo  GET             orgs         runtime  servers          users

מקש Tab מציג אפשרויות על סמך ההקשר של הפקודה. אם מזינים מקש Tab אחרי ההקלדה:

> apigee-adminapi.sh orgs

יופיעו האפשרויות הזמינות להשלמת הפקודה orgs:

add  apis  apps  delete  envs  list  pods  userroles

יש להשתמש באפשרות -h כדי להציג בכל פקודה שהיא. לדוגמה, אם משתמשים באפשרות -h כפי שמתואר בהמשך:

> apigee-adminapi.sh orgs -h

הכלי מציג מידע עזרה מלא לגבי כל האפשרויות האפשריות לפקודה orgs. הפריט הראשון בפלט מציג את העזרה עבור 'הוספת ארגונים' הפקודה:

+++++++++++++++++++++++++++++++++++++++++++
orgs add
  Required:
    -o ORG Organization name
  Optional:
    -H HEADER add http header in request
    --admin ADMIN_EMAIL admin email address
    --pwd ADMIN_PASSWORD admin password
    --host EDGE_SERVER edge server to make request to
    --port EDGE_PORT port to use for the http request
    --ssl set EDGE_PROTO to https, defaults to http
    --debug ( set in debug mode, turns on verbose in curl )
    -h      Displays Help

פרמטרים להגדרה באמצעות מתגי שורת הפקודה ומשתני סביבה

צריך להזין את כל הפרמטרים של הפקודה באמצעות מתגים בשורת הפקודה או באמצעות משתני סביבה. מוסיפים מקף יחיד (-) או מקף כפול (--) כקידומת למתגי שורת הפקודה לפי הצורך.

לדוגמה, מהעזרה שמוצגת למעלה לגבי 'הוספת ארגונים' אפשר לציין שם הארגון באחד מהשניים:

• באמצעות המתג -o בשורת הפקודה:
  > apigee-adminapi.sh orgs -o testOrg
• הגדרת משתנה סביבה בשם ORG:
  > export ORG=testOrg
  > apigee-adminapi.sh orgs

אם משמיטים פרמטרים נדרשים מהפקודה, השירות יציג הודעת שגיאה עם תיאור הפרמטרים החסרים. לדוגמה, אם משמיטים את משתנה הסביבה --host או EDGE_server שמציין כשתיצרו ארגון, תופיע הודעת השגיאה הבאה:

Error with required variable or parameter
ADMIN_PASSWORD....OK
ADMIN_EMAIL....OK
EDGE_SERVER....null

שני פרמטרים נפוצים שמגדירים לעיתים קרובות כמשתני סביבה הם כתובת האימייל של האדמין המערכת וכתובת ה-IP של שרת הניהול:

> export ADMIN_EMAIL=foo@bar.com
> export EDGE_SERVER=192.168.56.101

העברת קובץ לכלי apigee-adminapi.sh

חלק מפקודות השירות apigee-adminapi.sh שתואמים לקריאות ל-PUT ול-POST API שמקבלות גוף בקשה. לדוגמה, יצירת מארח וירטואלי תואמת לקריאה ל-API מסוג POST שמחייבת מידע על המארח הווירטואלי בגוף הבקשה.

כשמשתמשים בכלי apigee-adminapi.sh כדי ליצור מארח וירטואלי, או בכל פקודה שמקבלת גוף בקשה, אפשר להעביר את כל המידע הנדרש בשורת הפקודה, כפי שמתואר בהמשך:

> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -v myVHostUtil -p 9005 -a 192.168.56.101:9005

לחלופין, אפשר להעביר קובץ שמכיל את אותו המידע שמופיע בגוף הבקשה של ה-POST. לדוגמה, הפקודה הבאה מקבלת קובץ שמגדיר את המארח הווירטואלי:

> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate

שבו הקובץ vhostcreate מכיל את גוף ה-POST של הקריאה. בדוגמה הזו, מדובר בגוף בקשה בפורמט XML:

<VirtualHost name="myVHostUtil">
   <HostAliases>
     <HostAlias>192.168.56.101:9005</HostAlias>
   </HostAliases>
   <Interfaces/>
   <Port>9005</Port>
</VirtualHost>

הצגת מידע על תוצאות ניפוי הבאגים וה-API

משתמשים באפשרות --debug כדי השירות apigee-adminapi.sh כדי להציג מידע מפורט על הפקודה. המידע הזה כולל את הפקודה של cURL שנוצרה על ידי הכלי apigee-adminapi.sh כדי לבצע את הפעולה.

לדוגמה, בפקודה הזו נעשה שימוש באפשרות --debug:

> apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug

הפלט הבא יוצג, כולל פקודת ה-cURL שנוצרה:

curl -H Content-Type: application/xml -v -X POST     -s -k -w \n==> %{http_code} 
-u ***oo@bar.com:*****     http://localhost:8080/v1/o -d <Organization name="testOrg2" 
type="paid"/>
* About to connect() to localhost port 8080 (#0)
*   Trying ::1... connected
* Connected to localhost (::1) port 8080 (#0)
* Server auth using Basic with user 'foo@bar.com'
> POST /v1/o HTTP/1.1
> Authorization: Basic c2dp234234NvbkBhcGlnZ2342342342342341Q5
> User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.19.1
Basic ECC zlib/1.2.3 libidn/1.18 libssh2/1.4.2
> Host: localhost:8080
> Accept: */*
> Content-Type: application/xml
> Content-Length: 43
>
} [data not shown]
< HTTP/1.1 201 Created
< Content-Type: application/json
< Date: Tue, 03 May 2016 02:08:32 GMT
< Content-Length: 291
<
{ [data not shown]
* Connection #0 to host localhost left intact
* Closing connection #0