Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
Version: 1.1.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 funktioniert mit einem bestimmten Bucket. Bei mehreren Buckets verwenden Sie für jeden Bucket eine konfigurierte Instanz dieser Erweiterung.
Voraussetzungen
Bevor Sie die Erweiterung mithilfe der ExtensionCallout-Richtlinie von einem API-Proxy verwenden, müssen Sie Folgendes tun:
Rufen Sie die Zugriffsschlüssel-ID und den geheimen Zugriffsschlüssel für den Amazon S3-Bucket ab, mit dem Sie arbeiten werden.
Sie benötigen diese zusammen mit dem AWS-Bucket-Namen und der AWS-Region, um diese Erweiterung configure.
Über 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 einem content
-Attribut, das den Inhalt der Datei enthält.
{
"content":"Hello World!"
}
Antwortattribute
Property | 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 herunterzuladenden Datei. | String | Keine. | Ja. |
expiresIn | Die Dauer in Sekunden, bis die URL abläuft. | Ganzzahl | 86400 | Nein. |
Antwort
JSON mit einem Stringattribut url
, das die generierte URL enthält.
{
"url":"https://fake.s3.amazonaws.com/hello_world.txt?AWSAccessKeyId=123&Expires=1542753572&Signature=ABC"
}
Antwortattribute
Property | Beschreibung | Typ | Standard |
---|---|---|---|
URL | Eine URL zur angeforderten Datei. | String | Keine. |
listFiles
Löst die Ausführung einer AWS Lambda-Funktion aus.
Syntax
<Action>listFiles</Action>
<Input><![CDATA[{}]]></Input>
<Output>flow-variable</Output>
Sie müssen parsed="false"
für das <Output>
-Element angeben, wenn die Variable die JSON-Rohdaten 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 mit S3-Dateinamen.
["hello_world.txt"]
Antwortattribute
Keine.
Konfigurationsreferenz
Verwenden Sie Folgendes, wenn Sie diese Erweiterung zur 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.
Häufige 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 dieses Erweiterungspakets
Geben Sie Werte für die folgenden Konfigurationseigenschaften an, die spezifisch für diese Erweiterung sind.
Property | 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 AWS-Region ein, die verwendet werden soll, z. B. us-east-2 . |
Keine. | Ja. |
Anmeldedaten | Bei Eingabe in die Apigee Edge-Konsole ist dies eine JSON-Datei, die Ihre Amazon-Zugriffsschlüssel-ID und Ihren Zugriffsschlüssel in der folgenden Form enthält:{ "accessKeyId" : access-key-ID, "secretAccessKey" : secret-access-key } Beim Senden über die Management API ist es ein base64-codierter Wert, der aus dieser JSON-Schlüsseldatei generiert wird. |
Keine. | Ja. |