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

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

Версия: 1.0.0

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

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

Предварительные условия

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

Об 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!"
}

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

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

генерироватьподписанныйURL

Создает подписанный 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.
Никто. Да.