שימוש בכלי השירות 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 הוא wrapper במסגרת 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