Quản lý tài nguyên

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

Tìm hiểu và quản lý tài nguyên, như được mô tả trong các phần sau.

Giới thiệu về tài nguyên

Nhiều loại chính sách dựa trên tài nguyên. Tài nguyên là các tệp triển khai mã hoặc cấu hình sẽ được thực thi bởi một chính sách khi được đính kèm với một API proxy. Trong một số trường hợp, như với JavaScript và JavaChú thích, chính sách chỉ xác định tệp đính kèm trỏ vào proxy API nơi một số mã sẽ thực thi. Chính sách JavaScript hoặc JavaAnnotation là con trỏ đến một tài nguyên.

Mã JavaScript mẫu sau đây đặt đường dẫn yêu cầu HTTP thành giá trị của biến proxy.basepath.

request.headers["RequestPath"] = context.getVariable("proxy.basepath");

Loại tài nguyên

Bảng sau đây tóm tắt các loại tài nguyên:

Loại tài nguyên Mô tả
JAR (java) Các lớp Java trong tệp JAR được tham chiếu theo chính sách JavaCallout.
JavaScript (js) JavaScript được tham chiếu theo chính sách JavaScript.
JavaScript (jsc) JavaScript đã biên dịch được tham chiếu theo chính sách JavaScript.
Hosted target (hosted) Tệp Node.js để triển khai cho Mục tiêu được lưu trữ. Bạn có thể triển khai Node.js làm các ứng dụng phụ trợ nhắm mục tiêu của Edge.
Node (node) Tệp Node.js, bao gồm tệp Node.js chính, các tệp nguồn có liên quan, và các phần phụ thuộc của mô-đun.
Python (py) Các tập lệnh Python được tham chiếu theo các chính sách của Python. Tài nguyên phải được triển khai bằng "Python thuần túy" (chỉ bằng ngôn ngữ Python).
WSDL (wsdl) Các tệp WSDL được tham chiếu theo các chính sách SOAPMessageValidation.
XSD (xsd) Giản đồ XML được tham chiếu theo các chính sách SOAPMessageValidation.
XSL Transformations (xsl) Các phép chuyển đổi Chrome được tham chiếu theo các chính sách XSLTransform.

Vị trí lưu trữ tài nguyên

Tài nguyên có thể được lưu trữ ở một trong ba vị trí sau:

  • Sửa đổi proxy API: Có tài nguyên chỉ đối với các bản sửa đổi proxy API có chứa tài nguyên. Ví dụ: bạn có thể bao gồm tài nguyên JavaScript với bản sửa đổi 1 của proxy API, sau đó thay đổi để sử dụng tập lệnh Python trong bản sửa đổi 2 của proxy. Bản sửa đổi 1 có quyền truy cập chỉ tài nguyên JavaScript và bản sửa đổi 2 chỉ có quyền truy cập vào tài nguyên Python.
  • Môi trường: Khi được lưu trữ trong một môi trường (ví dụ: test hoặc prod), có sẵn cho mọi proxy API được triển khai trong cùng một môi trường.
  • Tổ chức: Khi được lưu trữ trong tổ chức, tài nguyên có sẵn cho mọi proxy API được triển khai trong mọi môi trường.

Các kho lưu trữ có sẵn tại các URI sau, như được mô tả trong Resource files API (API tệp tài nguyên) và sau đó trong phần Quản lý tài nguyên bằng API:

  • Tổ chức: /organizations/{org}/resourcefiles
  • Môi trường: /organizations/{org}/environments/{env}/resourcefiles
  • Proxy API: /organizations/{org}/apis/{api}/revisions/{rev}/resources

Bảng sau đây trình bày các phương thức mà bạn có thể sử dụng để tạo, cập nhật, và xoá tài nguyên của mỗi kho lưu trữ:

Kho lưu trữ Tạo Xem Cập nhật Xoá
API Giao diện người dùng API Giao diện người dùng API Giao diện người dùng API Giao diện người dùng
Bản sửa đổi proxy API
Môi trường
Tổ chức

Ví dụ: tất cả các tệp JavaScript có sẵn cho môi trường test đều được lưu trữ trong kho lưu trữ sau đây và có sẵn cho mọi proxy API chạy trong môi trường test:

/organizations/{org}/environments/test/resourcefiles/jsc

Nguyên tắc về tài nguyên Java

