Rozszerzenie Amazon S3

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Wersja: 1.0.0

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 ramach 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 zawartość żą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 wygaśnie. 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.

Odwołanie do konfiguracji

Podczas konfigurowania i wdrażania tego rozszerzenia do użycia w proxy interfejsów 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 rozszerzeń

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

Właściwości tego pakietu rozszerzeń

Określ wartości tych właściwości konfiguracji, które są specyficzne 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 jest to plik JSON zawierający identyfikator klucza dostępu Amazon i klucz dostępu w tej postaci:

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

Wysłany za pomocą interfejsu Management API jest to wartość zakodowana w standardzie Base64 wygenerowana z tego pliku JSON klucza.
Brak. Tak.