כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של
Apigee X. מידע
גרסה: 1.0.0
ניהול קבצים בקטגוריה של Amazon S3. בעזרת התוסף הזה אפשר להציג, להוריד ולמחוק קבצים. אפשר גם ליצור כתובת URL חתומה להורדת קובץ.
כל מופע שהוגדר של התוסף הזה עובד עם קטגוריה ספציפית. עבור קטגוריות מרובות, יש להשתמש במופע שהוגדר של התוסף הזה לכל קטגוריה.
דרישות מוקדמות
לפני שמשתמשים בתוסף משרת proxy של API באמצעות המדיניות בנושא יתרונות מרכזיים של תוסף, צריך:
משיגים את מזהה מפתח הגישה ומפתח הגישה הסודי של קטגוריית Amazon S3 שבה אתם עובדים.
הם נדרשים, יחד עם שם הקטגוריה של AWS ואזור AWS, כדי configure את התוסף הזה.
מידע על 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 } כששולחים את הקובץ דרך ממשק ה-API לניהול, זהו ערך בקידוד base64 שנוצר מקובץ JSON מפתח זה. |
ללא. | כן. |