Apigee Edge belgelerini görüntülüyorsunuz.
Git:
Apigee X belgeleri. bilgi
Sürüm: 1.1.1
Amazon S3 paketindeki dosyaları yönetin. Bu uzantıyla dosyaları listeleyebilir, indirebilir ve silebilirsiniz. Dosya indirmek için imzalı bir URL de oluşturabilirsiniz.
Bu uzantının her yapılandırılmış örneği belirli bir paketle çalışır. Birden fazla pakette, her paket için bu uzantının yapılandırılmış bir örneğini kullanın.
Ön koşullar
ExtensionCall politikası ile uzantıyı bir API proxy'sinden kullanmadan önce şunları yapmanız gerekir:
Birlikte çalışacağınız Amazon S3 paketi için erişim anahtarı kimliğini ve gizli erişim anahtarını edinin.
Bu uzantıyı yapılandırmak için AWS paket adı ve AWS bölgesiyle birlikte bunlara ihtiyacınız olacaktır.
Amazon S3 hakkında
Amazon Simple Storage Service (Amazon S3) bir nesne depolama hizmetidir.
İşlemler
deleteFile
Belirtilen dosyayı S3 paketinden siler.
Söz dizimi
<Action>deleteFile</Action>
<Input><![CDATA[
{
"fileName" : "name-of-file-to-delete"
}
]]>
</Input>
Örnek
<Action>deleteFile</Action>
<Input><![CDATA[
{
"fileName" : "names.tmp"
}
]]>
</Input>
İstek parametreleri
Parametre | Açıklama | Tür | Varsayılan | Zorunlu |
---|---|---|---|---|
fileName | Silinecek dosyanın adı. | Dize | Yok. | Evet. |
Yanıt
Yok.
Yanıt özellikleri
Yok.
downloadFile
Belirtilen dosyayı bir S3 paketinden indirir.
Söz dizimi
<Action>downloadFile</Action>
<Input><![CDATA[
{
"fileName" : "filename"
}
]]>
</Input>
<Output>flow-variable</Output>
Örnek
<Action>downloadFile</Action>
<Input><![CDATA[
{
"fileName" : "product-sheet.pdf"
}
]]>
</Input>
<Output>downloaded.file</Output>
İstek parametreleri
Parametre | Açıklama | Tür | Varsayılan | Zorunlu |
---|---|---|---|---|
fileName | İndirilecek dosyanın adı. | Dize | Yok. | Evet. |
Yanıt
Dosyanın içeriğini barındıran content
özelliğine sahip JSON.
{
"content":"Hello World!"
}
Yanıt özellikleri
Özellik | Açıklama | Tür | Varsayılan |
---|---|---|---|
içerik | İstenen dosyanın içeriğini içeren bir dize. | Dize. | Yok. |
generateSignedURL
Belirtilen dosyayı bir S3 paketinden indirmek için imzalı URL oluşturur.
Söz dizimi
<Action>generateSignedURL</Action>
<Input><![CDATA[
{
"fileName": "filename",
"expiresIn": duration-in-seconds
}
]]>
</Input>
<Output>flow-variable</Output>
Örnek
<Action>generateSignedURL</Action>
<Input><![CDATA[
{
"fileName": "product-info.pdf",
"expiresIn": 3600
}
]]>
</Input>
<Output>download.url</Output>
İstek parametreleri
Parametre | Açıklama | Tür | Varsayılan | Zorunlu |
---|---|---|---|---|
fileName | İndirilecek dosyanın adı. | Dize | Yok. | Evet. |
expiresIn | URL'nin geçerlilik süresinin sona ermesine kalan süre (saniye cinsinden). | Tamsayı | 86400 | Sıra |
Yanıt
Oluşturulan URL'yi içeren url
dize özelliğine sahip JSON.
{
"url":"https://fake.s3.amazonaws.com/hello_world.txt?AWSAccessKeyId=123&Expires=1542753572&Signature=ABC"
}
Yanıt özellikleri
Özellik | Açıklama | Tür | Varsayılan |
---|---|---|---|
url | İstenen dosyanın URL'si. | Dize | Yok. |
listFiles
Bir AWS Lambda işlevinin yürütülmesini çağırır.
Söz dizimi
<Action>listFiles</Action>
<Input><![CDATA[{}]]></Input>
<Output>flow-variable</Output>
Değişkenin ham JSON içermesini istiyorsanız <Output>
öğesinde parsed="false"
belirtmeniz gerekir. Aksi takdirde, değişken kullanılamaz.
Örnek
<Action>listFiles</Action>
<Input><![CDATA[{}]]></Input>
<Output parsed="false">listFilesOutput</Output>
İstek parametreleri
Yok.
Yanıt
S3 dosya adları dizisi.
["hello_world.txt"]
Yanıt özellikleri
Yok.
Yapılandırma Referansı
Bu uzantıyı API proxy'lerinde kullanmak üzere yapılandırıp dağıtırken aşağıdakileri kullanın. Apigee konsolunu kullanarak uzantı yapılandırma adımları için Uzantı ekleme ve yapılandırma'ya bakın.
Sık kullanılan uzantı özellikleri
Aşağıdaki özellikler her uzantı için mevcuttur.
Mülk | Açıklama | Varsayılan | Zorunlu |
---|---|---|---|
name |
Uzantının bu yapılandırmasını verdiğiniz ad. | Yok | Evet |
packageName |
Apigee Edge'in sağladığı uzantı paketinin adı. | Yok | Evet |
version |
Uzantıyı yapılandırdığınız uzantı paketinin sürüm numarası. | Yok | Evet |
configuration |
Eklediğiniz uzantıya özgü yapılandırma değeri. Bu uzantı paketinin özellikleri başlıklı makaleyi inceleyin | Yok | Evet |
Bu uzantı paketinin özellikleri
Bu uzantıya özgü aşağıdaki yapılandırma özellikleri için değerler belirtin.
Özellik | Açıklama | Varsayılan | Zorunlu |
---|---|---|---|
yapılandırma | Kullanılacak Amazon S3 paketinin adını (ör. sample-bucket ) girin. |
Yok. | Evet. |
yapılandırma | Kullanılacak AWS bölgesinin adını girin (ör. us-east-2 ). |
Yok. | Evet. |
giriş bilgileri | Apigee Edge konsoluna girildiğinde, Amazon erişim anahtar kimliğinizi ve erişim anahtarınızı aşağıdaki biçimde içeren bir JSON dosyasıdır:{ "accessKeyId" : access-key-ID, "secretAccessKey" : secret-access-key } Yönetim API'si aracılığıyla gönderildiğinde, bu anahtar JSON dosyasından oluşturulan base64 kodlu bir değerdir. |
Yok. | Evet. |