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

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

Версия: 1.1.1

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

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

Требования

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

Об 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>

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

Параметр Описание Тип По умолчанию Обязательно
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>

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

Параметр Описание Тип По умолчанию Обязательно
fileName Название файла, который нужно скачать. Строка Нет. Да.

Ответ

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>

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

Параметр Описание Тип По умолчанию Обязательно
fileName Название файла, который нужно скачать. Строка Нет. Да.
expiresIn Время в секундах до истечения срока действия URL. Целое число 86400 Нет.

Ответ

JSON со строковым свойством url, содержащим сгенерированный URL.

{
  "url":"https://fake.s3.amazonaws.com/hello_world.txt?AWSAccessKeyId=123&Expires=1542753572&Signature=ABC"
}

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

Свойство Описание Тип По умолчанию
url URL запрошенного файла. Строка Нет.

listFiles

Вызывает выполнение функции 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 приведены в разделе Добавление и настройка расширения.

Общие свойства расширений

The following properties are present for every extension.

Property Description Default Required
name Name you're giving this configuration of the extension. None Yes
packageName Name of the extension package as given by Apigee Edge. None Yes
version Version number for the extension package from which you're configuring an extension. None Yes
configuration Configuration value specific to the extension you're adding. See Properties for this extension package None Yes

Свойства пакета расширения

Укажите значения для следующих свойств конфигурации, относящихся к этому расширению.

Свойство Описание По умолчанию Обязательно
конфигурация Введите название сегмента Amazon S3, например sample-bucket. Нет. Да.
конфигурация Введите название региона AWS, который хотите использовать, например us-east-2. Нет. Да.
учетные данные При вводе в консоли Apigee Edge это файл JSON, содержащий идентификатор ключа доступа и ключ доступа Amazon в следующем формате:

{
"accessKeyId" : access-key-ID,
"secretAccessKey" : secret-access-key
}

При отправке через API управления это значение, закодированное по алгоритму Base64 и сгенерированное из этого файла JSON ключа.
Нет. Да.