شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات
نسخه: 1.4.1
فهرست، دانلود، و ایجاد URLهای امضا شده برای فایلها در یک سطل فضای ذخیرهسازی ابری .
این محتوا مرجعی برای پیکربندی و استفاده از این پسوند ارائه می دهد. قبل از استفاده از این پسوند از یک پروکسی API، باید:
به حساب سرویس GCP که نمایانگر برنامه افزودنی Google Cloud Storage شما است، اجازه دسترسی به سطل را بدهید . برای اطلاعات بیشتر در مورد نقش مورد استفاده، به نقشهای Cloud Storage مراجعه کنید. برای اطلاعات بیشتر در مورد مجوزها در Cloud Storage، به استفاده از مجوزهای مدیریت هویت و دسترسی (IAM) مراجعه کنید.
از کنسول GCP برای ایجاد یک کلید برای حساب سرویس استفاده کنید .
هنگام افزودن و پیکربندی پسوند با استفاده از مرجع پیکربندی، از محتویات فایل JSON کلید حاصل استفاده کنید.
درباره 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"]
خط مشی Assign Message زیر مقدار پاسخ را از خط مشی 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 برای دانلود فایل مشخص شده از سطل فضای ذخیره سازی ابری استفاده می کند. نام فایل را همراه با تاریخی که پس از آن 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>
اقدامات
دانلود فایل
فایل مشخص شده را دانلود می کند.
درخواست پارامترها
پارامتر | توضیحات | تایپ کنید | پیش فرض | مورد نیاز |
---|---|---|---|---|
نام فایل | فایل برای دانلود. | رشته | هیچ کدام. | بله. |
نحو
<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 امضا شده برای فایل مشخص شده در سطل ایجاد می کند. از این آدرس می توان برای دانلود فایل استفاده کرد.
درخواست پارامترها
پارامتر | توضیحات | تایپ کنید | پیش فرض | مورد نیاز |
---|---|---|---|---|
نام فایل | نام شی Cloud Storage که برای آن یک URL امضا شده ایجاد می شود. | رشته | هیچ کدام. | بله. |
منقضی می شود | تاریخی که 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"}
مرجع پیکربندی
هنگام پیکربندی و استقرار این افزونه برای استفاده در پراکسی های API از موارد زیر استفاده کنید. برای مراحل پیکربندی یک برنامه افزودنی با استفاده از کنسول Apigee، به افزودن و پیکربندی یک برنامه افزودنی مراجعه کنید.
ویژگی های رایج پسوند
ویژگی های زیر برای هر افزونه وجود دارد.
ویژگی | شرح | پیش فرض | ضروری |
---|---|---|---|
name | نامی که به این پیکربندی افزونه میدهید. | هیچ یک | آره |
packageName | نام بسته افزودنی همانطور که توسط Apigee Edge داده شده است. | هیچ یک | آره |
version | شماره نسخه بسته برنامه افزودنی که از آن یک برنامه افزودنی را پیکربندی می کنید. | هیچ یک | آره |
configuration | مقدار پیکربندی مخصوص افزونه ای که اضافه می کنید. به ویژگی های این بسته برنامه افزودنی مراجعه کنید | هیچ یک | آره |
ویژگی های این بسته افزونه
اموال | توضیحات | پیش فرض | مورد نیاز |
---|---|---|---|
bucketName | سطل GCS که این افزونه باید با آن تعامل داشته باشد. | هیچ کدام. | بله. |