Bạn có thể thêm các tài nguyên Java đã biên dịch dưới dạng tệp JAR bằng cách sử dụng nhiều tuỳ chọn trong curl, chẳng hạn như Tuỳ chọn -T, --data-binary hoặc -F (không phải tuỳ chọn -d ). Ví dụ:

curl "http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java" \
  -X POST \
  --data-binary @{jar_file} \
  -H "Content-Type: application/octet-stream" \
  -u email:password
curl -v "http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java"
  -X POST \
  -H "Content-Type: application/octet-stream" \
  -T "{jar_file}" \
  -u email:password
curl -v "http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java"
  -X POST \
  -H "Content-Type: application/multipart/form-data" \
  -F "file=@{jar_file}" \
  -u email:password

Xem thêm:

Nguyên tắc về tài nguyên Node.js

Khi tham chiếu tập lệnh Node.js trong một proxy API, bạn sẽ thực hiện việc này bằng <ResourceURL> phần tử trong cấu hình TargetEndpoint của proxy API, như được mô tả trong phần Thêm Node.js vào API hiện có proxy. Ví dụ:

<ScriptTarget>
    <ResourceURL>node://hello-world.js</ResourceURL>
</ScriptTarget>

Tập lệnh Node.js đó và tất cả mô-đun hỗ trợ phải nằm trong phạm vi sửa đổi proxy API (trong thư mục /resources/node của gói proxy). Trong trình chỉnh sửa proxy API, hãy thêm tài nguyên Node.js đến phần Tập lệnh giúp hoàn thành việc này. Việc sử dụng API cũng vậy (importcập nhật) để lưu trữ tài nguyên ở phạm vi sửa đổi proxy API.

Quản lý tài nguyên bằng giao diện người dùng

Quản lý tài nguyên trong phạm vi bản sửa đổi proxy API bằng cách sử dụng giao diện người dùng, như mô tả trong các phần sau.

Xem tài nguyên bằng giao diện người dùng

Cách xem các tài nguyên thuộc phạm vi của bản sửa đổi proxy API:

  1. Đăng nhập vào apigee.com/edge.

  2. Chọn Phát triển > Proxy API trong thanh điều hướng bên trái.
  3. Chọn một proxy API trong danh sách mà bạn muốn tạo tài nguyên.
    Theo mặc định, trình chỉnh sửa proxy API sẽ mở ra và thẻ Tổng quan sẽ hiển thị.
  4. Nhấp vào thẻ Phát triển.
  5. Chọn bản sửa đổi trong trình đơn thả xuống Bản sửa đổi (nếu cần).

    Các tài nguyên trong phạm vi bản sửa đổi proxy API được liệt kê trong phần Tài nguyên trong chế độ xem Trình điều hướng.

Tạo tài nguyên bằng giao diện người dùng

Cách tạo tài nguyên thuộc phạm vi của bản sửa đổi proxy API bằng giao diện người dùng:

  1. Xem tài nguyên trong phạm vi bản sửa đổi proxy API.
  2. Nhấp vào dấu + trong phần Tài nguyên trong chế độ xem Navigator để mở hộp thoại New Resource (Tài nguyên mới).
  3. Nhập thông tin sau:
    Trường Mô tả
    Nguồn Chọn tạo tệp mới hoặc nhập tệp.
    Loại tệp Chọn một loại tài nguyên trong danh sách thả xuống.
    Tên tệp Tên tệp. Đuôi tên tệp phải hợp lệ đối với loại tệp đã chọn.

Cập nhật tài nguyên bằng giao diện người dùng

Cách cập nhật tài nguyên trong phạm vi bản sửa đổi proxy API bằng giao diện người dùng:

  1. Xem tài nguyên trong phạm vi bản sửa đổi proxy API.
  2. Trong chế độ xem Trình điều hướng trong phần Tài nguyên, hãy nhấp vào tài nguyên bạn muốn cập nhật.
    Lưu ý: Đối với các tệp JAR, hãy đặt con trỏ lên tài nguyên mà bạn muốn chỉnh sửa rồi nhấp vào .
  3. Cập nhật tài nguyên, nếu cần.
    Lưu ý: Sau khi tải tệp JAR mới lên, hãy nhấp vào Cập nhật.

Xoá tài nguyên bằng giao diện người dùng

