מוצג המסמך של Apigee Edge.
עוברים אל
מסמכי תיעוד של Apigee X. מידע
גרסה: 1.1.1
ניהול קבצים בקטגוריה של Amazon S3. באמצעות התוסף הזה ניתן להציג ברשימה, להוריד ולמחוק קבצים. אפשר גם ליצור כתובת URL חתומה כדי להוריד קובץ.
כל מופע שהוגדר של התוסף הזה פועל עם קטגוריה ספציפית. במספר קטגוריות, צריך להשתמש במופע מוגדר של התוסף הזה בכל קטגוריה.
דרישות מוקדמות
לפני שימוש בתוסף משרת proxy ל-API באמצעות המדיניות בנושא תוספי יתרונות מרכזיים, צריך:
מקבלים את מזהה מפתח הגישה ומפתח הגישה הסודי לקטגוריה של Amazon S3 שאיתה עובדים עובדים.
צריך את הפרטים האלה, יחד עם שם הקטגוריה של AWS והאזור של AWS, כדי להגדיר את התוסף הזה.
מידע על Amazon S3
Amazon Simple Storage Service (Amazon S3) הוא שירות לאחסון אובייקטים.
פעולות
deleteFile
מחיקה של הקובץ שצוין מקטגוריה ב-S3.
תחביר
<Action>deleteFile</Action>
<Input><![CDATA[
{
"fileName" : "name-of-file-to-delete"
}
]]>
</Input>
דוגמה
<Action>deleteFile</Action>
<Input><![CDATA[
{
"fileName" : "names.tmp"
}
]]>
</Input>
פרמטרים של בקשות
פרמטר | תיאור | סוג | ברירת מחדל | חובה |
---|---|---|---|---|
fileName | שם הקובץ שרוצים למחוק. | מחרוזת | ללא. | כן. |
תשובה
ללא.
מאפייני התשובה
ללא.
downloadFile
הורדת הקובץ שצוין מקטגוריה ב-S3.
תחביר
<Action>downloadFile</Action>
<Input><![CDATA[
{
"fileName" : "filename"
}
]]>
</Input>
<Output>flow-variable</Output>
דוגמה
<Action>downloadFile</Action>
<Input><![CDATA[
{
"fileName" : "product-sheet.pdf"
}
]]>
</Input>
<Output>downloaded.file</Output>
פרמטרים של בקשות
פרמטר | תיאור | סוג | ברירת מחדל | חובה |
---|---|---|---|---|
fileName | שם הקובץ להורדה. | מחרוזת | ללא. | כן. |
תשובה
JSON עם מאפיין content
שמכיל את תוכן הקובץ.
{
"content":"Hello World!"
}
מאפייני תגובה
נכס | תיאור | סוג | ברירת מחדל |
---|---|---|---|
תוכן | מחרוזת שמכילה את תוכן הקובץ המבוקש. | מחרוזת. | ללא. |
generateSignedURL
יצירת כתובת URL חתומה להורדת הקובץ שצוין מקטגוריה של S3.
תחביר
<Action>generateSignedURL</Action>
<Input><![CDATA[
{
"fileName": "filename",
"expiresIn": duration-in-seconds
}
]]>
</Input>
<Output>flow-variable</Output>
דוגמה
<Action>generateSignedURL</Action>
<Input><![CDATA[
{
"fileName": "product-info.pdf",
"expiresIn": 3600
}
]]>
</Input>
<Output>download.url</Output>
פרמטרים של בקשות
פרמטר | תיאור | סוג | ברירת מחדל | חובה |
---|---|---|---|---|
fileName | שם הקובץ להורדה. | מחרוזת | ללא. | כן. |
expiresIn | משך הזמן בשניות עד שיפוג התוקף של כתובת ה-URL. | מספר שלם | 86400 | לא. |
תשובה
קובץ JSON עם מאפיין מחרוזת url
שמכיל את כתובת ה-URL שנוצרה.
{
"url":"https://fake.s3.amazonaws.com/hello_world.txt?AWSAccessKeyId=123&Expires=1542753572&Signature=ABC"
}
מאפייני תגובה
נכס | תיאור | סוג | ברירת מחדל |
---|---|---|---|
כתובת אתר | כתובת URL לקובץ המבוקש. | מחרוזת | ללא. |
listFiles
הפעלת פונקציית AWS Lambda.
תחביר
<Action>listFiles</Action>
<Input><![CDATA[{}]]></Input>
<Output>flow-variable</Output>
אם רוצים, צריך לציין parsed="false"
ברכיב <Output>
את המשתנה כדי להכיל את ה-JSON הגולמי. אחרת, אי אפשר להשתמש במשתנה.
דוגמה
<Action>listFiles</Action>
<Input><![CDATA[{}]]></Input>
<Output parsed="false">listFilesOutput</Output>
פרמטרים של בקשה
ללא.
תשובה
מערך שמות של קבצים מסוג S3.
["hello_world.txt"]
מאפייני תגובה
ללא.
חומר עזר על הגדרות אישיות
כשמגדירים ומפרסים את התוסף הזה לשימוש בשרתי proxy ל-API, צריך להשתמש בנתונים הבאים. במאמר הוספה והגדרה של תוסף מוסבר איך להגדיר תוסף באמצעות מסוף Apigee.
מאפייני תוספים נפוצים
המאפיינים הבאים קיימים בכל תוסף.
נכס | תיאור | ברירת המחדל | נדרש |
---|---|---|---|
name |
השם שבחרת לתצורה הזו של התוסף. | ללא | כן |
packageName |
השם של חבילת התוסף כפי שהוא סופק על ידי Apigee Edge. | ללא | כן |
version |
מספר הגרסה של חבילת התוסף שממנה מגדירים את התוסף. | ללא | כן |
configuration |
ערך הגדרה ספציפי לתוסף שרוצים להוסיף. מאפיינים לחבילת תוספים זו | ללא | כן |
מאפיינים של חבילת התוספים הזו
יש לציין ערכים למאפיינים הבאים של הגדרות אישיות שספציפיים לתוסף הזה.
נכס | תיאור | ברירת מחדל | חובה |
---|---|---|---|
הגדרות אישיות | מזינים את שם הקטגוריה של Amazon S3 שבה רוצים להשתמש, למשל sample-bucket . |
ללא. | כן. |
הגדרות אישיות | מזינים את השם של אזור AWS שבו רוצים להשתמש, למשל us-east-2 . |
ללא. | כן. |
פרטי כניסה | אם מזינים אותו במסוף Apigee Edge, זהו קובץ JSON שמכיל את מזהה מפתח הגישה ומפתח הגישה של Amazon בפורמט הבא:{ "accessKeyId" : access-key-ID, "secretAccessKey" : secret-access-key } אם הוא נשלח באמצעות Management API, הוא נוצר בקידוד base64 שנוצר מקובץ ה-JSON של המפתח. |
ללא. | כן. |