Rozszerzenie Amazon S3

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X.
Informacje

Wersja: 1.1.1

Zarządzanie plikami w zasobniku Amazon S3. Dzięki temu rozszerzeniu możesz wyświetlać, pobierać i usuwać pliki. Możesz też wygenerować podpisany adres URL, aby pobrać plik.

Każda skonfigurowana instancja tego rozszerzenia działa z określonym zasobnikiem. W przypadku wielu zasobników użyj skonfigurowanej instancji tego rozszerzenia dla każdego zasobnika.

Wymagania wstępne

Zanim użyjesz zasady ExtensionCallout, musisz użyć rozszerzenia z serwera proxy interfejsu API:

Amazon S3 – informacje

Amazon Simple Storage Service (Amazon S3) to usługa obiektowej pamięci masowej.

Działania

deleteFile

Usuwa określony plik z zasobnika S3.

Składnia

<Action>deleteFile</Action>
<Input><![CDATA[
{
  "fileName" : "name-of-file-to-delete"
}
]]>
</Input>

Przykład

<Action>deleteFile</Action>
<Input><![CDATA[
{
  "fileName" : "names.tmp"
}
]]>
</Input>

Parametry żądania

Parametr Opis Typ Domyślne Wymagane
fileName Nazwa pliku do usunięcia. Ciąg znaków Brak. Tak.

Odpowiedź

Brak.

Właściwości odpowiedzi

Brak.

downloadFile

Pobiera określony plik z zasobnika S3.

Składnia

<Action>downloadFile</Action>
<Input><![CDATA[
{
  "fileName" : "filename"
}
]]>
</Input>
<Output>flow-variable</Output>

Przykład

<Action>downloadFile</Action>
<Input><![CDATA[
{
  "fileName" : "product-sheet.pdf"
}
]]>
</Input>
<Output>downloaded.file</Output>

Parametry żądania

Parametr Opis Typ Domyślne Wymagane
fileName Nazwa pliku do pobrania. Ciąg znaków Brak. Tak.

Odpowiedź

JSON z właściwością content zawierającą treść pliku.

{
  "content":"Hello World!"
}

Właściwości odpowiedzi

Właściwość Opis Typ Domyślne
treść Ciąg tekstowy zawierający treść żądanego pliku. Ciąg tekstowy. Brak.

generateSignedURL

Generuje podpisany adres URL do pobrania określonego pliku z zasobnika S3.

Składnia

<Action>generateSignedURL</Action>
<Input><![CDATA[
{
  "fileName": "filename",
  "expiresIn": duration-in-seconds
}
]]>
</Input>
<Output>flow-variable</Output>

Przykład

<Action>generateSignedURL</Action>
<Input><![CDATA[
{
  "fileName": "product-info.pdf",
  "expiresIn": 3600
}
]]>
</Input>
<Output>download.url</Output>

Parametry żądania

Parametr Opis Typ Domyślne Wymagane
fileName Nazwa pliku do pobrania. Ciąg znaków Brak. Tak.
expiresIn Czas do wygaśnięcia adresu URL (w sekundach). Liczba całkowita 86400 Nie.

Odpowiedź

Plik JSON z właściwością ciągu url zawierającą wygenerowany adres URL.

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

Właściwości odpowiedzi

Właściwość Opis Typ Domyślne
url (adres URL) Adres URL żądanego pliku. Ciąg znaków Brak.

listFiles

Wywołuje wykonanie funkcji AWS Lambda.

Składnia

<Action>listFiles</Action>
<Input><![CDATA[{}]]></Input>
<Output>flow-variable</Output>

Jeśli chcesz, by zmienna zawierała nieprzetworzony plik JSON, musisz w elemencie <Output> określić parsed="false". W przeciwnym razie zmienna jest bezużyteczna.

Przykład

<Action>listFiles</Action>
<Input><![CDATA[{}]]></Input>
<Output parsed="false">listFilesOutput</Output>

Parametry żądania

Brak.

Odpowiedź

Tablica nazw plików S3.

["hello_world.txt"]

Właściwości odpowiedzi

Brak.

Dokumentacja konfiguracji

Skorzystaj z podanych niżej instrukcji podczas konfigurowania i wdrażania tego rozszerzenia na potrzeby serwerów proxy interfejsów API. Instrukcje konfigurowania rozszerzenia w konsoli Apigee znajdziesz w artykule Dodawanie i konfigurowanie rozszerzenia.

Typowe właściwości rozszerzeń

Dla każdego rozszerzenia dostępne są poniższe właściwości.

Usługa Opis Domyślnie Wymagany
name Nazwa nadana konfiguracji rozszerzenia. Brak Tak
packageName Nazwa pakietu rozszerzeń podana przez Apigee Edge. Brak Tak
version Numer wersji pakietu rozszerzenia, z którego konfigurujesz rozszerzenie. Brak Tak
configuration Wartość konfiguracji specyficzna dla dodawanego rozszerzenia. Zobacz Właściwości tego pakietu rozszerzeń Brak Tak

Właściwości tego pakietu rozszerzeń

Podaj wartości następujących właściwości konfiguracji specyficznych dla tego rozszerzenia.

Właściwość Opis Domyślne Wymagane
konfiguracja Wpisz nazwę zasobnika Amazon S3, którego chcesz użyć, na przykład sample-bucket. Brak. Tak.
konfiguracja Wpisz nazwę regionu AWS, którego chcesz użyć, np. us-east-2. Brak. Tak.
dane logowania Wpisany w konsoli Apigee Edge jest to plik JSON zawierający identyfikator klucza dostępu Amazon i klucz dostępu w takiej postaci:

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

Wysyłana za pomocą interfejsu API zarządzania jest wartością zakodowaną w formacie base64 wygenerowaną na podstawie tego klucza pliku JSON.
Brak. Tak.