Để huỷ bỏ một tài nguyên trong phạm vi của bản sửa đổi proxy API bằng cách sử dụng giao diện người dùng, hãy làm như sau:

  1. Xem tài nguyên trong phạm vi bản sửa đổi proxy API.
  2. Trong chế độ xem Điều hướng trong phần Tài nguyên, đặt con trỏ lên tài nguyên bạn muốn xoá để hiển thị trình đơn thao tác.
  3. Nhấp vào .
  4. Nhấp vào Xoá để xác nhận thao tác.

Quản lý tài nguyên bằng API

Quản lý tài nguyên bằng API, như mô tả trong các phần sau.

Tạo tài nguyên bằng API

Tạo tài nguyên thuộc phạm vi của một bản sửa đổi proxy API, môi trường hoặc tổ chức (chỉ đối với Edge), như mô tả trong các phần sau.

Tạo tài nguyên trong phạm vi bản sửa đổi proxy API bằng API

Tạo tài nguyên trong phạm vi bản sửa đổi proxy API thông qua API bằng cách tạo một yêu cầu POST cho tài nguyên sau: https://api.enterprise.apigee.com/v1/organizations/{org}/apis/{api}/revisions/{rev}/resourcefiles

Chuyển thông tin sau đây cùng với yêu cầu của bạn:

  • Đặt tham số truy vấn name thành tên của tài nguyên
  • Đặt tham số truy vấn type thành loại tài nguyên bắt buộc
  • Truyền nội dung của tệp tài nguyên dưới dạng application/octet-stream hoặc multipart/form-data)

Ví dụ sau đây sẽ tạo một tệp JavaScript có tên pathSetter.js cho bản sửa đổi 1 của proxy API helloworld:

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

Ví dụ sau đây cho biết cách tải tài nguyên lên dưới dạng tệp từ máy cục bộ. Bạn cần phải sử dụng -F để tải lên tệp nhị phân trong curl nhằm đảm bảo môi trường- hoặc tệp JavaScript ở phạm vi tổ chức mà chính sách JavaScript có thể truy cập.

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

Sau đây là ví dụ về phản hồi từ một trong hai lệnh gọi API.

{
  "name": "pathSetter.js",
  "type": "jsc"
}

Để biết thêm thông tin, hãy xem phần Nhập tệp tài nguyên để sửa đổi proxy API.

Ngoài ra, bạn có thể sử dụng API sửa đổi proxy API Cập nhật như sau:

  1. Tạo tệp tài nguyên.
  2. Thêm tệp tài nguyên vào một gói cấu hình proxy API.
  3. Tải gói lên bằng một trong các API sau:

Tạo tài nguyên trong phạm vi một môi trường bằng API

Tạo tài nguyên JavaScript trong phạm vi một môi trường bằng cách sử dụng API bằng cách tạo một yêu cầu POST cho tài nguyên sau: /organizations/{org}/environments/{env}/resourcefiles

Chuyển các thông tin sau cùng với yêu cầu của bạn:

  • Đặt tham số truy vấn name thành tên của tài nguyên
  • Đặt tham số truy vấn type thành loại tài nguyên bắt buộc
  • Truyền nội dung của tệp tài nguyên dưới dạng application/octet-stream hoặc multipart/form-data)

Ví dụ sau cho biết cách tạo tài nguyên JavaScript bằng cách chuyển nội dung của tài nguyên đó vào phần nội dung yêu cầu.

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

Ví dụ sau cho biết cách tải tài nguyên lên dưới dạng tệp từ máy cục bộ. Bạn cần phải sử dụng -F để tải lên tệp nhị phân trong curl nhằm đảm bảo môi trường- hoặc tệp JavaScript ở phạm vi tổ chức mà chính sách JavaScript có thể truy cập.

curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

Sau đây là ví dụ về phản hồi:

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Tạo tài nguyên trong phạm vi tổ chức bằng API

Để tạo một tài nguyên thuộc phạm vi của một tổ chức bằng API, hãy đưa ra yêu cầu POST cho tài nguyên sau: https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles

Chuyển những thông tin sau đây cùng với yêu cầu của bạn:

  • Đặt tham số truy vấn name thành tên của tài nguyên
  • Đặt tham số truy vấn type thành loại tệp tài nguyên (xem Loại tài nguyên)
  • Truyền nội dung của tệp tài nguyên dưới dạng application/octet-stream hoặc multipart/form-data)

Để biết thêm thông tin, hãy xem bài viết Nhập tệp tài nguyên cho tổ chức.

