ניהול משאבים

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

הסעיפים הבאים מסבירים איך להבין ולנהל משאבים.

הסבר על המשאבים

סוגים רבים של מדיניות מסתמכים על משאבים. משאבים הם הקבצים שמטמיעים את הקוד או את ההגדרה שצריכים להיות מופעלים על ידי מדיניות כשהיא מצורפת ל-API Proxy. במקרים מסוימים, כמו ב-JavaScript וב-JavaCallout, מדיניות פשוט מגדירה נקודת צירוף ב-proxy ל-API שבה קוד מסוים צריך לפעול. המדיניות JavaScript או JavaCallout היא מצביע למשאב.

בדוגמה הבאה של JavaScript, נתיב בקשת ה-HTTP מוגדר לערך של המשתנה proxy.basepath.

request.headers["RequestPath"] = context.getVariable("proxy.basepath");

סוגי המשאבים

בטבלה הבאה מפורטים סוגי המשאבים:

איפה המשאבים מאוחסנים

אפשר לאחסן משאבים באחד משלושת המיקומים הבאים:

• גרסה של proxy ל-API: המשאבים זמינים רק לגרסאות של proxy ל-API שבהן המשאבים כלולים. לדוגמה, אפשר לכלול משאב JavaScript בגרסה 1 של proxy ל-API, ואז לשנות את ההטמעה כך שתשתמש בסקריפט Python בגרסה 2 של ה-proxy. לגרסה 1 יש גישה רק למשאב JavaScript, ולגרסה 2 יש גישה רק למשאב Python.
• סביבה: כשמאחסנים משאבים בסביבה (לדוגמה, test או prod), הם זמינים לכל proxy ל-API שמוטמע באותה סביבה.
• ארגון: כשמשאבים מאוחסנים בארגון, הם זמינים לכל proxy ל-API שנפרס בכל סביבה.

המאגרים זמינים בכתובות ה-URI הבאות, כפי שמתואר ב-Resource files API ובהמשך במאמר ניהול משאבים באמצעות ה-API:

• ארגון: /organizations/{org}/resourcefiles
• סביבה: /organizations/{org}/environments/{env}/resourcefiles
• proxy ל-API: /organizations/{org}/apis/{api}/revisions/{rev}/resources

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

לדוגמה, כל קובצי ה-JavaScript שזמינים בסביבה test מאוחסנים במאגר הבא וזמינים לכל proxy ל-API שפועל בסביבה test:

/organizations/{org}/environments/test/resourcefiles/jsc

תרגום שם המשאב

‫Edge פותר שמות של משאבים מההיקף הספציפי ביותר להיקף הכללי ביותר. שמות המשאבים נפתרים 'בשרשרת', מרמת הגרסה של proxy ל-API, לרמת הסביבה, לרמת הארגון (Edge בלבד).

נניח שאכלסתם את אותו משאב בשני מאגרי מידע שונים – הגרסה של proxy ל-API וסביבת prod.

נבחן את proxy ל-API שהוגדר עם המדיניות הבאה:

<Javascript name='PathSetterPolicy' timeLimit='200'>
    <ResourceURL>jsc://pathSetter.js</ResourceURL>
</Javascript>

אי אפשר לפתור את ההפניה למדיניות באופן מפורש למאגר. המערכת תאתר את המשאב הראשון בהיקף המפורט ביותר ששמו תואם לשם המשאב במדיניות.

לכן, כשפורסים את ה-proxy ל-API בסביבה prod, המדיניות תפנה למשאב pathSetter.js שמוגדר בהיקף הסביבה.

כשפורסים את המדיניות בסביבה test, המדיניות תפנה למשאב בטווח של גרסה של proxy ל-API, כי המשאב בטווח של הסביבה נמצא בסביבה prod ולא בסביבה test.

הנחיות לגבי מקורות מידע ב-Java

אפשר להוסיף משאבי Java שעברו קומפילציה כקבצי JAR באמצעות כמה אפשרויות ב-curl, כמו האפשרות -T, --data-binary או -F (לא האפשרות -d). לדוגמה:

