Amazon S3-Erweiterung

Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an.
info

Version: 2.0.0

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 arbeitet mit einem bestimmten Bucket. Verwenden Sie für mehrere Buckets eine konfigurierte Instanz dieser Erweiterung für jeden Bucket.

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 zusammen mit dem Namen des AWS-Buckets und der AWS-Region, um diese Erweiterung zu configure.

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 Datei, die gelöscht werden soll. String Keine. Ja.

Antwort

Keine.

Antworteigenschaften

Keine.

downloadFile

Hiermit wird die angegebene Datei aus einem S3-Bucket heruntergeladen.

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 Datei, die heruntergeladen werden soll. String Keine. Ja.

Antwort

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

{
  "content":"Hello World!"
}

Antworteigenschaften

Attribut Beschreibung Typ Standard
Inhalt Ein String, der den Inhalt der angeforderten Datei enthält. 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 Datei, die heruntergeladen werden soll. String Keine. Ja.
expiresIn Die Dauer in Sekunden, nach der die URL abläuft. Ganzzahl 86400 Nein.

Antwort

JSON mit einer Stringeigenschaft url, die die generierte URL enthält.

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

Antworteigenschaften

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>

Du musst parsed="false" für das Element <Output> angeben, wenn die Variable den Roh-JSON-Code enthalten soll. Andernfalls kann die Variable nicht verwendet werden.

Beispiel

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

Anfrageparameter

Keine.

Antwort

Ein Array von S3-Dateinamen.

["hello_world.txt"]

Antworteigenschaften

Keine.

Konfigurationsreferenz

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

Gängige 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

Properties für dieses Erweiterungspaket

Geben Sie Werte für die folgenden Konfigurationseigenschaften an, die speziell für diese Erweiterung gelten.

Attribut Beschreibung Standard Erforderlich
Konfiguration Geben Sie den Namen des zu verwendenden Amazon S3-Buckets ein, 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 diese Informationen in die Apigee Edge-Konsole eingeben, handelt es sich um eine JSON-Datei, die Ihre Amazon-Zugriffsschlüssel-ID und den Zugriffsschlüssel im folgenden Format enthält:

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

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