Tham chiếu CLI cho Edge Microgateway

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.3.x

Tổng quan

Edge Microgateway CLI cho phép bạn kiểm soát và quản lý mọi khía cạnh của Edge Microgateway thực thể.

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ư được dùng để ký mã thông báo truy cập mà khách hàng dùng để thực hiện cuộc gọi an toàn qua Edge Cổng nhỏ. Các khoá được lưu trữ trên Apigee Edge trong một Bản đồ giá trị khoá (KVM) đã mã hoá. Edge Microgateway sử dụng khoá công khai để xác thực mã thông báo người dùng đã ký. Các khoá này được tạo khi bạn chạy Edgemicro cấu hình, như được giải thích trong Thiết lập và định cấu hình Edge Microgateway. Bạn có thể dùng các lệnh cert như mô tả ở đâ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 một Bản đồ giá trị khoá (KVM) đã mã hoá và trả về đầu ra là khoá công khai. Các cặp khoá thuộc phạm vi một tổ chức được chỉ định.

Tác dụng

edgemicro cert install -o [organization] -e [environment] -u [username] -p [password] --force

Tham số

Tham số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username Tên người dùng của bạn trên Apigee. Bạn phải là quản trị viên tổ chức cho thuộc tính tổ chức.
-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 thông số này vào dòng lệnh.
-f, --force (Không bắt buộc) Nếu một 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 đầ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]

Tham số

Tham số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username Tên người dùng của bạn trên Apigee. Bạn phải là quản trị viên tổ chức cho thuộc tính tổ chức.
-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 thông số này vào dòng lệnh.
-h, --help Thông tin về mức sử dụng đầ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 một chứng chỉ.

Tác dụng

edgemicro cert check -o [organization] -e [environment] -u [username] -p [password]

Tham số

Tham số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username Tên người dùng của bạn trên Apigee. Bạn phải là quản trị viên tổ chức cho thuộc tính tổ chức.
-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 thông số này vào dòng lệnh.
-h, --help Thông tin về mức sử dụng đầ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 thì hệ thống sẽ trả về lỗi.

Lấy khoá công khai

Trả về khoá công khai cho tổ chức đượ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]

Tham số

Tham số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một 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 đầu ra.

Ví dụ

edgemicro cert public-key -o docs -e test

Đầu ra (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 một phiên bản Apigee Edge Cloud. Chiến dịch kết thúc và hoạt động hiệu quả một trình tự các lệnh để triển khai proxy xác thực bắt buộc cho Edge, tạo phương thức xác thực mã thông báo và cập nhật tệp cấu hình. Để biết ví dụ đầy đủ về cách hoạt động, hãy xem bài viết 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]

Tham số

Tham số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username Tên người dùng của bạn trên Apigee. Bạn phải là quản trị viên tổ chức cho thuộc tính tổ chức.
-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 thông số này vào dòng lệnh.
-r, --url (Không bắt buộc) Chỉ định bí danh máy chủ ảo cho tổ chức của bạn:environment. Xem Tài liệu 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 trong ./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 edgemicro-auth được triển khai theo một đường dẫn khác với mặc định, /edgemicro-auth, tính năng này cho phép bạn thiết lập đường dẫn mới trong Edge Cổng nhỏ. Theo mặc định, đường dẫn cơ sở là /edgemicro-auth. (Đã thêm v2.4.x)
-t, --token (Không bắt buộc) Cho phép bạn dùng mã thông báo OAuth để xác thực thay vì tên người dùng/mật khẩu. Hãy xem thêm bài viết Các 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 "default,secure". Sử dụng tuỳ chọn này nếu bạn đã chỉ định máy chủ ảo cho Tổ chức biên:môi trường không phải là các giá trị mặc định này. Xem tài liệu 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 đầu ra.

Ghi chú sử dụng

Lệnh này lưu trữ thông tin cấu hình trong khoảng /.edgemicro/org-env-config.yaml.

Ví dụ

edgemicro configure -o docs -e test -u jdoe@example.com

Kết quả

Khi thành công, lệnh này sẽ trả về một tập hợp các phím bạn cần dùng khi khởi động Edge Cổng nhỏ.

...

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 không đồng bộ dữ liệu phân tích lên Apigee Edge.

Tác dụng

edgemicro genkeys -o [organization] -e [environment] -u [username] -p [password]

Tham số

