Rozszerzenie Amazon S3

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

Wersja: 1.1.0

Zarządzanie plikami w zasobniku Amazon S3. To rozszerzenie pozwala wyświetlać, pobierać i usuwać pliki. Możesz też wygenerować podpisany adres URL do pobrania pliku.

Każda skonfigurowana instancja tego rozszerzenia współpracuje 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 rozszerzenia z serwera proxy interfejsu API za pomocą zasady ExtensionCallout, musisz:

Informacje o Amazon S3

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ślny 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ślny Wymagane
fileName Nazwa pliku do pobrania. Ciąg znaków Brak. Tak.

Odpowiedź

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

{
  "content":"Hello World!"
}

Właściwości odpowiedzi

Właściwość Opis Typ Domyślny
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ślny Wymagane
fileName Nazwa pliku do pobrania. Ciąg znaków Brak. Tak.
expiresIn Czas w sekundach do wygaśnięcia adresu URL. Liczba całkowita 86400 Nie.

Odpowiedź

Plik JSON z właściwością ciągu url, która zawiera 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ślny
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, musisz określić parsed="false" w elemencie <Output> do umieszczenia nieprzetworzonego kodu JSON. 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.

Odniesienie do konfiguracji

Podczas konfigurowania i wdrażania tego rozszerzenia do użycia w serwerach proxy API postępuj zgodnie z tymi instrukcjami. Instrukcje konfigurowania rozszerzenia za pomocą 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ń

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

Właściwość Opis Domyślny 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 Gdy wpisujesz go w konsoli Apigee Edge, jest to plik JSON zawierający identyfikator klucza dostępu Amazon i klucz dostępu w takim formacie:

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

Gdy wysyłasz go za pomocą interfejsu API zarządzania, jest to wartość zakodowana w standardzie Base64 wygenerowana z tego pliku klucza JSON.
Brak. Tak.