curl "http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java" \
  -X POST \
  --data-binary @{jar_file} \
  -H "Content-Type: application/octet-stream" \
  -u email:password

curl -v "http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java"
  -X POST \
  -H "Content-Type: application/octet-stream" \
  -T "{jar_file}" \
  -u email:password

curl -v "http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java"
  -X POST \
  -H "Content-Type: application/multipart/form-data" \
  -F "file=@{jar_file}" \
  -u email:password

מידע נוסף:

• שיטות מומלצות ל-Java: שיטות מומלצות לתכנון ולפיתוח של proxy ל-API
• דוגמה ל-Java: מדיניות XSL Transform

הנחיות בנוגע למקורות מידע של Node.js

כשמפנים לסקריפט Node.js ב-proxy ל-API, עושים זאת באמצעות הרכיב <ResourceURL> בהגדרת ה-proxy ל-API‏ TargetEndpoint, כפי שמתואר במאמר הוספת Node.js ל-proxy ל-API קיים. לדוגמה:

<ScriptTarget>
    <ResourceURL>node://hello-world.js</ResourceURL>
</ScriptTarget>

סקריפט Node.js וכל המודולים התומכים צריכים להיות בתחום של גרסת proxy ל-API (בספרייה /resources/node של חבילת ה-proxy). בעורך של proxy ל-API, הוספת משאב Node.js לקטע Scripts משיגה זאת. כך גם לגבי שימוש ב-API (import ו-update) כדי לאחסן את המשאב בהיקף של גרסת proxy ל-API.

ניהול משאבים באמצעות ממשק המשתמש

אפשר לנהל משאבים בהיקף של גרסה של proxy ל-API באמצעות ממשק המשתמש, כמו שמתואר בקטעים הבאים.

צפייה במשאבים באמצעות ממשק המשתמש

כדי לראות את המשאבים שמוגבלים לגרסה של proxy ל-API:

1. נכנסים לחשבון בכתובת apigee.com/edge.

2. בסרגל הניווט הימני, בוחרים באפשרות פיתוח > שרתי proxy של API.
3. בוחרים ברשימה את ה-proxy ל-API שרוצים ליצור בשבילו משאב.
   ייפתח עורך ה-proxy ל-API, והכרטיסייה "סקירה כללית" תוצג כברירת מחדל.
4. לוחצים על הכרטיסייה פיתוח.
5. אם צריך, בוחרים את הגרסה בתפריט הנפתח גרסה.

   המשאבים שמוגדרים להיקף של גרסת ה-proxy ל-API מפורטים בקטע Resources בתצוגת הניווט.

   

יצירת משאב באמצעות ממשק המשתמש

כדי ליצור משאבים בהיקף של גרסה של proxy ל-API באמצעות ממשק המשתמש:

1. צפייה במשאבים שמוגבלים לגרסה של proxy ל-API.
2. לוחצים על + בקטע 'משאבים' בתצוגת הניווט כדי לפתוח את תיבת הדו-שיח 'משאב חדש'.
3. כתבו:

   שדה	תיאור
   מקור	בוחרים אם ליצור קובץ חדש או לייבא קובץ.
   סוג קובץ	בוחרים סוג משאב מהרשימה הנפתחת.
   שם הקובץ	שם הקובץ. סיומת שם הקובץ חייבת להיות תקינה לסוג הקובץ שנבחר.

עדכון משאב באמצעות ממשק המשתמש

כדי לעדכן משאב בהיקף של גרסה של proxy ל-API באמצעות ממשק המשתמש:

1. צפייה במשאבים שמוגבלים לגרסה של proxy ל-API.
2. בתצוגת הניווט, בקטע Resources (משאבים), לוחצים על המשאב שרוצים לעדכן.
   הערה: בקובצי JAR, מציבים את הסמן מעל המשאב שרוצים לערוך ולוחצים על .
3. מעדכנים את מקור המידע לפי הצורך.
   הערה: אחרי שמעלים קובץ JAR חדש, לוחצים על עדכון.

מחיקת משאב באמצעות ממשק המשתמש

כדי למחוק משאב בהיקף של גרסה של proxy ל-API באמצעות ממשק המשתמש:

1. צפייה במשאבים שמוגבלים לגרסה של proxy ל-API.
2. בתצוגה 'ניווט' בקטע 'משאבים', מציבים את הסמן מעל המשאב שרוצים למחוק כדי להציג את תפריט הפעולות.
3. לוחצים על .
4. לוחצים על מחיקה כדי לאשר את הפעולה.

ניהול משאבים באמצעות ה-API

אפשר לנהל משאבים באמצעות ה-API, כמו שמתואר בקטעים הבאים.

יצירת משאבים באמצעות API

יוצרים משאבים בהיקף של גרסה של proxy ל-API, סביבה או ארגון (Edge בלבד), כמו שמתואר בקטעים הבאים.

יצירת משאבים בהיקף של גרסה של proxy ל-API באמצעות API

כדי ליצור משאב בהיקף של גרסה של proxy ל-API באמצעות ה-API, שולחים בקשת POST למשאב הבא: https://api.enterprise.apigee.com/v1/organizations/{org}/apis/{api}/revisions/{rev}/resourcefiles

צריך להעביר את הפרטים הבאים עם הבקשה:

• מגדירים את פרמטר השאילתה name לשם המשאב
• מגדירים את פרמטר השאילתה type לסוג המשאב הנדרש.
• העברת התוכן של קובץ המשאבים כ-application/octet-stream או כ-multipart/form-data)

בדוגמה הבאה נוצר קובץ JavaScript בשם pathSetter.js לגרסה 1 של ה-proxy ל-API‏ helloworld:

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

בדוגמה הבאה אפשר לראות איך מעלים את המשאב כקובץ מהמחשב המקומי. חשוב להשתמש ב--F להעלאה הבינארית ב-curl כדי שקובצי ה-JavaScript בהיקף הסביבה או הארגון יהיו נגישים למדיניות JavaScript.

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

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

{
  "name": "pathSetter.js",
  "type": "jsc"
}

מידע נוסף זמין במאמר ייבוא קובץ משאבים לגרסה של שרת proxy ל-API.

אפשרות נוספת היא להשתמש ב-API לעדכון של גרסת ה-proxy ל-API, באופן הבא:

1. יוצרים את קובץ המשאבים.
2. מוסיפים את קובץ המשאבים לחבילת הגדרות של שרת proxy ל-API.
3. מעלים את ה-bundle באמצעות אחד מממשקי ה-API הבאים:
   • יצירת proxy ל-API
   • עדכון גרסה של proxy ל-API

יצירת משאבים בהיקף של סביבה באמצעות ה-API

כדי ליצור משאב JavaScript שמוגדר בהיקף של סביבה באמצעות ה-API, שולחים בקשת POST למשאב הבא: /organizations/{org}/environments/{env}/resourcefiles

צריך להעביר את הפרטים הבאים עם הבקשה:

• מגדירים את פרמטר השאילתה name לשם המשאב
• מגדירים את פרמטר השאילתה type לסוג המשאב הנדרש.
• העברת התוכן של קובץ המשאבים כ-application/octet-stream או כ-multipart/form-data)

בדוגמה הבאה מוצג אופן היצירה של משאב JavaScript על ידי העברת התוכן שלו בגוף הבקשה.

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

בדוגמה הבאה אפשר לראות איך מעלים את המשאב כקובץ מהמחשב המקומי. חשוב להשתמש ב--F להעלאה הבינארית ב-curl כדי שקובצי ה-JavaScript בהיקף הסביבה או הארגון יהיו נגישים למדיניות JavaScript.

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

זוהי דוגמה לתגובה:

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

יצירת משאבים בהיקף הארגון באמצעות API

כדי ליצור משאב בהיקף של ארגון באמצעות ה-API, שולחים בקשת POST למשאב הבא: https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles

צריך להעביר את הפרטים הבאים עם הבקשה:

• מגדירים את פרמטר השאילתה name לשם המשאב
• מגדירים את פרמטר השאילתה type לסוג קובץ המשאבים (ראו סוגי משאבים)
• העברת התוכן של קובץ המשאבים כ-application/octet-stream או כ-multipart/form-data)

מידע נוסף זמין במאמר ייבוא קובץ משאבים לארגון.

צפייה במשאבים באמצעות ה-API

בקטעים הבאים מוסבר איך לצפות במשאבים באמצעות ה-API.

הצגת כל המשאבים באמצעות ה-API

באמצעות ה-API אפשר להציג משאבים בהיקף של גרסה של proxy ל-API, סביבה או ארגון.

לדוגמה, כדי להציג משאבים שמוגבלים לסביבה באמצעות ה-API, שולחים בקשת GET למשאב הבא: https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{env}/resourcefiles

בדוגמה הבאה מפורטים כל המשאבים בסביבת test:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/environments/test/resourcefiles/{type}" \
  -u email:password

בהמשך מופיעה דוגמה לתגובה.

{
  "resourceFile": [
{
  "name" : "pathSetter.js",
  "type" : "jsc"
}
  ]
}

הצגת התוכן של משאב באמצעות ה-API

אפשר לראות את התוכן של מקור מידע באמצעות ה-API, כמו שמתואר בקטעים הבאים.

באמצעות ה-API אפשר להציג משאבים בהיקף של גרסה של proxy ל-API, סביבה או ארגון.

לדוגמה, כדי להציג את התוכן של משאב בסביבה באמצעות ה-API, שולחים בקשת GET למשאב הבא: https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{env}/resourcefiles/{type}/name

בדוגמה הבאה מפורט התוכן של קובץ משאבי JavaScript‏ pathSetter.js בסביבת test:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js" \
  -H "Accept: application/json" \
  -u email:password

זוהי דוגמה לתגובה:

request.headers["RequestPath"] = context.getVariable("proxy.basepath");

עדכון משאבים באמצעות API

מעדכנים משאבים שמוגדרים ל-גרסת proxy ל-API, ל-environment או ל-organization (ב-Edge בלבד), כמו שמתואר בקטעים הבאים.

עדכון משאבים בהיקף של גרסה של proxy ל-API באמצעות ה-API

כדי לעדכן משאב בהיקף של גרסה של proxy ל-API באמצעות ה-API, שולחים בקשת PUT למשאב הבא: https://api.enterprise.apigee.com/v1/organizations/{org}/apis/{api}/revisions/{rev}/resourcefiles/{type}/{name}

העברת התוכן של קובץ המשאבים כ-application/octet-stream או כ-multipart/form-data)

בדוגמה הבאה מתעדכן משאב JavaScript בשם pathSetter בגרסה 1 של ה-proxy ל-API‏ helloworld:

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

בדוגמה הבאה אפשר לראות איך מעדכנים את המשאב כקובץ מהמחשב המקומי. חשוב להשתמש ב--F להעלאה הבינארית ב-curl כדי שקובצי ה-JavaScript בהיקף הסביבה או הארגון יהיו נגישים למדיניות JavaScript.

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

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

{
  "name": "pathSetter.js",
  "type": "jsc"
}

מידע נוסף זמין במאמר ייבוא קובץ משאבים לגרסה של שרת proxy ל-API.

אפשרות נוספת היא להשתמש ב-API לעדכון של גרסת ה-proxy ל-API, באופן הבא:

1. מורידים את חבילת ההגדרות של ה-proxy ל-API באמצעות Export API proxy API עם האפשרויות הבאות:
   • מגדירים את פרמטר השאילתה format לערך bundle
   • מגדירים את הכותרת Accept ל-application/zip
2. מעדכנים את קובץ המשאבים בחבילת ההגדרות של proxy ל-API.
3. מעלים את החבילה באמצעות Update API proxy revision API

עדכון משאבים בהיקף של סביבה באמצעות ה-API

כדי לעדכן משאב שמוגדר בהיקף של סביבה באמצעות ה-API, שולחים בקשת PUT למשאב הבא: /organizations/{org}/environments/{env}/resourcefiles/{type}/{name}

מעבירים את התוכן של קובץ המשאבים כ-application/octet-stream או כ-multipart/form-data.

בדוגמה הבאה אפשר לראות איך מעדכנים משאב JavaScript על ידי העברת התוכן שלו בגוף הבקשה.

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

בדוגמה הבאה אפשר לראות איך מעדכנים את קובץ המשאבים באמצעות קובץ מהמחשב המקומי. חשוב להשתמש ב--F להעלאה הבינארית ב-curl כדי שקבצי JavaScript בהיקף הסביבה או הארגון יהיו נגישים למדיניות JavaScript.

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

זוהי דוגמה לתגובה:

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

עדכון משאבים בהיקף הארגון באמצעות ה-API

כדי לעדכן משאב שמוגדר בהיקף של ארגון באמצעות ה-API, שולחים בקשת POST למשאב הבא: https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles/{type}/{name}

העברת התוכן של קובץ המשאבים כ-application/octet-stream או כ-multipart/form-data)

מידע נוסף זמין במאמר ייבוא קובץ משאבים לארגון.

מחיקת משאבים באמצעות ה-API

מוחקים משאב בהיקף של גרסה של שרת proxy ל-API, סביבה או ארגון (Edge בלבד), כמו שמתואר בקטעים הבאים.

מחיקת משאבים בהיקף של גרסה של proxy ל-API באמצעות ה-API

כדי למחוק משאב בהיקף של גרסה של proxy ל-API באמצעות ה-API, שולחים בקשת DELETE למשאב הבא: https://api.enterprise.apigee.com/v1/organizations/{org}/apis/{api}/revisions/{rev}/resourcefiles/{type}/{name}

בדוגמה הבאה נמחק קובץ המשאבים pathSetter.js של JavaScript מגרסה 1 של proxy ל-API של helloworld:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js" \
  -u email:password
  

בהמשך מופיעה דוגמה לתגובה.

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

אפשרות נוספת היא להשתמש ב-API לעדכון של גרסת ה-proxy ל-API, באופן הבא:

1. מורידים את חבילת ההגדרות של ה-proxy ל-API באמצעות Export API proxy API עם האפשרויות הבאות:
   • מגדירים את פרמטר השאילתה format לערך bundle
   • מגדירים את הכותרת Accept ל-application/zip
2. מוחקים את קובץ המשאבים מחבילת ההגדרות של ה-proxy ל-API.
3. מעלים את החבילה באמצעות Update API proxy revision API

מחיקת משאב בהיקף סביבה באמצעות ה-API

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

כדי למחוק משאב בהיקף סביבה באמצעות ה-API, שולחים בקשת DELETE למשאב הבא: https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{env}/resourcefiles/{type}/{name}

בדוגמה הבאה נמחק קובץ משאבי JavaScript‏ pathSetter.js מהסביבה test:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/environments/test/resourcefiles/jsc/pathSetter.js" \
  -u email:password

בהמשך מופיעה דוגמה לתגובה.

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

מחיקת משאבים בהיקף הארגון באמצעות ה-API (Edge בלבד)

כדי למחוק משאב שמוגדר בהיקף של ארגון באמצעות ה-API, שולחים בקשת DELETE למשאב הבא: https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles/{type}/{name}

מידע נוסף זמין במאמר בנושא מחיקת קובץ משאבים מארגון.

גישה למשאב

אופן הגישה למשאב תלוי בסוג המשאב. מידע נוסף זמין במסמכי המדיניות הרלוונטיים.

בדוגמאות שבקטע הזה מוסבר איך ליצור ולנהל משאב JavaScript בשם pathSetter.js כדי לאפשר הפניה אליו במדיניות מסוג JavaScript.

כדי לצרף את ה-JavaScript ל-Request PostFlow, יוצרים מדיניות בשם PathSetterPolicy.xml שמפנה לקובץ pathSetter.js:

<Javascript name='PathSetterPolicy' timeLimit='200'>
    <ResourceURL>jsc://pathSetter.js</ResourceURL>
</Javascript>

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

<PostFlow>
  <Request>
    <Step><Name>PathSetterPolicy</Name></Step>
  </Request>
<PostFlow>

מידע נוסף זמין במאמר בנושא מדיניות JavaScript.