Tham số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username Tên người dùng của bạn trên Apigee. Bạn phải là quản trị viên tổ chức cho thuộc tính tổ chức.
-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 thông số này vào dòng lệnh.
-t, --token (Không bắt buộc) Cho phép bạn dùng mã thông báo OAuth để xác thực thay vì tên người dùng/mật khẩu. Hãy xem thêm bài viết Các 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 đầu ra.

Ghi chú sử dụng

Khi thành công, lệnh này trả về 3 mục. Đầu tiên là một URL bạn cần đặt vào tệp cấu hình. Hai khoá còn lại là cặp khoá bắt buộc khi bạn khởi động Edge Phiên bản Microgateway.

  • URL khởi động: URL này trỏ đến dịch vụ Apigee Edge cho phép Phiên bản Edge Microgateway để gửi dữ liệu phân tích cho 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à mã bí mật là dữ liệu đầu vào cho CLI dùng để khởi động một phiên bản của Edge Microgateway.
  • secret: Bí mật.

Ví dụ

edgemicro genkeys -o docs -e test -u jdoe@example.com

Đầu ra (Mẫu)

Khi thành công, lệnh này sẽ trả về một tập hợp các phím bạn cần dùng khi khởi động Edge Cổng nhỏ.

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 dịch vụ đám mây riêng tư Apigee Edge

Thiết lập để Edge Microgateway hoạt động với quy trình cài đặt dịch vụ đám mây riêng tư của Apigee Edge.

Tác dụng

edgemicro private configure -o [organization] -e [environment] -u [username] -p [password]

Tham số

Tham số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username Tên người dùng của bạn trên Apigee. Bạn phải là quản trị viên tổ chức cho thuộc tính tổ chức.
-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 thông số này vào 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ư của bạn.
-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:environment. 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 trong ./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 dùng mã thông báo OAuth để xác thực thay vì tên người dùng/mật khẩu. Hãy xem thêm bài viết Các 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 đầu ra.

Ghi chú sử dụng

Lệnh này lưu trữ thông tin cấu hình trong khoảng /.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ả

Khi thành công, lệnh này sẽ trả về một tập hợp các phím bạn cần dùng khi khởi động Edge Cổng nhỏ.

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

Khởi động Edge Microgateway

Trước khi khởi động Edge Microgateway, trước tiên, bạn phải chạy định cấu hình Edgemicro (Đám mây công khai) hoặc định cấu hình riêng tư của Edgemicro (Đám mây riêng tư). Cấu hình sẽ trả về các giá trị khoá và khoá 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]

Tham số

Tham số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-k, --key Giá trị khoá được trả về và được trả về khi bạn chạy "edgemicro configure" .
-s, --secret Giá trị bí mật được trả về khi bạn chạy "edgemicro configure" .
-p, --processes (Không bắt buộc) Số quy trình cần bắt đầu. Mặc định: Số lượng lõi trên hệ thống.
-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 ~/.edgemicro/org-env-config.yaml tệp. 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 đồng hồ.
-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 trong ./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 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 đầ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 PORT biến môi trường. 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 cụm

Edge Microgateway sử dụng Node.js mô-đun cụm để bật tính năng phân cụm. Việc phân cụm cho phép Edge Microgateway của 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 thu thập, giải mã và xác minh quyền truy cập vào OAuth2 đã ký mã thông báo. Xem thêm Các 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ột mã thông báo mang tải đã ký, được mã hoá thành JSON JWT văn bản thuần tuý (Mã thông báo web Java) đại diện. Mã thông báo truyền tải thông tin về ứng dụng của nhà phát triển Apigee Edge đã cung cấp các khoá dùng để tạo mã thông báo, bao gồm 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]

Tham số

Tham số Mô tả
-f, --file Tên của tệp chứa mã thông báo JWT để giải mã.
-h, --help Thông tin về mức sử dụng đầ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 mang tải đã ký. Mã thông báo này cho phép ứng dụng khách thực hiện lệnh gọi API đã xác thực đến Edge Microgateway. Mã thông báo là Mã thông báo web JSON tuân thủ OAuth 2.0 (JWT). Định dạng này yêu cầu nhập các giá trị Khoá Người dùng (ID ứng dụng khách) và Bí mật ứng dụng khách (mật khẩu ứng dụng khách) từ một tên ứng dụng dành cho nhà phát triển trên Apigee Edge. Xem thêm Các 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]

Tham số

Tham số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-1, --key Mã ứng dụng khách trong Ứng dụng dành cho nhà phát triển được liên kết với Microgateway của bạn proxy.
-s, --secret Mật khẩu ứng dụng khách từ ứng dụng dành cho nhà phát triển được liên kết với khả năng nhận biết Microgateway của bạn proxy.
-h, --help Thông tin về mức sử dụng đầ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 trên 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ư "kiểm thử" hoặc "sản phẩm").
  • $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 bí 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 mang đã ký dựa trên khoá công khai được lưu trữ trên Apigee Edge cho giá trị được chỉ định tổ chức và môi trường.

Tác dụng

edgemicro token verify -o [org] -e [env] -f [filename]

Tham số

Tham số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-f, --file Tên của tệp chứa JWT để xác minh.
-h, --help Thông tin về mức sử dụng đầ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 }

Kết quả mẫu cho mã thông báo không hợp lệ

{ [JsonWebTokenError: invalid token] name: 'JsonWebTokenError', message: 'invalid token' }

Nội dung 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 chế độ mặc định mới tệp cấu hình: ~/.edgemicro/default.yaml.

Tác dụng

edgemicro init

Tham số

Tham số 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 trong ./config/config.yaml. (Đã thêm phiên bản 2.4.x)
-h, --help Thông tin về mức sử dụng đầ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]

Tham 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ủa cụm cổng vi mô

Theo mặc định, Edge Microgateway sẽ khởi động ở chế độ cụm đồng hồ. 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

Tham số

Tham số Mô tả
-h, --help Thông tin về mức sử dụng đầ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 nhỏ (microgateway)

Dừng cụm Edge Microgateway.

Tác dụng

edgemicro stop

Tham số

Tham số Mô tả
-h, --help Thông tin về mức sử dụng đầ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

Đang tải lại cụm cổng vi mô

Cho phép khởi động lại trong thời gian không hoạt động sau khi thay đổi cấu hình. Tải lại Edge Microgateway bằng cách thêm một cấu hình mới.

Tác dụng

edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]

Tham số

Tham số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-k, --key Giá trị khoá được trả về và được trả về khi bạn chạy "edgemicro configure" .
-s, --secret Giá trị bí mật được trả về khi bạn chạy "edgemicro configure" .
-h, --help Thông tin về mức sử dụng đầ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 Edgemicro-auth

Để sử dụng tính năng xoay vòng khoá, bạn phải có một phiên bản proxy Edgemicro-auth được triển khai trong tổ chức Apigee Edge của bạn. (Đã thêm phiên bản 2.5.x)

Lưu ý: Nếu bạn đã đị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 bạn muốn sử dụng xoay vòng khoá. Bạn chỉ cần thực hiện nâng cấp này một lần.

Tác dụng

edgemicro upgradeauth -o [organization] -e [environment] -u [username]

Tham số

Tham số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username Tên người dùng của bạn trên Apigee. Bạn phải là quản trị viên tổ chức cho thuộc tính tổ chức.
-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 thông số này vào 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à cơ số URI để triển khai đám mây Apigee là api.enterprise.apigee.com. Đối với việc triển khai tại chỗ, thì URL cơ sở có thể khác nhau.

Ví dụ

edgemicro upgradeauth -o docs -e test -u jdoe@example.com

Kết quả (Thành công)

Khi thành công, lệnh này 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)

Dùng lệnh edgemicro upgradekvm để nâng cấp KVM trong Apigee của bạn tổ chức. Bạn cần phải 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'

Tham số

Tham số Mô tả
-o, --org Tổ chức Apigee mà bạn đã định cấu hình Edge Microgateway.
-e, --env Một môi trường mà bạn đã định cấu hình Edge Microgateway.
-k, --key Giá trị khoá được trả về và được trả về khi bạn chạy "edgemicro configure" .
-s, --secret Giá trị bí mật được trả về khi bạn chạy "edgemicro configure" .
-p, --proxyuri URI cho Proxy Edgemicro_auth

Edge Public Cloud: Không bắt buộc.Đám mây riêng tư trên
Edge: Bắt buộc.

Ví dụ về Edge Public Cloud: 

 -p 'https://[org]-[env].apigee.net/edgemicro-auth'

Ví dụ về Edge Private Cloud: 

-p 'https://[hostname]/edgemicro-auth'

Ví dụ

edgemicro upgradekvm -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

Kết quả (Thành công)

Khi thành công, lệnh này 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

