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

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

מידע על apigee-adminapi.sh

הפעלה של apigee-adminapi.sh

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

  • ADMIN_EMAIL (בהתאם לאפשרות admin בשורת הפקודה)
  • ADMIN_PASSWORD (pwd)
  • EDGE_SERVER (host)

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

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh buildinfo list --admin user@example.com --pwd abcd1234 --host localhost

בדוגמה הבאה מגדירים את האפשרויות הנדרשות כמשתני סביבה זמניים, ואז מפעילה את כלי העזר apigee-adminapi.sh:

export ADMIN_EMAIL=user@example.com
export ADMIN_PASSWORD=abcd1234
export EDGE_SERVER=192.168.56.101
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh servers list

אם לא צריך להזין את הסיסמה כאפשרות או להגדיר אותה כמשתנה סביבה, apigee-adminapi.sh יתבקש להזין אותה.

הגדרה של פרמטרים מסוג apigee-adminapi.sh

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

לדוגמה, אפשר לציין את שם הארגון באחת מהדרכים הבאות:

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

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

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

אם מופיעה שגיאת HTTP STATUS CODE: 401, המשמעות היא שהזנת סיסמה שגויה.

קבלת עזרה בנושא apigee-adminapi.sh

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

כדי לראות את כל הפקודות האפשריות, צריך להפעיל את כלי השירות ללא אפשרויות:

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

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

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

המקש Tab מציג אפשרויות בהתאם להקשר של הפקודה. אם תזין את מקש ה-Tab אחרי ההקלדה:

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

יוצגו האפשרויות האפשריות להשלמת הפקודה orgs:

add  apis  apps  delete  envs  list  pods  userroles

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

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

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

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

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

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

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

/opt/apigee/apigee-adminapi/bin/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. לדוגמה, הפקודה הבאה לוקחת קובץ שמגדיר את המארח הווירטואלי:

/opt/apigee/apigee-adminapi/bin/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. התוצאות מציגות את הפלט של הפקודה curl הבסיסית במצב מילולי:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
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