Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về
Apigee X. thông tin
Edge Microgateway phiên bản 3.1.5 trở lên
Tổng quan
Edge Microgateway CLI cho phép bạn kiểm soát và quản lý tất cả khía cạnh của một thực thể Edge Microgateway.
Quản lý chứng chỉ
Các lệnh cert
cho phép bạn cài đặt và quản lý cặp khoá công khai/riêng tư dùng để ký mã thông báo truy cập được ứng dụng sử dụng để thực hiện lệnh gọi bảo mật thông qua Edge Microgateway. Khoá được lưu trữ trên Apigee Edge trong một Sơ đồ giá trị khoá (KVM) đã mã hoá. Edge Microgateway sử dụng khoá công khai để xác thực mã thông báo truy cập đã ký. Các khoá này được tạo khi bạn chạy lệnh định cấu hình Edgemicro, như đã giải thích trong phần Thiết lập và định cấu hình Edge Microgateway. Bạn có thể dùng các lệnh cert được mô tả tại đây để tạo lại và quản lý các khoá này nếu cần.
Cài đặt chứng chỉ
Cài đặt các khoá trong Bản đồ giá trị khoá đã mã hoá (KVM) và trả về khoá công khai dưới dạng dữ liệu đầu ra. Các cặp khoá thuộc phạm vi của một tổ chức cụ thể.
Tác dụng
edgemicro cert install -o [organization] -e [environment] -u [username] -p [password] --force
Thông số
Các tham số | Nội dung mô tả |
---|---|
-o, --org |
Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway. |
-e, --env |
Môi trường mà bạn đã định cấu hình Edge Microgateway. |
-u, --username |
Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định. |
-p, --password |
(Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh. |
-f, --force |
(Không bắt buộc) Nếu khoá đã được lưu trữ trong KVM đã mã hoá, hãy buộc thay thế khoá đó. |
-h, --help |
Thông tin về mức sử dụng dữ liệu đầu ra. |
Ví dụ
edgemicro cert install -o docs -e test -u jdoe@example.com -f
Kết quả
current nodejs version is v12.5.0 current edgemicro version is 3.0.2 password: deleting vault creating vault adding private_key adding public_key installed cert
Xoá chứng chỉ
Xoá cặp khoá của một tổ chức.
Tác dụng
edgemicro cert delete -o [organization] -e [environment] -u [username] -p [password]
Thông số
Các tham số | Nội dung mô tả |
---|---|
-o, --org |
Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway. |
-e, --env |
Môi trường mà bạn đã định cấu hình Edge Microgateway. |
-u, --username |
Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định. |
-p, --password |
(Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh. |
-h, --help |
Thông tin về mức sử dụng dữ liệu đầu ra. |
Ví dụ
edgemicro cert delete -o docs -e test -u jdoe@example.com
Kết quả
deleting vault Vault deleted!
Kiểm tra chứng chỉ
Kiểm tra để đảm bảo rằng tổ chức của bạn đã cài đặt chứng chỉ.
Tác dụng
edgemicro cert check -o [organization] -e [environment] -u [username] -p [password]
Thông số
Các tham số | Nội dung mô tả |
---|---|
-o, --org |
Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway. |
-e, --env |
Môi trường mà bạn đã định cấu hình Edge Microgateway. |
-u, --username |
Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định. |
-p, --password |
(Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh. |
-h, --help |
Thông tin về mức sử dụng dữ liệu đầu ra. |
Ví dụ
edgemicro cert check -o docs -e test -u jdoe@example.com
Kết quả (Thành công)
checked cert successfully
Kết quả (Không thành công)
Nếu chứng chỉ không tồn tại, hệ thống sẽ trả về lỗi.
Nhận khoá công khai
Trả về khoá công khai của tổ chức đã chỉ định. Không yêu cầu xác thực.
Tác dụng
edgemicro cert public-key -o [organization] -e [environment]
Thông số
Các tham số | Nội dung mô tả |
---|---|
-o, --org |
Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway. |
-e, --env |
Môi trường mà bạn đã định cấu hình Edge Microgateway. |
-h, --help |
Thông tin về mức sử dụng dữ liệu đầu ra. |
Ví dụ
edgemicro cert public-key -o docs -e test
Kết quả (Mẫu)
-----BEGIN CERTIFICATE----- MIICpDCCAYwCCQCKpXWGum9uTjANBgkq9w0BAQsFADAUMRIwEAYDVQQDEwls b2NhbGhvc3cNMTYxMTAyMjAxNTA2WhcNMTYxMTAzMjAxNTA2WjAUMRIwEAYD VQQDEwlsb2Nvc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDD ETr/ne/gP47+9LgjLvBJjpbFVdaeUabZZ3wbA7sSIVnnNXWt3yPklrWSfIh+ L2+dq4k+YunsQE2+dwPdXA2x8DPGvqGcCdWPxnpZ7ix5Akbs8i/J+Ue0pXT4 jkpWbaDDftGL2tcxwP45yI+slpDYvmWRps07TFXkAPjGEHYPvCT9/v/35GkL 0h4v0S+XfpcjS5c47o7CIWlkgEM5GBosQUb17kuVR48392vGFPsnCP34iNe7 zguhiCXYg2zkOcj/N3AE4xKIhCz0QcewULy08GltWMmyjJ/30zs8P41JqoA4 RwfeEZ8RenN3rJQim1ppAAEwDQYJKoZIhvcNAQELBQADggEBAHcORIfc+ySe 2FMmqicNe6Wt5V/5zOaBMLsGQdqGOHB5cQc79sMBrk680KVhrwHXZ2nBIkVe UEL+2qLY1VLfswBNAvcNwV9U4TwHq4eIANiD751oJK1tHmM/ujThQkwNf96o 6I7Ws+wfpGO3ppJCttRbtnATIxrwsCHN4i5lbW/tJSL7t/Zf6T1B+YSJU9AF xuvLq22cCqyYJQdmKq2vVS55WRZdllm+mRtJrv7MLM9gfDPRxVlwrBz/eQHy Fv+dwzxcvQjkz03RNhZUodzuD34DPJoYeK++rItsddwQ26KTahH80yYTAFzY x9gfPf1/+qo=? -----END CERTIFICATE-----
Định cấu hình Edge Microgateway cho Apigee Edge Cloud
Cho phép Edge Microgateway hoạt động với thực thể Apigee Edge Cloud. Lớp này bao bọc và thực hiện một trình tự các lệnh để triển khai proxy xác thực cần thiết cho Edge, tạo mã xác thực và cập nhật tệp cấu hình. Để biết ví dụ đầy đủ về cách thức hoạt động, hãy xem phần Thiết lập và định cấu hình Edge Microgateway.
Tác dụng
edgemicro configure -o [organization] -e [environment] -u [username] -p [password]
Thông số
Các tham số | Nội dung mô tả |
---|---|
-o, --org |
Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway. |
-e, --env |
Môi trường mà bạn đã định cấu hình Edge Microgateway. |
-u, --username |
Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định. |
-p, --password |
(Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh. |
-r, --url |
(Không bắt buộc) Chỉ định tên đại diện của máy chủ ảo cho tổ chức:môi trường của bạn. Hãy xem tài liệu về Edge để tìm hiểu về máy chủ ảo. Mặc định:
org-env.apigee.net |
-c, --configDir |
(Không bắt buộc) Chỉ định đường dẫn đến tệp cấu hình Edge Microgateway. Theo mặc định, tệp cấu hình nằm ở ./config/config.yaml. (Đã thêm phiên bản 2.4.x) |
-x, --proxyName |
(Không bắt buộc) Đặt đường dẫn cơ sở cho proxy edgemicro-auth. Nếu proxy edgemicro-auth được triển khai theo một đường dẫn khác với đường dẫn mặc định, /edgemicro-auth, thì tính năng này sẽ cho phép bạn thiết lập đường dẫn mới trong Edge Microgateway. Theo mặc định, đường dẫn cơ sở là /edgemicro-auth. (Đã thêm phiên bản 2.4.x) |
-t, --token |
(Không bắt buộc) Cho phép bạn sử dụng mã thông báo OAuth để xác thực thay vì tên người dùng/mật khẩu.
Xem thêm bài viết Lệnh gọi API bảo mật bằng mã truy cập OAuth2.
Ví dụ:edgemicro configure -o docs -e test -t <your token> |
-v, --virtualHosts |
(Không bắt buộc) Ghi đè các máy chủ ảo mặc định là "default,secure ". Hãy sử dụng lựa chọn này nếu bạn đã chỉ định các máy chủ ảo cho tổ chức Edge:môi trường xung quanh ngoài các giá trị mặc định này. Hãy xem tài liệu về Edge để tìm hiểu về máy chủ ảo. |
-d, --debug |
(Không bắt buộc) Cung cấp thông tin gỡ lỗi. |
-h, --help |
Thông tin về mức sử dụng dữ liệu đầu ra. |
Ghi chú về cách sử dụng
Lệnh này lưu trữ thông tin cấu hình trong ~/.edgemicro/org-env-config.yaml
.
Ví dụ
edgemicro configure -o docs -e test -u jdoe@example.com
Kết quả
Sau khi thành công, lệnh này sẽ trả về một tập hợp các khoá mà bạn cần dùng khi khởi động Edge Microgateway.
... The following credentials are required to start edge micro key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372 edgemicro configuration complete!
Đang tạo khoá
Lệnh genkeys
tạo một cặp khoá và khoá bí mật mà Edge Microgateway sử dụng để tự xác thực khi đăng dữ liệu phân tích không đồng bộ lên Apigee Edge.
Tác dụng
edgemicro genkeys -o [organization] -e [environment] -u [username] -p [password]
Thông số
Các tham số | Nội dung mô tả |
---|---|
-o, --org |
Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway. |
-e, --env |
Môi trường mà bạn đã định cấu hình Edge Microgateway. |
-u, --username |
Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định. |
-p, --password |
(Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh. |
-t, --token |
(Không bắt buộc) Cho phép bạn sử dụng mã thông báo OAuth để xác thực thay vì tên người dùng/mật khẩu.
Xem thêm bài viết Lệnh gọi API bảo mật bằng mã truy cập OAuth2.
Ví dụ:edgemicro genkeys -o docs -e test -t <your token> |
-h, --help |
Thông tin về mức sử dụng dữ liệu đầu ra. |
Ghi chú về cách sử dụng
Sau khi thành công, lệnh này sẽ trả về 3 mục. Đầu tiên là một URL mà bạn cần đặt vào tệp cấu hình. Hai cặp khoá còn lại là một cặp khoá bắt buộc phải có khi bạn khởi động một thực thể của Edge Microgateway.
- URL khởi động: URL này trỏ đến một dịch vụ Apigee Edge. Dịch vụ này cho phép một thực thể Edge Microgateway gửi dữ liệu phân tích đến Apigee Edge. Bạn cần sao chép URL đó vào tệp cấu hình Edge Microgateway: ~
/.edgemicro/org-env-config.yaml
. - key: Khoá. Khoá này và khoá bí mật, được yêu cầu làm dữ liệu đầu vào cho lệnh CLI dùng để khởi động một thực thể của Edge Microgateway.
- bí mật: Bí mật.
Ví dụ
edgemicro genkeys -o docs -e test -u jdoe@example.com
Kết quả (Mẫu)
Sau khi thành công, lệnh này sẽ trả về một tập hợp các khoá mà bạn cần dùng khi khởi động Edge Microgateway.
configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1 Please copy the following property to the edge micro agent config bootstrap: https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/jdoe/environment/test The following credentials are required to start edge micro key: db39324077989c75eac34c13d285772ea8e3b982b957b3f52916f3048511443f secret: 5bf8da39de0056f88fdd5f25a8602d22f312c1c8c870580a5fef55ac6637b7ae finished
Định cấu hình Edge Microgateway cho Đám mây riêng tư Apigee Edge
Định cấu hình Edge Microgateway để hoạt động với bản cài đặt Đám mây riêng tư Apigee Edge.
Tác dụng
edgemicro private configure -o [organization] -e [environment] -u [username] -p [password]
Thông số
Các tham số | Nội dung mô tả |
---|---|
-o, --org |
Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway. |
-e, --env |
Môi trường mà bạn đã định cấu hình Edge Microgateway. |
-u, --username |
Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định. |
-p, --password |
(Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh. |
-r, --runtime-url |
Chỉ định URL thời gian chạy cho phiên bản đám mây riêng tư. |
-m, --mgmt-url |
URL của máy chủ quản lý cho phiên bản đám mây riêng tư của bạn. |
-v, --virtualHosts |
Danh sách máy chủ ảo được phân tách bằng dấu phẩy cho tổ chức của bạn:môi trường. Mặc định
"default,secure ". |
-c, --configDir |
(Không bắt buộc) Chỉ định đường dẫn đến tệp cấu hình Edge Microgateway. Theo mặc định, tệp cấu hình nằm ở ./config/config.yaml. (Đã thêm phiên bản 2.4.x) |
-t, --token |
(Không bắt buộc) Cho phép bạn sử dụng mã thông báo OAuth để xác thực thay vì tên người dùng/mật khẩu.
Xem thêm bài viết Lệnh gọi API bảo mật bằng mã truy cập OAuth2.
Ví dụ:edgemicro configure -o docs -e test -t <your token> |
-d, --debug |
(Không bắt buộc) Cung cấp thông tin gỡ lỗi. |
-h, --help |
Thông tin về mức sử dụng dữ liệu đầu ra. |
Ghi chú về cách sử dụng
Lệnh này lưu trữ thông tin cấu hình trong ~/.edgemicro/org-env-config.yaml
.
Ví dụ
edgemicro private configure -o docs -e test -u jdoe@example.com -r http://192.162.55.100:9002 -m http://192.162.55.100:8080
Kết quả
Sau khi thành công, lệnh này sẽ trả về một tập hợp các khoá mà bạn cần dùng khi khởi động Edge Microgateway.
... The following credentials are required to start edge micro key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372 edgemicro configuration complete!
Đang khởi động Edge Microgateway
Trước khi bắt đầu chạy Edge Microgateway, trước tiên bạn phải chạy edgemic cấu hình (Public Cloud) hoặc edgemicro cấu hình riêng tư (Đám mây riêng tư). Lệnh cấu hình sẽ trả về các khoá và giá trị bí mật cần thiết để khởi động Edge Microgateway.
Tác dụng
edgemicro start -o [organization] -e [environment] -k [public-key] -s [secret-key]
Thông số
Các tham số | Nội dung mô tả |
---|---|
-o, --org |
Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway. |
-e, --env |
Môi trường mà bạn đã định cấu hình Edge Microgateway. |
-k, --key |
Giá trị khoá được trả về sẽ được trả về khi bạn chạy lệnh "edgemicro
configure ". |
-s, --secret |
Giá trị bí mật trả về sẽ được trả về khi bạn chạy lệnh "edgemicro
configure ". |
-p, --processes |
(Không bắt buộc) Số lượng quy trình bắt đầu. Mặc định: Số lượng lõi trên hệ thống của bạn. |
-d, --pluginDir |
(Không bắt buộc) Đường dẫn tuyệt đối đến thư mục trình bổ trợ. |
-r, --port |
(Không bắt buộc) Ghi đè số cổng được chỉ định trong tệp ~/.edgemicro/org-env-config.yaml . Mặc định: 8000 |
-c, --cluster |
(Không bắt buộc) Khởi động Edge Microgateway ở chế độ cụm. Lưu ý: Kể từ phiên bản 2.3.1, tuỳ chọn này đã bị xoá. Trong phiên bản 2.3.1 trở lên, Edge Micro luôn khởi động ở chế độ cụm. |
-c, --configDir |
(Không bắt buộc) Chỉ định đường dẫn đến tệp cấu hình Edge Microgateway. Theo mặc định, tệp cấu hình nằm ở ./config/config.yaml. (Đã thêm phiên bản 2.4.x) |
-u, --configUrl |
(Không bắt buộc) Chỉ định một điểm cuối mà từ đó Edge Microgateway sẽ tải tệp cấu hình xuống. (Đã thêm phiên bản 2.5.x) |
-d, --debug |
(Không bắt buộc) Cung cấp thông tin gỡ lỗi. |
-h, --help |
Thông tin về mức sử dụng dữ liệu đầu ra. |
Đặt cổng
Lệnh start
cho phép bạn chỉ định số cổng để ghi đè cổng được chỉ định trong tệp cấu hình. Bạn cũng có thể chỉ định số cổng bằng cách sử dụng
biến môi trường PORT
. Ví dụ:
edgemicro start -o docs -e test -k abc123 -s xyz456 -p 2 --port 8002
hoặc
export PORT=8002 edgemicro start -o org -e test -k key -s secret -p 2
Nếu cổng đang được sử dụng, Edge Microgateway sẽ trả về lỗi.
Giới thiệu về tính năng phân nhóm
Edge Microgateway sử dụng mô-đun cụm Node.js để cho phép phân cụm. Việc phân cụm cho phép Edge Microgateway tận dụng được các hệ thống đa lõi. Để biết thông tin chi tiết, hãy xem tài liệu về Node.js.
Ví dụ
edgemicro start -o docs -e test -k abc123 -s xyz456
Kết quả mẫu:
... current nodejs version is v12.5.0 current edgemicro version is 3.0.2 info: jwk_public_keys download from null returned 200 undefined info: jwt_public_key download from https://docs-test.apigee.net/edgemicro-auth/publicKey returned 200 OK info: products download from https://docs-test.apigee.net/edgemicro-auth/products returned 200 OK info: config download from https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test returned 200 OK PROCESS PID : 17991
Quản lý mã thông báo
Các lệnh token
cho phép bạn lấy, giải mã và xác minh mã truy cập OAuth2 đã ký. Xem thêm bài viết
Lệnh gọi API bảo mật bằng mã truy cập OAuth2.
Giải mã mã thông báo
Giải mã mã thông báo truy cập đã ký và được mã hoá thành mã đại diện JSON JWT (Java Web Token) dạng văn bản thuần tuý. Mã thông báo truyền tải thông tin về ứng dụng dành cho nhà phát triển Apigee Edge. Ứng dụng này đã cung cấp các khoá dùng để tạo mã thông báo, bao gồm cả tên ứng dụng, client_id, danh sách sản phẩm, v.v.
Tác dụng
edgemicro token decode -f [filename]
Thông số
Các tham số | Nội dung mô tả |
---|---|
-f, --file |
Tên của tệp chứa mã thông báo JWT cần giải mã. |
-h, --help |
Thông tin về mức sử dụng dữ liệu đầu ra. |
Ví dụ
edgemicro token decode -f token.jwt
Kết quả (Mẫu)
{ header: { typ: 'JWT', alg: 'RS256' }, payload: { application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217', client_id: 'O9ZQRZKnn1rdgcKQgsABSMdOsKS', scopes: [], api_product_list: [ 'MicroTest' ], iat: 1436280566, exp: 1436282365 }, signature: '' }
Tạo mã thông báo
Tạo mã thông báo người truy cập đã ký. Mã thông báo này cho phép ứng dụng khách thực hiện các lệnh gọi API đã xác thực đến Edge Microgateway. Mã thông báo này là Mã thông báo web JSON (JWT) tuân thủ OAuth 2.0. Bạn phải nhập các giá trị Khoá người dùng (mã ứng dụng khách) và Mật khẩu người tiêu dùng (mật khẩu ứng dụng) từ một ứng dụng dành cho nhà phát triển đã đăng ký trên Apigee Edge. Xem thêm bài viết Lệnh gọi API bảo mật bằng mã truy cập OAuth2.
Tác dụng
edgemicro token get -o [org] -e [env] -i [client_id] -s [client_secret]
Thông số
Các tham số | Nội dung mô tả |
---|---|
-o, --org |
Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway. |
-e, --env |
Môi trường mà bạn đã định cấu hình Edge Microgateway. |
-1, --key |
Client-ID từ Ứng dụng của nhà phát triển được liên kết với proxy nhận biết Microgateway của bạn. |
-s, --secret |
Mật khẩu ứng dụng khách trong ứng dụng của Nhà phát triển được liên kết với proxy nhận biết Microgateway của bạn. |
-h, --help |
Thông tin về mức sử dụng dữ liệu đầu ra. |
Ví dụ
edgemicro token get -o docs -e test -i 5UzOwAXGoOeo60aew94PPG5MAZE3aJp -s 6vahKFGS9a3qMLwz
Kết quả (Mẫu)
{ token: 'eyJ0eXAiOiJKV1JhbGciOiJSUzI1NiJ9Glvbl9uYW1lIjoiNWNiMGY0NTV6TV3 EtOWMzOC00YmJjLWIzNzEtZGMxZTQzOGMxIiwiY2xpZW50X2lkIjoiNVV6T3dBWEdvSU9lbz YwYWV3OTRQN0c1TUFaRTNhSnAiLCJzY2MiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIkVkZ2 VNaWNyb1Rlc3RQcm9kdWN0Il0sImlhdCI3ODEyMzQ2MSwiZXhwIjoxNDc4MTI1MjYwfQ.Dx5 f5U7PXm8koNGmFX4N6VrxKMJnpndKgoJ5zWSJvBZ6Ccvhlpd85ipIIA5S2A5nx4obYWp_rpY RJpIGYwyxP6Oq2j0rxnVjdCC4qyYMgthZjhKgEBVBe3s1ndP72GP2vV6PsSA9RQ2-yzsy9r0 TzhAZ3NJTxT1tS0XKqKngE-OhR3fJHVLAzdMDT0AmS9H0Z2NAJtQOuK6RTpCjG9B6Bc48AEM sj7QSM-1LWiQ8LdY8k_BoC06qsTI7bCQGWwTuqL-ismbcx2bxovUxSemZIaoROfuF-dCZHG3 2aTP75WxBvvNgBBvPvQtPzbeSOtEaww' }
Bạn cũng có thể tạo JWT bằng API quản lý:
curl -i -X POST "http://$ORG-$ENV.apigee.net/edgemicro-auth/token" \ -H "Content-Type: application/json" \ -d '{ "$CLIENT_ID": "your consumer key", "$CLIENT_SECRET": "your consumer secret", "grant_type": "client_credentials" }'
Trong trường hợp:
- $ORG là tên tổ chức của bạn trong Edge (bạn phải là quản trị viên tổ chức).
- $ENV là một môi trường trong tổ chức của bạn (chẳng hạn như "test" hoặc "prod").
- $CLIENT_ID là Mã nhận dạng người tiêu dùng trong Ứng dụng dành cho nhà phát triển mà bạn đã tạo trước đây.
- $CLIENT_SECRET là Thông tin mật của người dùng trong Ứng dụng dành cho nhà phát triển mà bạn đã tạo trước đây.
Xác minh mã thông báo
Xác minh mã thông báo truy cập đã ký dựa trên khoá công khai được lưu trữ trên Apigee Edge cho tổ chức và môi trường đã chỉ định.
Tác dụng
edgemicro token verify -o [org] -e [env] -f [filename]
Thông số
Các tham số | Nội dung mô tả |
---|---|
-o, --org |
Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway. |
-e, --env |
Môi trường mà bạn đã định cấu hình Edge Microgateway. |
-f, --file |
Tên của tệp có chứa JWT cần xác minh. |
-h, --help |
Thông tin về mức sử dụng dữ liệu đầu ra. |
Ví dụ
edgemicro token get -o docs -e test -f token.jwt
Kết quả mẫu cho mã thông báo hợp lệ
{ application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217', client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS', scopes: [], api_product_list: [ 'MicroTest' ], iat: 1436396155, exp: 1436397954 }
Dữ liệu đầu ra mẫu cho mã thông báo không hợp lệ
{ [JsonWebTokenError: invalid token] name: 'JsonWebTokenError', message: 'invalid token' }
Kết quả mẫu cho mã thông báo đã hết hạn
{ [TokenExpiredError: jwt expired] name: 'TokenExpiredError', message: 'jwt expired', expiredAt: Tue Jul 07 2015 09:19:25 GMT-0600 (MDT) }
Khởi chạy cấu hình Edge Microgateway mới
Chạy lệnh này một lần sau khi bạn cài đặt Edge Microgateway lần đầu tiên. Tạo một tệp cấu hình mặc định mới: ~/.edgemicro/default.yaml
.
Tác dụng
edgemicro init
Thông số
Các tham số | Nội dung mô tả |
---|---|
-c, --configDir |
(Không bắt buộc) Chỉ định đường dẫn đến tệp cấu hình Edge Microgateway. Theo mặc định, tệp cấu hình nằm ở ./config/config.yaml. (Đã thêm phiên bản 2.4.x) |
-h, --help |
Thông tin về mức sử dụng dữ liệu đầu ra. |
Ví dụ
edgemicro init
Kết quả (Thành công)
config initialized to /MyHome/.edgemicro/default.yaml
Xác minh cấu hình Edge Microgateway
Xác minh rằng Edge Microgateway được định cấu hình đúng cách.
Tác dụng
edgemicro verify -o [organization] -e [environment] -k [public-key] -s [secret-key]
Thông số
Ví dụ
edgemicro verify -o docs -e test -k abc123 -s xyz456
Kết quả (Thành công)
logging to /var/tmp/edgemicro-My-Machine.local-a0c48610-a148-11e6-8466-93f081b05988 installed plugin from analytics installed plugin from oauth a0c48610-a148-11e6-8466-93f081b05988 edge micro listening on port 8000 verifying analytics negative case: OK verifying bootstrap url availability:OK verifying jwt_public_key availability: OK verifying products availability: OK verifying quota with configured products: OK verifying analytics with payload: OK verification complete
Kiểm tra trạng thái cụm cổng nhỏ
Theo mặc định, Edge Microgateway sẽ khởi động ở chế độ cụm. Bạn có thể sử dụng lệnh này để kiểm tra trạng thái của cụm.
Tác dụng
edgemicro status
Thông số
Các tham số | Nội dung mô tả |
---|---|
-h, --help |
Thông tin về mức sử dụng dữ liệu đầu ra. |
Ví dụ
edgemicro status
Kết quả (Thành công)
current nodejs version is v12.5.0 current edgemicro version is 3.0.2 edgemicro is running with 8 workers
Dừng cụm cổng vi mô
Dừng cụm Edge Microgateway.
Tác dụng
edgemicro stop
Thông số
Các tham số | Nội dung mô tả |
---|---|
-h, --help |
Thông tin về mức sử dụng dữ liệu đầu ra. |
Ví dụ
edgemicro stop
Kết quả (Thành công)
current nodejs version is v12.5.0 current edgemicro version is 3.0.2 Stop Completed Successfully
Tải lại cụm cổng vi mô
Cung cấp khả năng khởi động lại thời gian ngừng hoạt động sau khi thay đổi cấu hình. Tải lại Edge Microgateway bằng cách kéo một cấu hình mới.
Tác dụng
edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]
Thông số
Các tham số | Nội dung mô tả |
---|---|
-o, --org |
Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway. |
-e, --env |
Môi trường mà bạn đã định cấu hình Edge Microgateway. |
-k, --key |
Giá trị khoá được trả về sẽ được trả về khi bạn chạy lệnh "edgemicro
configure ". |
-s, --secret |
Giá trị bí mật trả về sẽ được trả về khi bạn chạy lệnh "edgemicro
configure ". |
-h, --help |
Thông tin về mức sử dụng dữ liệu đầu ra. |
Ví dụ
edgemicro reload -o docs -e test -k abc123 -s xyz456
Kết quả (Thành công)
... Reload Completed Successfully
Nâng cấp proxy xác thực Edgemicro
Để sử dụng tính năng xoay vòng khoá, bạn phải triển khai một proxy xác thực Edgemicro đã nâng cấp trong tổ chức Apigee Edge. (Đã thêm phiên bản 2.5.x)
Lưu ý: Nếu đã định cấu hình phiên bản Edge Micro hiện tại trước phiên bản 2.5.2, bạn phải nâng cấp proxy này nếu muốn sử dụng tính năng xoay khoá. Bạn chỉ cần nâng cấp một lần.
Tác dụng
edgemicro upgradeauth -o [organization] -e [environment] -u [username]
Thông số
Các tham số | Nội dung mô tả |
---|---|
-o, --org |
Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway. |
-e, --env |
Môi trường mà bạn đã định cấu hình Edge Microgateway. |
-u, --username |
Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định. |
-p, --password |
(Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh. |
-v, --virtualhost |
(Không bắt buộc) Máy chủ ảo của proxy. |
-b, --baseuri |
(Không bắt buộc) URI cơ sở cho tổ chức của bạn trên Apigee Edge. Giá trị mặc định là URI cơ sở để triển khai đám mây Apigee là api.enterprise.apigee.com. Đối với các hoạt động triển khai tại cơ sở, URL cơ sở có thể khác. |
Ví dụ
edgemicro upgradeauth -o docs -e test -u jdoe@example.com
Kết quả (Thành công)
Sau khi thành công, lệnh sẽ trả về kết quả tương tự như sau:
Going to create revision 2 of API edgemicro-auth Using /Users/jdoe/npm/lib/node_modules/edgemicro/node_modules/microgateway-edgeauth/apiproxy/edgemicro-auth.xml as the root file Creating revision 2 of API edgemicro-auth Uploading java resource micro-gateway-products-javacallout-2.0.0.jar Uploading jsc resource generate-verify-jwt.js Uploading jsc resource send-public-key.js Uploading jsc resource set-jwt-variables.js Uploading jsc resource set-response.js Uploading node resource index.js Uploading node resource node_modules_apigee-access.zip Uploading node resource node_modules_base64url.zip Uploading node resource node_modules_buffer-equal-constant-time.zip Uploading node resource node_modules_ecdsa-sig-formatter.zip Uploading node resource node_modules_jsrsasign.zip Uploading node resource node_modules_jwa.zip Uploading node resource node_modules_jws.zip Uploading node resource node_modules_safe-buffer.zip Uploading node resource package.json Uploading policy Access-App-Info-2.xml Uploading policy Access-App-Info.xml Uploading policy AccessTokenRequest.xml Uploading policy Add-Custom-Claims.xml Uploading policy Create-OAuth-Request.xml Uploading policy Create-Refresh-Request.xml Uploading policy Extract-API-Key.xml Uploading policy Extract-OAuth-Params.xml Uploading policy Extract-Refresh-Params.xml Uploading policy Get-Private-Key.xml Uploading policy Get-Public-Key.xml Uploading policy Get-Public-Keys.xml Uploading policy JavaCallout.xml Uploading policy Products-to-JSON-2.xml Uploading policy Products-to-JSON.xml Uploading policy Raise-Fault-Unknown-Request.xml Uploading policy RefreshAccessToken.xml Uploading policy Send-Public-Key.xml Uploading policy Set-JWT-Variables.xml Uploading policy Set-Response.xml Uploading policy Verify-API-Key.xml Uploading target TargetEndpoint-1 Uploading proxy default Deploying revision 2 of edgemicro-auth to test Deployment on test successful edgemicro-auth proxy upgraded
Nâng cấp Bản đồ giá trị khoá (KVM)
Hãy dùng lệnh edgemicro upgradekvm
để nâng cấp KVM trong tổ chức Apigee của bạn. Bạn cần nâng cấp KVM nếu muốn sử dụng tính năng xoay vòng khoá.
Tác dụng
Edge cho Đám mây công cộng:
edgemicro upgradekvm -o [organization] -e [environment] -k [key] -s [secret]
Edge dành cho đám mây riêng tư:
edgemicro private upgradekvm -o [organization] -e [environment] -k [key] -s [secret] -p 'https://[hostname]/edgemicro-auth'
Thông số
Các tham số | Nội dung mô tả |
---|---|
-o, --org |
Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway. |
-e, --env |
Môi trường mà bạn đã định cấu hình Edge Microgateway. |
-k, --key |
Giá trị khoá được trả về sẽ được trả về khi bạn chạy lệnh "edgemicro
configure ". |
-s, --secret |
Giá trị bí mật trả về sẽ được trả về khi bạn chạy lệnh "edgemicro
configure ". |
-p, --proxyuri |
URI cho proxyedgemicro_auth Đám mây công khai Edge: Không bắt buộc. Đám mây riêng tư ở Edge: Bắt buộc. Ví dụ về Edge Public Cloud: -p 'https://[org]-[env].apigee.net/edgemicro-auth' Ví dụ về Đám mây riêng tư Edge: -p 'https://[hostname]/edgemicro-auth' |
Ví dụ
edgemicro upgradekvm -o docs -e test \ -k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \ -s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47
Kết quả (Thành công)
Sau khi thành công, lệnh sẽ trả về kết quả tương tự như sau:
current nodejs version is v12.5.0 current edgemicro version is 3.1.5 password: Checking for certificate... Certificate found! -----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT6yVoT/h6pvkPlkUUtv Hgs7MbDPcWxto7dZqJBwQ4oOQ0IJ2P4XGigc3kYUyPp5lFHg1ssP9+0onRpqn6Lq z7N5iaTSv5YXb26bU2kSOl4hbwcljIzauAnBzQ13VaQ5SoflRxMGSZmTqZeu5jkQ 3JZ7F6k2bCar5sk1k84vd4WXcCVyngFlrMtlux5z0vOU56QYZFvvKYl/wOHNPLLB Js54531CV1ZfhV3nDDq9Lh5D1C/oQVlm1Lc7BJoEUmKeFATmSsi50c14ScsmdtJ1 HqC/brSXCd185P6ifu2RH7IHKzNfcD4NlfAVmDScng4w5RxBan2avbmAJrokQ4b5 WQIDAQAB -----END PUBLIC KEY----- KVM update complete
Chế độ xoay khoá
Dùng lệnh edgemicro rotatekey
để xoay vòng các cặp khoá công khai/riêng tư
dùng để tạo mã thông báo JWT dùng cho hoạt động bảo mật OAuth trên Edge Microgateway.
Để tìm hiểu thêm, hãy xem nội dung Xoay khoá JWT.
Tác dụng
Edge cho Đám mây công cộng:
edgemicro rotatekey -o [organization] -e [environment] -k [key] -s [secret]
Edge dành cho đám mây riêng tư:
edgemicro private rotatekey -o [organization] -e [environment] -k [key] -s [secret] -r '[hostname]/edgemicro-auth/rotateKey'
Thông số
Các tham số | Nội dung mô tả |
---|---|
-o, --org |
(Bắt buộc) Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway. |
-e, --env |
(Bắt buộc) Một môi trường mà bạn đã định cấu hình Edge Microgateway. |
-k, --key |
Giá trị khoá được trả về sẽ được trả về khi bạn chạy lệnh "edgemicro
configure ". |
-s, --secret |
Giá trị bí mật trả về sẽ được trả về khi bạn chạy lệnh "edgemicro
configure ". |
-p |
Đường dẫn đến một khoá riêng tư tuỳ chỉnh mà Apigee Edge dùng để sử dụng. (Đã thêm vào 3.1.6) |
-c |
Đường dẫn đến một chứng chỉ tuỳ chỉnh mà Apigee Edge dùng để sử dụng. (Đã thêm vào 3.1.6) |
-n, --nbf |
Thiết lập độ trễ tính bằng phút để khoá riêng tư mới có hiệu lực. Độ trễ này tạo ra thời gian để làm mới các thực thể cổng vào bằng khoá công khai mới. Bạn nên đặt độ trễ lớn hơn chế độ cài đặt cấu hình
Lưu ý: Nếu bạn sử dụng tuỳ chọn này với các phiên bản |
-i, --kid |
(Không bắt buộc) Mã nhận dạng dùng để so khớp với một khoá cụ thể. Edge Microgateway sử dụng giá trị này để chọn trong số một tập hợp các khoá trong quá trình xoay khoá. Nếu bạn bỏ qua tham số này (nên dùng), Edge Microgateway sẽ tạo khoá dựa trên dấu thời gian. Để biết thêm thông tin, hãy xem Mục 4.5 trong thông số kỹ thuật về Khoá web JSON. |
-r, --rotatekeyuri |
Xoay URI chính. Edge Public Cloud: Không bắt buộc. Đám mây riêng tư ở Edge: Bắt buộc. Ví dụ về Cloud Public: -r 'https://[org]-[env].apigee.net/edgemicro-auth/rotateKey' Ví dụ về Đám mây riêng tư Edge: -r '[hostname]/edgemicro-auth/rotateKey' |
Ví dụ
edgemicro rotatekey -o docs -e test \ -k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \ -s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47
Kết quả (Thành công)
Sau khi thành công, lệnh sẽ trả về kết quả tương tự như sau:
current nodejs version is v12.5.0 current edgemicro version is 3.0.2 password: Checking if private key exists in the KVM... Checking for certificate... Found Certificate Generating New key/cert pair... Extract new public key Key Rotation successfully completed!
Sau khi xoay, bạn có thể thấy trong giao diện người dùng Edge các khoá mới đã được thêm vào KVM cổng vi mô.
Ví dụ:
Ví dụ này sử dụng cờ -p
và -c
để chỉ định đường dẫn đến cặp chứng chỉ/khoá riêng tư. Các tuỳ chọn này cho phép bạn chuyển cặp chứng chỉ và khoá riêng tư tuỳ chỉnh.
edgemicro rotatekey -o docs -e test \ -k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \ -s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47 \ -p /users/home/keys.pem -c /users/home/cert.cert
Giám sát vĩnh viễn
Sử dụng lệnh edgemicro forever
để quản lý quy trình Forever (Mãi mãi), một công cụ Node.js sẽ tự động khởi động lại ứng dụng Node.js trong trường hợp ứng dụng ngừng hoạt động hoặc gặp lỗi.
Xem thêm phần
Theo dõi vĩnh viễn.
Tác dụng
Bạn phải thiết lập các biến môi trường sau trước khi thực thi lệnh edgemicro forever
:
EDGEMICRO_ORG
– Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.EDGEMICRO_ENV
– Môi trường mà bạn đã định cấu hình Edge Microgateway.EDGEMICRO_KEY
– Giá trị khoá được trả về khi bạn chạy lệnh "edgemicro Configure".EDGEMICRO_SECRET
– Giá trị bí mật được trả về khi bạn chạy lệnh "edgemicro Configure".
edgemicro forever -f [forever_file] -a [start|stop]
Thông số
Thông số | Nội dung mô tả |
---|---|
-f, --file | Chỉ định vị trí của tệp forever.json . |
-a, --action | start hoặc stop . Tuỳ chọn mặc định là bắt đầu. |
Ví dụ:
Cách bắt đầu vĩnh viễn:
edgemicro forever -f ~/mydir/forever.json -a start
Cách dừng vĩnh viễn:
edgemicro forever -a stop
Thu hồi khóa
Sử dụng lệnh edgemicro revokekeys
để thu hồi thông tin xác thực khoá và thông tin bí mật của
cấu hình Edge Microgateway.
Tác dụng
edgemicro revokekeys -o [organization] -e [environment] -u [username] -k [key] -s [secret]
Thông số
Các tham số | Nội dung mô tả |
---|---|
-o, --org |
(Bắt buộc) Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway. |
-e, --env |
(Bắt buộc) Một môi trường mà bạn đã định cấu hình Edge Microgateway. |
-u, --username |
(Bắt buộc) Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức của tổ chức được chỉ định. |
-p, --password |
(Không bắt buộc) Mật khẩu của bạn. Bạn sẽ được nhắc nếu không cung cấp tham số này trên dòng lệnh. |
-k, --key |
(Bắt buộc) Khoá để thu hồi. |
-s, --secret |
(Bắt buộc) Khoá bí mật để thu hồi. |
Ví dụ
edgemicro revokekeys -o myorg -e test -u jdoe@apigee.com -k 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f -s 4b5d6355b874f7c46838893823e8d929dcb2e42fb9aebcb535089c9b98513
Sau khi thành công, bạn sẽ thấy thông báo sau:
key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully