Rozszerzenie Amazon S3

Wyświetlasz dokumentację Apigee Edge.
Zapoznaj się z dokumentacją Apigee X. info

Wersja: 2.0.1

zarządzać plikami w zasobniku Amazon S3; Za pomocą tego rozszerzenia możesz wyświetlać, pobierać i usuwać pliki. Możesz też wygenerować podpisany adres URL do pobrania pliku.

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 z nich.

Wymagania wstępne

Zanim zaczniesz korzystać z rozszerzenia w proxy interfejsu API za pomocą zasady ExtensionCallout, musisz:

Będą one potrzebne wraz z nazwą zasobnika AWS i regionem AWS do skonfigurowania tego rozszerzenia.

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, po którym adres URL wygasa. Liczba całkowita 86400 Nie.

Odpowiedź

Plik JSON z właściwością ciągu znaków 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ś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, aby zmienna zawierała nieprzetworzony kod JSON, musisz określić parsed="false" w elemencie <Output>. W przeciwnym razie zmienna nie będzie uż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.

Informacje o konfiguracji

Podczas konfigurowania i wdrażania tego rozszerzenia do użycia w proxy interfejsu API postępuj zgodnie z tymi instrukcjami. Instrukcje konfigurowania rozszerzenia za pomocą konsoli Apigee znajdziesz w artykule Dodawanie i konfigurowanie rozszerzenia.

Wspólne właściwości rozszerzenia

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 tych 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żywać, np. sample-bucket. Brak. Tak.
konfiguracja Wpisz nazwę regionu AWS, którego chcesz używać, np. us-east-2. Brak. Tak.
dane logowania Wpisany w konsoli Apigee Edge plik JSON zawiera identyfikator klucza dostępu do Amazon i klucz dostępu w tej postaci:

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

Wysłany za pomocą interfejsu Management API jest wartością zakodowaną w standardzie Base64 wygenerowaną z tego pliku JSON klucza.
Brak. Tak.