Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info
Версия: 2.0.2
Управляйте файлами в хранилище Amazon S3. С помощью этого расширения вы можете просматривать, скачивать и удалять файлы. Вы также можете сгенерировать подписанный URL-адрес для скачивания файла.
Каждый настроенный экземпляр этого расширения работает с определенным сегментом хранилища. Для нескольких сегментов используйте настроенный экземпляр этого расширения для каждого сегмента.
Предварительные требования
Перед использованием расширения через API-прокси с применением политики ExtensionCallout необходимо:
- Получите идентификатор ключа доступа и секретный ключ доступа для хранилища Amazon S3, с которым вы будете работать.
Эти данные, а также имя корзины AWS и регион AWS, понадобятся вам для настройки этого расширения.
О Amazon S3
Amazon Simple Storage Service (Amazon S3) — это сервис объектного хранения данных.
Действия
удалитьФайл
Удаляет указанный файл из хранилища S3.
Синтаксис
<Action>deleteFile</Action>
<Input><![CDATA[
{
"fileName" : "name-of-file-to-delete"
}
]]>
</Input>
Пример
<Action>deleteFile</Action>
<Input><![CDATA[
{
"fileName" : "names.tmp"
}
]]>
</Input>
Параметры запроса
| Параметр | Описание | Тип | По умолчанию | Необходимый |
|---|---|---|---|---|
| имя файла | Имя файла для удаления. | Нить | Никто. | Да. |
Ответ
Никто.
Свойства отклика
Никто.
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>
Параметры запроса
| Параметр | Описание | Тип | По умолчанию | Необходимый |
|---|---|---|---|---|
| имя файла | Название файла для скачивания. | Нить | Никто. | Да. |
Ответ
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>
Параметры запроса
| Параметр | Описание | Тип | По умолчанию | Необходимый |
|---|---|---|---|---|
| имя файла | Название файла для скачивания. | Нить | Никто. | Да. |
| истекаетВ | Время в секундах до истечения срока действия URL-адреса. | Целое число | 86400 | Нет. |
Ответ
JSON-объект со строковым свойством url , содержащим сгенерированный URL-адрес.
{
"url":"https://fake.s3.amazonaws.com/hello_world.txt?AWSAccessKeyId=123&Expires=1542753572&Signature=ABC"
}
Свойства отклика
| Свойство | Описание | Тип | По умолчанию |
|---|---|---|---|
| URL | URL-адрес запрошенного файла. | Нить | Никто. |
список файлов
Инициирует выполнение функции 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"]
Свойства отклика
Никто.
Справочник по конфигурации
При настройке и развертывании этого расширения для использования в 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-файла ключа. | Никто. | Да. |