Xoay vòng khoá

Dùng lệnh edgemicro rotatekey để xoay các cặp khoá công khai/riêng tư được dùng để tạo mã thông báo JWT dùng để bảo mật OAuth trên Edge Microgateway.

Để tìm hiểu thêm, hãy xem Xoay các 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'

Tham số

Tham số 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ôi trường mà bạn đã định cấu hình Edge Microgateway.
-k, --key Giá trị khoá được trả về và được trả về khi bạn chạy "edgemicro configure" .
-s, --secret Giá trị bí mật được trả về khi bạn chạy "edgemicro configure" .
-p Đường dẫn đến khoá riêng tư tuỳ chỉnh mà Apigee Edge sử dụng. (Bổ sung 3.1.6)
-c Đường dẫn đến chứng chỉ tuỳ chỉnh mà Apigee Edge sử dụng. (Bổ sung 3.1.6)
-n, --nbf

Định cấu hình độ trễ tính bằng phút để khoá riêng tư mới có hiệu lực. Chiến dịch này độ trễ cho phép thời gian để làm mới các thực thể microgateway bằng dữ liệu công khai mới . Bạn nên đặt độ trễ lớn hơn chế độ cài đặt cấu hình config_change_poll_internal, thời lượng là 10 phút theo mặc định. Để biết thêm thông tin, hãy xem Định cấu hình lỗi "không phải trước" trễ. (Bổ sung 3.1.6)

Lưu ý: Nếu bạn sử dụng tuỳ chọn này với phiên bản edgemicro-auth cũ hơn phiên bản được phân phối bằng Edge Microgateway 3.1.6, cờ này sẽ bị bỏ qua.

-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 vòng khoá. Nếu thông số này bị bỏ qua (nên dùng), Edge Microgateway sẽ tạo một khoá dựa trên dấu thời gian. Để biết thêm thông tin, hãy xem Mục 4.5 của thông số kỹ thuật của Khoá web JSON.
-r, --rotatekeyuri Xoay vòng URI khoá.

Edge Public Cloud: Không bắt buộc.Đám mây riêng tư trên
Edge: Bắt buộc.

Ví dụ về Cloud Public: 

-r 'https://[org]-[env].apigee.net/edgemicro-auth/rotateKey'

Ví dụ về Edge Private Cloud: 

-r '[hostname]/edgemicro-auth/rotateKey'

Ví dụ

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

Kết quả (Thành công)

Khi thành công, lệnh này 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 các phím mới đã được thêm vào microgateway trong giao diện người dùng Edge KVM.

Ví dụ:

Ví dụ này sử dụng cờ -p và -c để chỉ định đường dẫn thành một cặp khoá/chứng chỉ riêng tư. Các tuỳ chọn này cho phép bạn chuyển khoá riêng tư tuỳ chỉnh và chứng chỉ ghép nối. 

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

Thu hồi khoá

Dùng lệnh edgemicro revokekeys để thu hồi khoá và thông tin xác thực bí mật của một Cấu hình Microgateway ở cạnh.

Tác dụng

edgemicro revokekeys -o [organization] -e [environment] -u [username]
-k [key] -s [secret]

Tham số

Tham số 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ôi trường mà bạn đã định cấu hình Edge Microgateway.
-u, --username (Bạn phải dùng -u hoặc -t) Tên người dùng Apigee của bạn. Bạn phải là quản trị viên tổ chức cho thuộc tính tổ chức. Tham số này không bắt buộc nếu bạn chỉ định tham số -t.
-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 thông số này vào dòng lệnh.
-k, --key (Bắt buộc) Khoá cần thu hồi.
-s, --secret (Bắt buộc) Mã thông báo bí mật cần thu hồi.
-t, --token (Bắt buộc phải có -u hoặc -t) 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. Nếu bạn chỉ định -t thì tham số -u là không bắt buộc. Hãy xem thêm bài viết Các lệnh gọi API bảo mật bằng mã truy cập OAuth2. Ví dụ: 
edgemicro revokekeys -o ORG-NAME -e ENV-NAME -k KEY-TO-REVOKE \
    -s KEY-SECRET -t TOKEN

Ví dụ

edgemicro revokekeys -o myorg -e test -u jdoe@apigee.com
-k 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f -s 4b5d6355b874f7c46838893823e8d929dcb2e42fb9aebcb535089c9b98513

Khi thành công, bạn sẽ thấy thông báo sau:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully