Phần mở rộng Amazon S3

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X.
thông tin

Phiên bản: 1.1.1

Quản lý tệp trong bộ chứa Amazon S3. Với tiện ích này, bạn có thể liệt kê, tải xuống và xoá tệp. Bạn cũng có thể tạo một URL đã ký để tải tệp xuống.

Mỗi phiên bản được định cấu hình của tiện ích này hoạt động với một bộ chứa cụ thể. Đối với nhiều nhóm, hãy sử dụng phiên bản được định cấu hình của tiện ích này cho mỗi nhóm.

Điều kiện tiên quyết

Trước khi sử dụng tiện ích từ proxy API bằng Chính sách chú thích tiện ích, bạn phải:

Giới thiệu về Amazon S3

Amazon Simple Storage Service (Dịch vụ lưu trữ đơn giản của Amazon) (Amazon S3) là một dịch vụ lưu trữ đối tượng.

Thao tác

deleteFile

Xoá tệp được chỉ định khỏi bộ chứa S3.

Cú pháp

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

Ví dụ:

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

Thông số yêu cầu

Thông số Nội dung mô tả Loại Mặc định Bắt buộc
fileName Tên của tệp cần xoá. Chuỗi Không nội dung nào. Có.

Phản hồi

Không nội dung nào.

Thuộc tính phản hồi

Không nội dung nào.

downloadFile

Tải tệp chỉ định xuống từ bộ chứa S3.

Cú pháp

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

Ví dụ:

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

Thông số yêu cầu

Thông số Nội dung mô tả Loại Mặc định Bắt buộc
fileName Tên của tệp cần tải xuống. Chuỗi Không nội dung nào. Có.

Phản hồi

JSON có thuộc tính content chứa nội dung của tệp.

{
  "content":"Hello World!"
}

Thuộc tính phản hồi

Tài sản Nội dung mô tả Loại Mặc định
kiếm nhiều tiền nhất Một chuỗi ký tự chứa nội dung tệp được yêu cầu. Chuỗi. Không nội dung nào.

generateSignedURL

Tạo URL đã ký để tải tệp được chỉ định xuống từ bộ chứa S3.

Cú pháp

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

Ví dụ:

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

Thông số yêu cầu

Thông số Nội dung mô tả Loại Mặc định Bắt buộc
fileName Tên của tệp cần tải xuống. Chuỗi Không nội dung nào. Có.
expiresIn Thời lượng tính bằng giây cho đến khi URL hết hạn. Số nguyên 86400 Không.

Phản hồi

JSON có thuộc tính chuỗi url chứa URL đã tạo.

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

Thuộc tính phản hồi

Tài sản Nội dung mô tả Loại Mặc định
url URL đến tệp được yêu cầu. Chuỗi Không nội dung nào.

listFiles

Gọi thực thi hàm AWS Lambda.

Cú pháp

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

Bạn phải chỉ định parsed="false" trên phần tử <Output> nếu muốn biến chứa JSON thô. Nếu không, biến sẽ không sử dụng được.

Ví dụ:

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

Thông số yêu cầu

Không nội dung nào.

Phản hồi

Một mảng các tên tệp S3.

["hello_world.txt"]

Thuộc tính phản hồi

Không nội dung nào.

Tài liệu tham khảo về cấu hình

Sử dụng các đoạn mã sau khi bạn định cấu hình và triển khai tiện ích này để sử dụng trong các proxy API. Để biết các bước định cấu hình một tiện ích bằng bảng điều khiển Apigee, hãy xem bài viết Thêm và định cấu hình tiện ích.

Thuộc tính tiện ích phổ biến

Các thuộc tính sau có sẵn cho mỗi tiện ích.

Tài sản Mô tả Mặc định Bắt buộc
name Tên mà bạn đang đặt cho cấu hình của tiện ích này. Không có
packageName Tên của gói tiện ích do Apigee Edge cung cấp. Không có
version Số phiên bản của gói tiện ích mà bạn đang định cấu hình tiện ích. Không có
configuration Giá trị cấu hình cụ thể cho tiện ích bạn đang thêm. Xem Thuộc tính cho gói tiện ích này Không có

Các thuộc tính cho gói tiện ích này

Chỉ định giá trị cho các thuộc tính cấu hình sau dành riêng cho tiện ích này.

Tài sản Nội dung mô tả Mặc định Bắt buộc
cấu hình Nhập tên bộ chứa Amazon S3 để sử dụng, chẳng hạn như sample-bucket. Không nội dung nào. Có.
cấu hình Nhập tên vùng AWS mà bạn muốn sử dụng, chẳng hạn như us-east-2. Không nội dung nào. Có.
thông tin xác thực Khi được nhập vào bảng điều khiển Apigee Edge, đây là một tệp JSON chứa mã khoá truy cập và khoá truy cập Amazon của bạn theo mẫu sau:

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

Khi được gửi qua API quản lý, giá trị này sẽ là giá trị được mã hoá base64 được tạo từ tệp JSON khoá đó.
Không nội dung nào. Có.