Расширение Amazon S3

Вы просматриваете документацию Apigee Edge .
Перейти к документации Apigee X.
info

Версия: 2.0.1

Управление файлами в корзине Amazon S3. С помощью этого расширения вы можете перечислять, загружать и удалять файлы. Вы также можете сгенерировать подписанный URL для загрузки файла.

Каждый настроенный экземпляр этого расширения работает с определенным контейнером. Для нескольких контейнеров используйте настроенный экземпляр этого расширения для каждого контейнера.

Предпосылки

Перед использованием расширения из API-прокси с использованием политики ExtensionCallout необходимо:

Они вам понадобятся, а также имя контейнера 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>

Параметры запроса

Параметр Описание Тип По умолчанию Необходимый
имя файла Имя файла для удаления. Нить Никто. Да.

Ответ

Никто.

Свойства ответа

Никто.

скачатьФайл

Загружает указанный файл из контейнера 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!"
}

Свойства ответа

Свойство Описание Тип По умолчанию
содержание Строка, содержащая содержимое запрошенного файла. Нить. Никто.

сгенерироватьSignedURL

Генерирует подписанный 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>

Вы должны указать parsed="false" в элементе <Output> , если хотите, чтобы переменная содержала необработанный JSON. В противном случае переменная не может быть использована.

Пример

<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-файла.
Никто. Да.