Wyświetlasz dokumentację Apigee Edge.
Przejdź do
dokumentacji Apigee X. info
Wersja: 1.1.0
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 do pobierania 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 zasobnika.
Wymagania wstępne
Zanim zaczniesz korzystać z rozszerzenia w proxy interfejsu API za pomocą zasady ExtensionCallout, musisz:
uzyskać identyfikator klucza dostępu i tajny klucz dostępu do zasobnika Amazon S3, z którym będziesz pracować.
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ź
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 |
|---|---|---|---|
| content | Ciąg znaków zawierający zawartość żądanego pliku. | Ciąg znaków. | Brak. |
generateSignedURL
Generuje podpisany adres URL do pobierania 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ź
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 surowy kod JSON, musisz określić parsed="false" w elemencie <Output>, jeśli chcesz. 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żytku w proxy interfejsu API użyj tych informacji. Aby dowiedzieć się, jak skonfigurować rozszerzenie za pomocą konsoli Apigee, przeczytaj artykuł 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 rozszerzenia
Określ wartości tych właściwości konfiguracji, które są specyficzne dla tego rozszerzenia.
| Właściwość | Opis | Domyślny | Wymagane |
|---|---|---|---|
| configuration | Wpisz nazwę zasobnika Amazon S3, którego chcesz używać, np. sample-bucket. |
Brak. | Tak. |
| configuration | Wpisz nazwę regionu AWS, którego chcesz używać, np. us-east-2. |
Brak. | Tak. |
| credentials | Gdy wpiszesz te dane w konsoli Apigee Edge, będzie to plik JSON zawierający identyfikator klucza dostępu i klucz dostępu Amazon w tej postaci:{"accessKeyId" : access-key-ID,"secretAccessKey" : secret-access-key}Gdy dane są wysyłane przez interfejs Management API, jest to wartość zakodowana w formacie base64 wygenerowana z tego pliku klucza JSON. |
Brak. | Tak. |