Amazon S3-Erweiterung

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu Apigee X
info

Version: 2.0.1

Dateien in einem Amazon S3-Bucket verwalten Mit dieser Erweiterung können Sie Dateien auflisten, herunterladen und löschen. Sie können auch eine signierte URL zum Herunterladen einer Datei generieren.

Jede konfigurierte Instanz dieser Erweiterung funktioniert mit einem bestimmten Bucket. Wenn Sie mehrere Buckets verwenden, müssen Sie für jeden Bucket eine konfigurierte Instanz dieser Erweiterung verwenden.

Vorbereitung

Bevor Sie die Erweiterung über einen API-Proxy mit der ExtensionCallout-Richtlinie verwenden können, müssen Sie Folgendes tun:

Sie benötigen diese Informationen zusammen mit dem AWS-Bucket-Namen und der AWS-Region, um diese Erweiterung zu konfigurieren.

Amazon S3

Amazon Simple Storage Service (Amazon S3) ist ein Objektspeicherdienst.

Aktionen

deleteFile

Löscht die angegebene Datei aus einem S3-Bucket.

Syntax

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

Beispiel

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

Anfrageparameter

Parameter Beschreibung Typ Standard Erforderlich
fileName Der Name der zu löschenden Datei. String Keine. Ja.

Antwort

Keine.

Antwortattribute

Keine.

downloadFile

Lädt die angegebene Datei aus einem S3-Bucket herunter.

Syntax

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

Beispiel

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

Anfrageparameter

Parameter Beschreibung Typ Standard Erforderlich
fileName Der Name der herunterzuladenden Datei. String Keine. Ja.

Antwort

JSON mit dem Attribut content, das den Inhalt der Datei enthält.

{
  "content":"Hello World!"
}

Antwortattribute

Attribut Beschreibung Typ Standard
Inhalt Ein String mit dem Inhalt der angeforderten Datei. String. Keine.

generateSignedURL

Generiert eine signierte URL zum Herunterladen der angegebenen Datei aus einem S3-Bucket.

Syntax

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

Beispiel

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

Anfrageparameter

Parameter Beschreibung Typ Standard Erforderlich
fileName Der Name der herunterzuladenden Datei. String Keine. Ja.
expiresIn Die Dauer in Sekunden, bis die URL abläuft. Ganzzahl 86400 Nein.

Antwort

JSON mit einem url-String-Attribut, das die generierte URL enthält.

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

Antwortattribute

Attribut Beschreibung Typ Standard
URL Eine URL zur angeforderten Datei. String Keine.

listFiles

Ruft die Ausführung einer AWS Lambda-Funktion auf.

Syntax

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

Sie müssen parsed="false" für das Element <Output> angeben, wenn die Variable das Roh-JSON enthalten soll. Andernfalls ist die Variable nicht verwendbar.

Beispiel

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

Anfrageparameter

Keine.

Antwort

Ein Array mit S3-Dateinamen.

["hello_world.txt"]

Antwortattribute

Keine.

Konfigurationsreferenz

Verwenden Sie die folgenden Informationen, wenn Sie diese Erweiterung für die Verwendung in API-Proxys konfigurieren und bereitstellen. Eine Anleitung zum Konfigurieren einer Erweiterung mit der Apigee-Konsole finden Sie unter Erweiterung hinzufügen und konfigurieren.

Allgemeine Erweiterungseigenschaften

Für jede Erweiterung sind die folgenden Eigenschaften vorhanden.

Attribut Beschreibung Standard Erforderlich
name Der Name, den Sie dieser Konfiguration der Erweiterung zuweisen. Ja
packageName Name des Erweiterungspakets, wie von Apigee Edge angegeben. Ja
version Versionsnummer für das Erweiterungspaket, von dem Sie eine Erweiterung konfigurieren. Ja
configuration Konfigurationswert speziell für die Erweiterung, die Sie hinzufügen. Weitere Informationen finden Sie unter Eigenschaften für dieses Erweiterungspaket. Ja

Eigenschaften für dieses Erweiterungspaket

Geben Sie Werte für die folgenden Konfigurationseigenschaften an, die für diese Erweiterung spezifisch sind.

Attribut Beschreibung Standard Erforderlich
Konfiguration Geben Sie den Namen des Amazon S3-Buckets ein, den Sie verwenden möchten, z. B. sample-bucket. Keine. Ja.
Konfiguration Geben Sie den Namen der zu verwendenden AWS-Region ein, z. B. us-east-2. Keine. Ja.
Anmeldedaten Wenn Sie die Datei in der Apigee Edge-Konsole eingeben, handelt es sich um eine JSON-Datei mit Ihrer Amazon-Zugriffsschlüssel-ID und Ihrem Zugriffsschlüssel in der folgenden Form:

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

Wenn Sie die Datei über die Management API senden, handelt es sich um einen base64-codierten Wert, der aus dieser JSON-Schlüsseldatei generiert wird.
Keine. Ja.