Xem tài nguyên bằng API

Các phần sau đây mô tả cách xem tài nguyên bằng API.

Xem tất cả tài nguyên bằng API

Khi sử dụng API, bạn có thể xem các tài nguyên thuộc phạm vi bản sửa đổi proxy API, môi trường hoặc tổ chức.

Ví dụ: để xem tài nguyên cho các tài nguyên thuộc phạm vi môi trường bằng API, hãy đưa ra yêu cầu GET cho tài nguyên sau: https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{env}/resourcefiles

Ví dụ sau đây liệt kê tất cả tài nguyên trong môi trường test:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/environments/test/resourcefiles/{type}" \
  -u email:password

Sau đây là ví dụ về phản hồi.

{
  "resourceFile": [
{
  "name" : "pathSetter.js",
  "type" : "jsc"
}
  ]
}

Xem nội dung của tài nguyên bằng API

Xem nội dung của một tài nguyên bằng API, như mô tả trong các phần sau.

Khi sử dụng API, bạn có thể xem các tài nguyên thuộc phạm vi bản sửa đổi proxy API, môi trường hoặc tổ chức.

Ví dụ: để xem nội dung của tài nguyên trong một môi trường bằng API, hãy đưa ra yêu cầu GET đến tài nguyên sau: https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{env}/resourcefiles/{type}/name

Ví dụ sau đây liệt kê nội dung của tệp tài nguyên JavaScript pathSetter.js trong môi trường test:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js" \
  -H "Accept: application/json" \
  -u email:password

Sau đây là ví dụ về phản hồi:

request.headers["RequestPath"] = context.getVariable("proxy.basepath");

Cập nhật tài nguyên bằng API

Cập nhật các tài nguyên thuộc phạm vi của một bản sửa đổi proxy API, môi trường hoặc tổ chức (chỉ đối với Edge), như mô tả trong các phần sau.

Cập nhật các tài nguyên trong phạm vi bản sửa đổi proxy API bằng API

Cập nhật tài nguyên trong phạm vi bản sửa đổi proxy API thông qua API bằng cách tạo một yêu cầu PUT cho tài nguyên sau: https://api.enterprise.apigee.com/v1/organizations/{org}/apis/{api}/revisions/{rev}/resourcefiles/{type}/{name}

Truyền nội dung của tệp tài nguyên dưới dạng application/octet-stream hoặc multipart/form-data)

Ví dụ sau đây cập nhật tài nguyên JavaScript có tên pathSetter cho bản sửa đổi 1 của proxy API helloworld:

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

Ví dụ sau cho biết cách cập nhật tài nguyên dưới dạng tệp từ máy cục bộ. Bạn cần phải sử dụng -F để tải lên tệp nhị phân trong curl nhằm đảm bảo môi trường- hoặc tệp JavaScript ở phạm vi tổ chức mà chính sách JavaScript có thể truy cập.

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

Sau đây là ví dụ về phản hồi từ một trong hai lệnh gọi API.

{
  "name": "pathSetter.js",
  "type": "jsc"
}

Để biết thêm thông tin, hãy xem phần Nhập tệp tài nguyên để sửa đổi proxy API.

Ngoài ra, bạn có thể sử dụng API sửa đổi proxy API Cập nhật như sau:

  1. Tải gói cấu hình proxy API xuống bằng cách sử dụng Export API proxy API (Xuất API proxy) với các lựa chọn sau:
    • Đặt tham số truy vấn format thành bundle
    • Đặt tiêu đề Accept thành application/zip
  2. Cập nhật tệp tài nguyên trong gói cấu hình proxy API.
  3. Tải gói lên bằng cách sử dụng API sửa đổi proxy API cập nhật

Cập nhật tài nguyên trong phạm vi một môi trường bằng API

Cập nhật tài nguyên trong phạm vi một môi trường thông qua API bằng cách tạo một yêu cầu PUT cho tài nguyên sau: /organizations/{org}/environments/{env}/resourcefiles/{type}/{name}

Truyền nội dung của tệp tài nguyên dưới dạng application/octet-stream hoặc multipart/form-data.

Ví dụ sau cho biết cách cập nhật tài nguyên JavaScript bằng cách chuyển nội dung của tài nguyên đó vào nội dung yêu cầu.

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \
  -u email:password

