يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات
Apigee X. المعلومات
الإصدار: 1.0.0
إدارة الملفات في حزمة Amazon S3 باستخدام هذه الإضافة، يمكنك إدراج الملفات وتنزيلها وحذفها. يمكنك أيضًا إنشاء عنوان URL موقَّع لتنزيل ملف.
يعمل كل مثيل تم إعداده لهذه الإضافة مع حزمة محدّدة. بالنسبة إلى مجموعات البيانات المتعددة، يمكنك استخدام مثيل تم إعداده لهذه الإضافة لكل حزمة.
المتطلبات الأساسية
قبل استخدام الإضافة من خادم وكيل لواجهة برمجة التطبيقات باستخدام سياسة ExtensionCallout، يجب عليك:
احصل على رقم تعريف مفتاح الوصول ومفتاح الوصول السري لحزمة 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>
مَعلمات الطلب
المَعلمة | الوصف | Type | تلقائي | مطلوبة |
---|---|---|---|---|
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>
مَعلمات الطلب
المَعلمة | الوصف | Type | تلقائي | مطلوبة |
---|---|---|---|---|
fileName | اسم الملف المطلوب تنزيله. | سلسلة | بلا عُري | نعم. |
الإجابة
تنسيق JSON مع السمة content
التي تحتوي على محتوى الملف
{
"content":"Hello World!"
}
خصائص الاستجابة
الموقع | الوصف | Type | تلقائي |
---|---|---|---|
للربح | سلسلة تحتوي على محتوى الملف المطلوب. | سلسلة. | بلا عُري |
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>
مَعلمات الطلب
المَعلمة | الوصف | Type | تلقائي | مطلوبة |
---|---|---|---|---|
fileName | اسم الملف المطلوب تنزيله. | سلسلة | بلا عُري | نعم. |
expiresIn | المدة بالثواني حتى تنتهي صلاحية عنوان URL. | عدد صحيح | 86400 | لا. |
الإجابة
تنسيق JSON مع سمة سلسلة url
تحتوي على عنوان URL الذي تم إنشاؤه
{
"url":"https://fake.s3.amazonaws.com/hello_world.txt?AWSAccessKeyId=123&Expires=1542753572&Signature=ABC"
}
خصائص الاستجابة
الموقع | الوصف | Type | تلقائي |
---|---|---|---|
عنوان url | تمثّل هذه السمة عنوان 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"]
خصائص الاستجابة
بلا عُري
مرجع التكوين
استخدِم ما يلي عند ضبط هذه الإضافة ونشرها للاستخدام في الخوادم الوكيلة لواجهة برمجة التطبيقات. لمعرفة خطوات إعداد إضافة باستخدام وحدة تحكُّم 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 } عند إرسال البيانات من خلال واجهة برمجة تطبيقات الإدارة، يتم إنشاء قيمة بترميز base64 تم إنشاؤها من ملف JSON هذا للمفتاح. |
بلا عُري | نعم. |