אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info
גרסה: 2.0.0
הצגת רשימה של כתובות URL חתומות, הורדה שלהן ויצירה שלהן עבור קבצים בקטגוריה של Cloud Storage.
התוכן הזה מכיל מידע שיעזור לכם להגדיר את התוסף הזה ולהשתמש בו. לפני שמשתמשים בתוסף הזה משרתי proxy של API, צריך:
מעלים אובייקטים לקטגוריה.
נותנים הרשאה לגישה לקטגוריה לחשבון השירות ב-GCP שמייצג את התוסף של Google Cloud Storage. מידע נוסף על התפקיד שבו צריך להשתמש זמין במאמר תפקידים ב-Cloud Storage. מידע נוסף על הרשאות ב-Cloud Storage זמין במאמר שימוש בהרשאות של ניהול זהויות והרשאות גישה (IAM).
משתמשים בתוכן של קובץ ה-JSON של המפתח שנוצר כשיוצרים את התוסף ומגדירים אותו לפי חומר העזר בנושא הגדרה.
מידע על Cloud Storage
Cloud Storage הוא שירות לאחסון קבצים מאובטח, עמיד וניתן להתאמה. אם אתם רק מתחילים להשתמש ב-Cloud Storage, המדריך למתחילים במסמכי העזרה של Cloud Storage הוא מקום טוב להתחיל בו.
דוגמאות
הדוגמאות הבאות מראות איך להגדיר תמיכה בפעולות של תוספים ל-Cloud Storage באמצעות מדיניות ExtensionCallout.
הצגת רשימה של קבצים
בדוגמה הבאה, הפעולה listFiles
של התוסף מאחזרת רשימה של הקבצים ומחזירה אותם במערך. הפעולה listFiles
לא מקבלת פרמטרים של קלט.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="false" enabled="true" name="Get-Storage-File-List">
<DisplayName>Get Storage File List</DisplayName>
<Connector>cloud-storage-extension-example</Connector>
<Action>listFiles</Action>
<Input><![CDATA[{}]]></Input>
<Output parsed="false">storage.filelist.retrieved</Output>
</ConnectorCallout>
ערך התגובה נראה בערך כך:
["example-text.txt","example-image.png"]
מדיניות הקצאת ההודעה הבאה מאחזרת את ערך התגובה מהמדיניות ExtensionCallout שלמעלה ומעתיקה אותו לעומס התגובה.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Storage-File-List">
<DisplayName>Assign Storage File List</DisplayName>
<AssignTo type="response" createNew="false"/>
<Set>
<Payload contentType="application/json">{storage.filelist.retrieved}</Payload>
</Set>
</AssignMessage>
הורדת קובץ
המדיניות הבאה של ExtensionCallout משתמשת בתוסף Google Cloud Storage כדי להוריד קובץ טקסט פשוט שתוכנו הוא פשוט Some example text.
,
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="false" enabled="true" name="Download-File">
<DisplayName>Download File</DisplayName>
<Connector>cloud-storage-extension-example</Connector>
<Action>downloadFile</Action>
<Input><![CDATA[{"fileName": "example-text.txt"}]]></Input>
<Output>storage.file.retrieved</Output>
</ConnectorCallout>
ערך התגובה נראה כך:
{"content":"Some example text."}
המדיניות הבאה של Assign Message מאחזרת את הערך שהתוסף מחזיר ומעתיקה אותו לעומס הנתונים של התגובה.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Storage-File-List">
<DisplayName>Assign Storage File List</DisplayName>
<AssignTo type="response" createNew="false"/>
<Set>
<Payload contentType="application/json">{storage.file.retrieved}</Payload>
</Set>
</AssignMessage>
יצירת כתובת URL חתומה
המדיניות הבאה של ExtensionCallout משתמשת בתוסף הזה כדי ליצור כתובת URL להורדת הקובץ שצוין מקטגוריית Cloud Storage. הוא מעביר את שם הקובץ ואת התאריך שבו התוקף של כתובת ה-URL יפוג והיא לא תפעל יותר.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="false" enabled="true" name="Get-Signed-URL">
<DisplayName>Get Signed URL</DisplayName>
<Connector>cloud-storage-extension-example</Connector>
<Action>generateSignedURL</Action>
<Input><![CDATA[{
"fileName" : "example-text.txt",
"expiresOn" : "2018-08-05"
}]]></Input>
<Output>storage.url.retrieved</Output>
</ConnectorCallout>
ערך ההחזרה של התוסף נראה בערך כך.
{"url":"https://storage.googleapis.com/storage-extension-example/example-text.txt?GoogleAccessId=extension-test%40my-test-33333.iam.gserviceaccount.com&Expires=1533427200&Signature=Y1cE1DCHesWeIZILRhdIuDR%2FhzZXZ%2BPeY3J1PUkRiosFYj41itHBWh2%2BTQgH9kI6E8s2mWrVDFU43YR7s8Tm9W5VgWRwh0nXSactQ0xKbkKbGZmCcWxgIscOezc1zc%2Bp7lnXSx1qd4wIlIKVH4KCd9WLx4qB1dLxGNxMKB32tA3dio5IiMXaHEA%2FR2fYc0Pjh45t8L5rilk5pekv7jfd3sfsgdfgfdglkj%2F7E%2FlJ%2B60RnetqV2IDqrc0sVEgSLTpgTbDGU%2Ft3EcitRUFOSdOb5czt7CiIwKAYSmDEFMSNHHiNTWjvLzq4IU%2BCa4Z5aKyvww%3D%3D"}
המדיניות הבאה של Assign Message מאחזרת את הערך שהתוסף מחזיר ומעתיקה אותו לגוף התגובה.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Storage-File-URL">
<DisplayName>Assign Storage File URL</DisplayName>
<AssignTo type="response" createNew="false"/>
<Set>
<Payload contentType="application/json">{storage.url.retrieved}</Payload>
</Set>
</AssignMessage>
פעולות
downloadFile
הורדת הקובץ שצוין.
פרמטרים של בקשות
פרמטר | תיאור | סוג | ברירת מחדל | חובה |
---|---|---|---|---|
fileName | הקובץ שרוצים להוריד. | מחרוזת | ללא. | כן. |
תחביר
<Input><![CDATA[{"fileName" : "the-file-to-download"}]]></Input>
דוגמה
<Input><![CDATA[{"fileName" : "example-text.txt"}]]></Input>
תשובה
קובץ JSON שמייצג אובייקט עם תוכן הקובץ שהורדתם. לדוגמה:
{"content":"Some example text."}
listFiles
רשימת הקבצים שזמינים להורדה.
פרמטרים של בקשות
ללא.
תשובה
מערך של שמות קבצים. לדוגמה:
["example-text.txt","example-image.png"]
generateSignedURL
יצירת כתובת URL חתומה לקובץ שצוין בקטגוריה. אפשר להשתמש בכתובת ה-URL הזו כדי להוריד את הקובץ.
פרמטרים של בקשות
פרמטר | תיאור | סוג | ברירת מחדל | חובה |
---|---|---|---|---|
fileName | השם של אובייקט Cloud Storage שעבורו רוצים ליצור כתובת URL חתומה. | מחרוזת | ללא. | כן. |
expiresOn | התאריך שבו יפוג תוקף כתובת ה-URL החתומה. | מחרוזת | ללא. | לא. |
תחביר
<Input><![CDATA[{
"fileName" : "file-for-which-to-generate-url",
"expiresOn" : "date-to-expire-url"
}]]></Input>
דוגמה
<Input><![CDATA[{
"fileName" : "example-text.txt",
"expiresOn" : "2018-08-05"
}]]></Input>
תשובה
קובץ JSON שמייצג אובייקט עם כתובת ה-URL החתומה. לדוגמה:
{"url":"https://storage.googleapis.com/storage-extension-example/example-text.txt?GoogleAccessId=extension-test%40my-test-33333.iam.gserviceaccount.com&Expires=1533427200&Signature=Y1cE1DCHesWeIZILRhdIuDR%2FhzZXZ%2BPeY3J1PUkRiosFYj41itHBWh2%2BTQgH9kI6E8s2mWrVDFU43YR7s8Tm9W5VgWRwh0nXSactQ0xKbkKbGZmCcWxgIscOezc1zc%2Bp7lnXSx1qd4wIlIKVH4KCd9WLx4qB1dLxGNxMKB32tA3dio5IiMXaHEA%2FR2fYc0Pjh45t8L5rilk5pekv7jfd3sfsgdfgfdglkj%2F7E%2FlJ%2B60RnetqV2IDqrc0sVEgSLTpgTbDGU%2Ft3EcitRUFOSdOb5czt7CiIwKAYSmDEFMSNHHiNTWjvLzq4IU%2BCa4Z5aKyvww%3D%3D"}
מסמך עזר בנושא הגדרות
השתמשו בהוראות הבאות כשמגדירים ומפרסים את התוסף הזה לשימוש בשרתי proxy ל-API. במאמר הוספה והגדרה של תוסף מוסבר איך להגדיר תוסף באמצעות מסוף Apigee.
מאפייני תוספים נפוצים
המאפיינים הבאים קיימים בכל תוסף.
נכס | תיאור | ברירת המחדל | נדרש |
---|---|---|---|
name |
השם שבחרת לתצורה הזו של התוסף. | ללא | כן |
packageName |
השם של חבילת התוסף כפי שהוא סופק על ידי Apigee Edge. | ללא | כן |
version |
מספר הגרסה של חבילת התוסף שממנה מגדירים את התוסף. | ללא | כן |
configuration |
ערך הגדרה ספציפי לתוסף שרוצים להוסיף. מאפיינים לחבילת תוספים זו | ללא | כן |
הנכסים של חבילת התוספים הזו
נכס | תיאור | ברירת מחדל | חובה |
---|---|---|---|
bucketName | הקטגוריה ב-GCS שאיתה התוסף הזה אמור לקיים אינטראקציה. | ללא. | כן. |