Ví dụ sau đây cho thấy cách cập nhật tệp tài nguyên bằng một tệp trên máy cục bộ. Bạn cần sử dụng -F để tải tệp nhị phân lên trong curl để chính sách JavaScript có thể truy cập vào các tệp JavaScript trong phạm vi môi trường hoặc tổ chức.

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js \
  -u email:password

Sau đây là ví dụ về phản hồi:

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Cập nhật các tài nguyên trong phạm vi tổ chức bằng API

Để cập nhật một tài nguyên thuộc phạm vi của một tổ chức bằng API, hãy đưa ra yêu cầu POST cho tài nguyên sau: https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles/{type}/{name}

Truyền nội dung của tệp tài nguyên dưới dạng application/octet-stream hoặc multipart/form-data)

Để biết thêm thông tin, hãy xem phần Nhập tệp tài nguyên cho tổ chức,

Xoá tài nguyên bằng API

Xoá tài nguyên trong phạm vi một bản sửa đổi proxy API, môi trường hoặc tổ chức (chỉ đối với Edge), như mô tả trong các phần sau.

Xoá các tài nguyên thuộc phạm vi bản sửa đổi proxy API bằng cách sử dụng API

Để xoá tài nguyên thuộc phạm vi của bản sửa đổi proxy API bằng API, hãy đưa ra yêu cầu DELETE đến tài nguyên sau: https://api.enterprise.apigee.com/v1/organizations/{org}/apis/{api}/revisions/{rev}/resourcefiles/{type}/{name}

Ví dụ sau đây xoá tệp tài nguyên JavaScript pathSetter.js khỏi bản sửa đổi 1 của proxy API helloworld:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js" \
  -u email:password
  

Sau đây là ví dụ về phản hồi.

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Ngoài ra, bạn có thể sử dụng API sửa đổi proxy API Cập nhật như sau:

  1. Tải gói cấu hình proxy API xuống bằng cách sử dụng Export API proxy API (Xuất API proxy) với các lựa chọn sau:
    • Đặt tham số truy vấn format thành bundle
    • Đặt tiêu đề Accept thành application/zip
  2. Xoá tệp tài nguyên khỏi gói cấu hình proxy API.
  3. Tải gói lên bằng cách sử dụng API sửa đổi proxy API cập nhật

Xoá tài nguyên trong phạm vi một môi trường bằng cách sử dụng API

Xoá tài nguyên trong phạm vi một môi trường bằng cách sử dụng API, như mô tả trong các phần sau.

Để xoá tài nguyên trong phạm vi một môi trường bằng cách sử dụng API, hãy đưa ra yêu cầu DELETE đến tài nguyên sau: https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{env}/resourcefiles/{type}/{name}

Ví dụ sau đây sẽ xoá tệp tài nguyên JavaScript pathSetter.js khỏi môi trường test:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/environments/test/resourcefiles/jsc/pathSetter.js" \
  -u email:password

Sau đây là ví dụ về phản hồi.

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Xoá tài nguyên trong phạm vi tổ chức bằng API (chỉ đối với Edge)

Để xoá tài nguyên trong phạm vi một tổ chức bằng API, hãy tạo yêu cầu DELETE đến tài nguyên sau: https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles/{type}/{name}

Để biết thêm thông tin, hãy xem bài viết Xoá tệp tài nguyên khỏi một tổ chức.

Truy cập vào tài nguyên

Cách bạn truy cập vào tài nguyên phụ thuộc vào loại tài nguyên. Để biết thêm thông tin, hãy tham khảo tài liệu về chính sách có liên quan.

Các ví dụ trong phần này minh hoạ cách tạo và quản lý tài nguyên JavaScript có tên pathSetter.js để cho phép tài nguyên này được tham chiếu bằng chính sách của loại JavaScript.

Để đính kèm JavaScript vào Request PostFlow, hãy tạo một chính sách có tên là PathSetterPolicy.xml tham chiếu đến tệp pathSetter.js:

<Javascript name='PathSetterPolicy' timeLimit='200'>
    <ResourceURL>jsc://pathSetter.js</ResourceURL>
</Javascript>

Sau đó, hãy tham khảo chính sách trong cấu hình Điểm cuối:

<PostFlow>
  <Request>
    <Step><Name>PathSetterPolicy</Name></Step>
  </Request>
<PostFlow>

Để biết thêm thông tin, hãy xem Chính sách về JavaScript.