תוסף Amazon S3

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

גרסה: 2.0.2

ניהול קבצים בקטגוריה של Amazon S3. באמצעות התוסף הזה, אפשר להציג רשימה של קבצים, להוריד ולמחוק אותם. אפשר גם ליצור כתובת URL חתומה להורדת קובץ.

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

דרישות מוקדמות

לפני שמשתמשים בתוסף משרת proxy של API באמצעות המדיניות ExtensionCallout, צריך:

תצטרכו את הפרטים האלה, יחד עם שם הקטגוריה ב-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 כתובת URL לקובץ המבוקש. מחרוזת ללא.

listFiles

מפעיל את הביצוע של פונקציית AWS Lambda.

תחביר

<Action>listFiles</Action>
<Input><![CDATA[{}]]></Input>
<Output>flow-variable</Output>

אם רוצים שהמשתנה יכיל את ה-JSON הגולמי, צריך לציין את parsed="false" ברכיב <Output>. אחרת, אי אפשר להשתמש במשתנה.

דוגמה

<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 של המפתח.
ללא. כן.