Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về
Apigee X. thông tin
Giao diện dòng lệnh (CLI) apigee-remote-service-cli
giúp bạn cung cấp và quản lý bộ chuyển đổi Apigee dành cho Envoy.
Lệnh liên kết danh sách
Liệt kê tất cả sản phẩm API liên kết với Dịch vụ từ xa.
Cách sử dụng
apigee-remote-service-cli bindings list [flags]
Các tham số
Các tham số | Sự hiện diện | Dùng với sản phẩm | Nội dung mô tả |
---|---|---|---|
-c,
|
Bắt buộc | Tất cả | (Chuỗi) Đường dẫn đến tệp cấu hình dịch vụ từ xa Apigee. Lưu ý: Cờ này cho phép bạn bỏ qua hầu hết các tham số lệnh khác vì CLI có thể lấy các tham số này trực tiếp từ tệp cấu hình. Xem phần Sử dụng tuỳ chọn ‑‑config .
|
-e,
|
Bắt buộc | Tất cả | (Chuỗi) Một môi trường trong tổ chức của bạn. |
-h,
|
Không bắt buộc | Tất cả | Hiện thông tin trợ giúp cho các tham số lệnh. |
‑‑insecure
|
Không bắt buộc | Tất cả | Cho phép kết nối máy chủ không an toàn khi sử dụng SSL. |
‑‑legacy
|
Bắt buộc | Chỉ Cloud Public Cloud | Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge for Public Cloud. Đặt URL quản lý và URL thời gian chạy cho Apigee Edge for Public Cloud. |
-m,
|
Bắt buộc | Chỉ đám mây riêng tư của Edge | (Chuỗi) URL cơ sở quản lý cho quá trình cài đặt Apigee Edge để cài đặt đám mây riêng tư.
Mặc định: https://api.enterprise.apigee.com
|
‑‑mfa
| Bắt buộc | Chỉ Cloud Public Cloud | (Chuỗi) Mã thông báo uỷ quyền đa yếu tố cho Apigee Edge for Public Cloud. Chỉ bắt buộc nếu bạn đã thiết lập tính năng xác thực đa yếu tố (MFA) trên tài khoản Apigee Edge. |
‑‑opdk
| Bắt buộc | Chỉ đám mây riêng tư của Edge | Bạn phải đặt cờ này nếu đang dùng Apigee Edge cho đám mây riêng tư. |
-o,
|
Bắt buộc | Tất cả | (Chuỗi) Một tổ chức Apigee. Bạn phải là quản trị viên tổ chức. |
-p,
|
Bắt buộc (Chỉ xác thực cơ bản) |
Chỉ đám mây công khai và riêng tư ở Edge | (Chuỗi) Mật khẩu Apigee của bạn. Bạn có thể tuỳ ý chỉ định mật khẩu trong tệp .netrc . Hãy xem thêm phần Sử dụng .netrc để làm thông tin xác thực.
|
-r,
|
Bắt buộc | Chỉ dành cho giải pháp Cloud Private Edge và Apigee kết hợp | (Chuỗi) Chỉ định URL thời gian chạy cho phiên bản kết hợp của ứng dụng Đám mây riêng tư hoặc Apigee.
URL phải bắt đầu bằng https:// . Ví dụ: https://apitest.apigee-hybrid-docs.net
|
|
Không bắt buộc | Chỉ đám mây riêng tư của Edge | (Chuỗi) Chỉ định chứng chỉ TLS phía máy khách, khoá riêng tư và CA gốc cho kết nối mTLS. |
-t,
|
Bắt buộc (Chỉ xác thực mã thông báo OAuth) |
Tất cả | (Chuỗi) Mã thông báo OAuth hoặc SAML mà bạn tạo bằng thông tin tài khoản Apigee của mình. Ghi đè mọi thông tin xác thực khác đã cung cấp. |
-u,
|
Bắt buộc (Chỉ xác thực cơ bản) |
Chỉ đám mây công khai và riêng tư ở Edge |
(Chuỗi) Tên người dùng Apigee của bạn (thường là địa chỉ email).
Bạn có thể tuỳ ý chỉ định tên người dùng trong tệp .netrc . Nếu làm như vậy, thì bạn không cần phải cung cấp tên người dùng trên dòng lệnh. Hãy xem thêm phần Sử dụng .netrc để làm thông tin xác thực.
|
-v,
|
Không bắt buộc | Tất cả | (Không bắt buộc) Tạo kết quả chi tiết. |
Ví dụ:
apigee-remote-service-cli bindings list -o myorg -e test -u user@example.com \ -c config.yaml -p abc123
Kết quả ví dụ
PI Products ============ Bound ----- envoy-test: Quota: 5 requests every 1 minute Target bindings: httpbin.org Paths: httpbin: Quota: 5 requests every 1 minute Target bindings: httpbin.org Paths: /httpbin / Unbound ------- product-1: Quota: 100 requests every 1 hour product-2: Quota: 1000 requests every 1 month product-3: product-4:
Lệnh trợ giúp
Chúng tôi cung cấp dịch vụ trợ giúp trực tuyến cho tất cả các lệnh apigee-remote-service-cli
. Chỉ cần nhập:
apigee-remote-service-cli help
Để được trợ giúp về bất kỳ lệnh nào, hãy nhập:
apigee-remote-service-cli [command] help
Ví dụ:
apigee-remote-service-cli provision help
Lệnh cấp phép
Lệnh apigee-remote-service-cli provision
cài đặt 2 proxy API trong tổ chức Apigee Edge của bạn, thiết lập một chứng chỉ và tạo các thông tin xác thực mà bạn cần để định cấu hình Apigee Adapter for Envoy.
Cách sử dụng
apigee-remote-service-cli provision [flags]
Các tham số
Các tham số | Sự hiện diện | Dùng với sản phẩm | Nội dung mô tả |
---|---|---|---|
‑‑analytics-sa
|
Không bắt buộc | Chỉ dùng Apigee kết hợp và Apigee X |
(Chuỗi) Sử dụng cờ này để chỉ định đường dẫn đến tệp khoá tài khoản dịch vụ Google Cloud, trong đó tài khoản dịch vụ có vai trò |
-c,
|
Bắt buộc | Tất cả | (Chuỗi) Đường dẫn đến tệp cấu hình dịch vụ từ xa Apigee. Lưu ý: Cờ này cho phép bạn bỏ qua hầu hết các tham số lệnh khác vì CLI có thể lấy các tham số này trực tiếp từ tệp cấu hình. Xem phần Sử dụng tuỳ chọn ‑‑config .
|
-e,
|
Bắt buộc | Tất cả | (Chuỗi) Một môi trường trong tổ chức của bạn. |
-f, ‑‑force-proxy-install
|
Không bắt buộc | Tất cả | (Không bắt buộc) Buộc cài đặt lại proxy remote-service nếu proxy remote-service đã được cài đặt trong tổ chức của bạn.
|
-h,
|
Không bắt buộc | Tất cả | Hiện thông tin trợ giúp cho các tham số lệnh. |
‑‑insecure
|
Không bắt buộc | Tất cả | Cho phép kết nối máy chủ không an toàn khi sử dụng SSL. |
‑‑legacy
|
Bắt buộc | Chỉ Cloud Public Cloud | Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge for Public Cloud. Đặt URL quản lý và URL thời gian chạy cho Apigee Edge for Public Cloud. |
-m,
|
Bắt buộc | Chỉ đám mây riêng tư của Edge | (Chuỗi) URL cơ sở quản lý cho quá trình cài đặt Apigee Edge để cài đặt đám mây riêng tư.
Mặc định: https://api.enterprise.apigee.com
|
‑‑mfa
| Bắt buộc | Chỉ Cloud Public Cloud | Mã thông báo uỷ quyền đa yếu tố cho Apigee Edge dành cho đám mây công cộng. Chỉ bắt buộc nếu bạn đã thiết lập tính năng xác thực đa yếu tố (MFA) trên tài khoản Apigee Edge. |
-n, ‑‑namespace
|
Không bắt buộc | Tất cả | (Chuỗi) Cấu hình phát ra dưới dạng Envoy ConfigMap trong không gian tên được chỉ định. Mặc định: apigee
|
‑‑opdk
| Bắt buộc | Chỉ đám mây riêng tư của Edge | Bạn phải đặt cờ này nếu đang dùng Apigee Edge cho đám mây riêng tư. |
-o,
|
Bắt buộc | Tất cả | (Chuỗi) Một tổ chức Apigee. Bạn phải là quản trị viên tổ chức thì mới được cấp phép. |
-p,
|
Bắt buộc (Chỉ xác thực cơ bản) |
Chỉ đám mây công khai và riêng tư ở Edge | (Chuỗi) Mật khẩu Apigee của bạn. Bạn có thể tuỳ ý chỉ định mật khẩu trong tệp .netrc . Nếu làm như vậy, thì bạn không cần phải cung cấp mật khẩu của mình qua dòng lệnh. Hãy xem thêm phần Sử dụng .netrc để làm thông tin xác thực.
|
‑‑rotate-int
|
Không bắt buộc | Chỉ sử dụng Apigee kết hợp | (Số nguyên) Nếu n > 0, hãy tạo khóa riêng tư mới và giữ lại n khóa công khai (chỉ kết hợp) |
-r,
|
Bắt buộc | Chỉ dành cho giải pháp Cloud Private Edge và Apigee kết hợp | (Chuỗi) Chỉ định URL thời gian chạy cho phiên bản kết hợp của ứng dụng Đám mây riêng tư hoặc Apigee.
URL phải bắt đầu bằng https:// . Ví dụ: https://apitest.apigee-hybrid-docs.net
|
|
Không bắt buộc | Chỉ đám mây riêng tư của Edge | (Chuỗi) Chỉ định chứng chỉ TLS phía máy khách, khoá riêng tư và CA gốc cho kết nối mTLS. |
-t,
|
Bắt buộc (Chỉ xác thực mã thông báo OAuth) |
Tất cả | (Chuỗi) Mã thông báo OAuth hoặc SAML mà bạn tạo bằng thông tin tài khoản Apigee của mình. Ghi đè mọi thông tin xác thực khác đã cung cấp. |
-u,
|
Bắt buộc (Chỉ xác thực cơ bản) |
Chỉ đám mây công khai và riêng tư ở Edge |
(Chuỗi) Tên người dùng Apigee của bạn (thường là địa chỉ email).
Bạn có thể tuỳ ý chỉ định tên người dùng trong tệp .netrc . Hãy xem thêm phần Sử dụng .netrc để làm thông tin xác thực.
|
-v,
|
Không bắt buộc | Tất cả | (Không bắt buộc) Tạo kết quả chi tiết. |
‑‑virtual-hosts
|
Không bắt buộc | Chỉ đám mây riêng tư của Edge | (Chuỗi) Ghi đè các máy chủ ảo mặc định, là default,secure . Hãy sử dụng phương án này nếu bạn có các máy chủ ảo được chỉ định cho môi trường tổ chức Edge của bạn ngoài các chế độ mặc định này.
|
Ví dụ:
Như ví dụ sau đây cho thấy, điều quan trọng là bạn phải ghi lại kết quả của lệnh provision
trong một tệp. Tệp này sẽ được dùng làm dữ liệu đầu vào cho các hoạt động khác của Apigee Bộ chuyển đổi dành cho Envoy (Envoy).
Ví dụ:
apigee-remote-service-cli provision --legacy --mfa $MFA --username $USER --password $PASSWORD \ --organization $ORG --environment $ENV > config.yaml
Lệnh Đoạn nhạc
Tạo và liệt kê các tệp cấu hình mẫu.
Tạo tệp cấu hình mẫu
Tạo các tệp cấu hình mẫu để triển khai Envoy và Istio gốc.
Cách sử dụng
apigee-remote-service-cli samples create [flags]
Nội dung mô tả
Lệnh này yêu cầu bạn nhập tệp config.yaml
hợp lệ làm dữ liệu đầu vào. Tệp đầu vào này là tệp được tạo thông qua việc cấp phép.
Theo mặc định, các tệp mẫu sẽ được xuất sang thư mục có tên ./samples
. Lệnh sẽ tạo thư mục này cho bạn.
Nếu bạn đang sử dụng Envoy gốc, lệnh này sẽ lấy máy chủ dịch vụ mục tiêu và tên mong muốn cho cụm của máy chủ đó. Hộp cát về quyền riêng tư cũng thiết lập kết nối SSL tuỳ chỉnh từ proxy Envoy đến cụm dịch vụ từ xa nếu thư mục chứa tls.key
và tls.crt
được cung cấp qua --tls
.
Nếu bạn đang sử dụng Istio, trong đó proxy Envoy hoạt động như một trợ giúp, nếu mục tiêu chưa được chỉ định, thì ví dụ về httpbin
sẽ được tạo. Nếu không, bạn sẽ chịu trách nhiệm chuẩn bị các tệp cấu hình liên quan đến việc triển khai các dịch vụ mục tiêu.
Các tham số
Các tham số | Sự hiện diện | Dùng với sản phẩm | Nội dung mô tả |
---|---|---|---|
‑‑adapter‑host
|
Chỉ bắt buộc đối với các mẫu Envoy | Tất cả | (Chuỗi) Tên máy chủ của bộ chuyển đổi (mặc định: localhost )
|
-c, ‑‑config
|
Bắt buộc | Tất cả | (Chuỗi) Đường dẫn đến tệp cấu hình Dịch vụ từ xa Apigee. Lưu ý: Cờ này cho phép bạn bỏ qua hầu hết các tham số lệnh khác vì CLI có thể lấy các tham số này trực tiếp từ tệp cấu hình. Xem phần Sử dụng tuỳ chọn ‑‑config .
|
-f, ‑‑force
|
Không bắt buộc | Tất cả | Buộc ghi đè thư mục hiện có. |
-h, ‑‑help
|
Không bắt buộc | Tất cả | Hiện thông tin trợ giúp cho các tham số lệnh. |
‑‑host |
Chỉ bắt buộc đối với các mẫu Envoy | Tất cả | (Chuỗi) Máy chủ lưu trữ dịch vụ mục tiêu (mặc định là httpbin.org )
|
-n, ‑‑name |
Bắt buộc | Tất cả | (Chuỗi) Tên dịch vụ mục tiêu (mặc định là httpbin.org )
|
‑‑out
|
Không bắt buộc | Tất cả | (Chuỗi) Thư mục để tạo các tệp cấu hình mẫu. Mặc định: ./samples
|
‑‑tag
|
Chỉ bắt buộc đối với mẫu Istio | Tất cả | (Chuỗi) Thẻ phiên bản của hình ảnh Bộ chuyển đổi Envoy. Mặc định: v2.0.0
|
-t, ‑‑template
|
Bắt buộc | Tất cả | (Chuỗi) Tên mẫu Envoy hoặc Istio. Để xem danh sách các mẫu có sẵn, hãy thực thi lệnh
apigee-remote-service samples templates .
|
‑‑tls
|
Không bắt buộc, chỉ dành cho mẫu Envoy | Tất cả | (Chuỗi) Thư mục chứa các tệp tls.key và tls.crt được dùng cho dịch vụ bộ chuyển đổi.
|
Ví dụ:
apigee-remote-service-cli samples create -c ./config.yaml
Liệt kê các lựa chọn mẫu có sẵn
Liệt kê các mẫu có sẵn để sử dụng với tham số --templates
cho lệnh samples
.
Cách sử dụng
apigee-remote-service-cli samples templates
Các tham số
Không nội dung nào.
Ví dụ:
apigee-remote-service-cli samples templates
Supported templates (native is deprecated): envoy-1.15 envoy-1.16 envoy-1.17 istio-1.7 istio-1.8 istio-1.9
Lệnh mã thông báo
Bạn có thể sử dụng mã thông báo JWT để thực hiện lệnh gọi proxy API đã xác thực thay vì sử dụng khoá API. Các lệnh mã thông báo cho phép bạn tạo, kiểm tra và xoay vòng mã thông báo JWT cho mục đích này.
Tạo mã thông báo JWT
Bạn có thể sử dụng mã thông báo JWT để thực hiện các lệnh gọi proxy API đã xác thực đến một mục tiêu dịch vụ từ xa. Hãy xem thêm bài viết Sử dụng phương thức xác thực dựa trên JWT.Cách sử dụng
apigee-remote-service-cli token create [flags]
Các tham số
Các tham số | Sự hiện diện | Dùng với sản phẩm | Nội dung mô tả |
---|---|---|---|
-c,
|
Bắt buộc | Tất cả | (Chuỗi) Đường dẫn đến tệp cấu hình dịch vụ từ xa Apigee. Lưu ý: Cờ này cho phép bạn bỏ qua hầu hết các tham số lệnh khác vì CLI có thể lấy các tham số này trực tiếp từ tệp cấu hình. Xem phần Sử dụng tuỳ chọn ‑‑config .
|
-e,
|
Bắt buộc | Tất cả | (Chuỗi) Một môi trường trong tổ chức của bạn. |
-h,
|
Không bắt buộc | Tất cả | Hiện thông tin trợ giúp cho các tham số lệnh. |
--i, --id
|
Bắt buộc | Tất cả | (Chuỗi) Thông tin xác thực Khoá có trong ứng dụng dành cho nhà phát triển Apigee được mô tả trong bài viết Cách lấy khoá API. |
‑‑insecure
|
Không bắt buộc | Tất cả | Cho phép kết nối máy chủ không an toàn khi sử dụng SSL. |
‑‑legacy
|
Bắt buộc | Chỉ Cloud Public Cloud | Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge for Public Cloud. Đặt URL quản lý và URL thời gian chạy cho Apigee Edge for Public Cloud. |
‑‑opdk
| Bắt buộc | Chỉ đám mây riêng tư của Edge | Bạn phải đặt cờ này nếu đang dùng Apigee Edge cho đám mây riêng tư. |
-o,
|
Bắt buộc | Tất cả | (Chuỗi) Một tổ chức Apigee. Bạn phải là quản trị viên tổ chức. |
-r,
|
Bắt buộc | Chỉ dành cho giải pháp Cloud Private Edge và Apigee kết hợp | (Chuỗi) Chỉ định URL thời gian chạy cho phiên bản kết hợp của ứng dụng Đám mây riêng tư hoặc Apigee.
URL phải bắt đầu bằng https:// . Ví dụ: https://apitest.apigee-hybrid-docs.net
|
--s, ‑‑secret
|
Bắt buộc | Tất cả | (Chuỗi) Thông tin xác thực Bí mật có trong ứng dụng dành cho nhà phát triển Apigee được mô tả trong bài viết Cách lấy khoá API. |
|
Không bắt buộc | Chỉ đám mây riêng tư của Edge | (Chuỗi) Chỉ định chứng chỉ TLS phía máy khách, khoá riêng tư và CA gốc cho kết nối mTLS. |
-v,
|
Không bắt buộc | Tất cả | (Không bắt buộc) Tạo kết quả chi tiết. |
Ví dụ:
apigee-remote-service-cli token create -o myorg -e test -i YUmlZAcBKNsTAelJqPZFl3sh58ObATX9 \ -s icTARgaKHqvUH1dq -c config.yaml
Đầu ra
Sau khi thành công, bạn sẽ thấy dữ liệu đầu ra của mã thông báo JST tương tự như sau:eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q
Kiểm tra mã thông báo JWT
Bạn có thể kiểm tra mã thông báo JWT bằng lệnh này. Hãy xem thêm phần Kiểm tra mã thông báo.Cách sử dụng
apigee-remote-service-cli token inspect [flags]
Các tham số
Các tham số
Các tham số | Sự hiện diện | Dùng với sản phẩm | Nội dung mô tả |
---|---|---|---|
-c,
|
Bắt buộc | Tất cả | (Chuỗi) Đường dẫn đến tệp cấu hình dịch vụ từ xa Apigee. Lưu ý: Cờ này cho phép bạn bỏ qua hầu hết các tham số lệnh khác vì CLI có thể lấy các tham số này trực tiếp từ tệp cấu hình. Xem phần Sử dụng tuỳ chọn ‑‑config .
|
-e,
|
Bắt buộc | Tất cả | (Chuỗi) Một môi trường trong tổ chức của bạn. |
-f,
|
Bắt buộc | Tất cả | (Chuỗi) Tệp mã thông báo (mặc định: sử dụng stdin )
|
-h,
|
Không bắt buộc | Tất cả | Hiện thông tin trợ giúp cho các tham số lệnh. |
‑‑insecure
|
Không bắt buộc | Tất cả | Cho phép kết nối máy chủ không an toàn khi sử dụng SSL. |
‑‑legacy
|
Bắt buộc | Chỉ Cloud Public Cloud | Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge for Public Cloud. Đặt URL quản lý và URL thời gian chạy cho Apigee Edge for Public Cloud. |
‑‑opdk
| Bắt buộc | Chỉ đám mây riêng tư của Edge | Bạn phải đặt cờ này nếu đang dùng Apigee Edge cho đám mây riêng tư. |
-o,
|
Bắt buộc | Tất cả | (Chuỗi) Một tổ chức Apigee. Bạn phải là quản trị viên tổ chức. |
-r,
|
Bắt buộc | Chỉ dành cho giải pháp Cloud Private Edge và Apigee kết hợp | (Chuỗi) Chỉ định URL thời gian chạy cho phiên bản kết hợp của ứng dụng Đám mây riêng tư hoặc Apigee.
URL phải bắt đầu bằng https:// . Ví dụ: https://apitest.apigee-hybrid-docs.net
|
|
Không bắt buộc | Chỉ đám mây riêng tư của Edge | (Chuỗi) Chỉ định chứng chỉ TLS phía máy khách, khoá riêng tư và CA gốc cho kết nối mTLS. |
-v,
|
Không bắt buộc | Tất cả | (Không bắt buộc) Tạo kết quả chi tiết. |
Ví dụ:
apigee-remote-service-cli token inspect -c config.yaml <<< $TOKEN
Đầu ra
Sau khi thành công, bạn sẽ thấy kết quả tương tự như sau:{ "aud": [ "remote-service-client" ], "exp": 1591741549, "iat": 1591740649, "iss": "https://apigee-docs-test.apigee.net/remote-service/token", "jti": "99325d2e-6440-4278-9f7f-b252a1a79e53", "nbf": 1591740649, "access_token": "VfzpXzBGAQ07po0bPMKY4JgQjus", "api_product_list": [ "httpbin" ], "application_name": "httpbin", "client_id": "GYDGHy5TRpV8AejXCOlreP7dPVepA8H", "developer_email": "user@example.com", "scope": "" } verifying... token ok.
Xoay mã thông báo JWT
Tại một thời điểm sau khi tạo JWT lần đầu, bạn có thể cần thay đổi cặp khoá công khai/riêng tư do Apigee lưu trữ trong bản đồ khoá-giá trị đã mã hoá (KVM). Quá trình tạo một cặp khoá mới này được gọi là xoay khoá. Khi bạn xoay vòng khoá, một cặp khoá riêng tư/công khai mới sẽ được tạo và lưu trữ trong KVM "istio" của tổ chức/môi trường Apigee của bạn. Ngoài ra, khoá công khai cũ sẽ được giữ lại cùng với giá trị mã nhận dạng khoá ban đầu.Cách sử dụng
apigee-remote-service-cli token rotate-cert [flags]
Các tham số
Các tham số | Sự hiện diện | Dùng với sản phẩm | Nội dung mô tả |
---|---|---|---|
-c,
|
Bắt buộc | Tất cả | (Chuỗi) Đường dẫn đến tệp cấu hình dịch vụ từ xa Apigee. Lưu ý: Cờ này cho phép bạn bỏ qua hầu hết các tham số lệnh khác vì CLI có thể lấy các tham số này trực tiếp từ tệp cấu hình. Xem phần Sử dụng tuỳ chọn ‑‑config .
|
-e,
|
Bắt buộc | Tất cả | (Chuỗi) Một môi trường trong tổ chức của bạn. |
-h,
|
Không bắt buộc | Chỉ đám mây công khai và riêng tư ở Edge | Hiện thông tin trợ giúp cho các tham số lệnh. |
--k, --key
|
Bắt buộc | Chỉ đám mây công khai và riêng tư ở Edge | (Chuỗi) Khoá cấp phép. |
‑‑insecure
|
Không bắt buộc | Chỉ đám mây công khai và riêng tư ở Edge | Cho phép kết nối máy chủ không an toàn khi sử dụng SSL. |
‑‑legacy
|
Bắt buộc | Chỉ Cloud Public Cloud | Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge for Public Cloud. Đặt URL quản lý và URL thời gian chạy cho Apigee Edge for Public Cloud. |
‑‑opdk
| Bắt buộc | Chỉ đám mây riêng tư của Edge | Bạn phải đặt cờ này nếu đang dùng Apigee Edge cho đám mây riêng tư. |
-o,
|
Bắt buộc | Chỉ đám mây công khai và riêng tư ở Edge | (Chuỗi) Một tổ chức Apigee. Bạn phải là quản trị viên tổ chức. |
-r,
|
Bắt buộc | Chỉ đám mây riêng tư của Edge | (Chuỗi) Chỉ định URL thời gian chạy cho phiên bản kết hợp của ứng dụng Đám mây riêng tư hoặc Apigee.
URL phải bắt đầu bằng https:// . Ví dụ: https://apitest.apigee-hybrid-docs.net
|
--s, ‑‑secret
|
Bắt buộc | Tất cả | (Chuỗi) Mã bí mật cung cấp. |
|
Không bắt buộc | Chỉ đám mây riêng tư của Edge | (Chuỗi) Chỉ định chứng chỉ TLS phía máy khách, khoá riêng tư và CA gốc cho kết nối mTLS. |
--t, ‑‑truncate
|
Bắt buộc | Tất cả | (Số nguyên) Số lượng chứng chỉ cần giữ lại trong JWKS (mặc định là 2). |
-v,
|
Không bắt buộc | Tất cả | (Không bắt buộc) Tạo kết quả chi tiết. |
Ví dụ:
apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test \ -k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 \ -s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08
Đầu ra
certificate successfully rotated
Tạo mã thông báo nội bộ
Tạo mã thông báo JWT để uỷ quyền các lệnh gọi API dịch vụ từ xa.Cách sử dụng
apigee-remote-service-cli token internal [flags]
Các tham số
Các tham số
Các tham số | Sự hiện diện | Dùng với sản phẩm | Nội dung mô tả |
---|---|---|---|
-c,
|
Bắt buộc | Chỉ sử dụng Apigee kết hợp | (Chuỗi) Đường dẫn đến tệp cấu hình dịch vụ từ xa Apigee. Lưu ý: Cờ này cho phép bạn bỏ qua hầu hết các tham số lệnh khác vì CLI có thể lấy các tham số này trực tiếp từ tệp cấu hình. Xem phần Sử dụng tuỳ chọn ‑‑config .
|
-d,
|
Bắt buộc | Chỉ sử dụng Apigee kết hợp | (Chuỗi) thời gian hợp lệ của JWT nội bộ kể từ khi tạo (mặc định: 10m0s (10 phút)).
|
-e,
|
Bắt buộc | Chỉ sử dụng Apigee kết hợp | (Chuỗi) Một môi trường trong tổ chức của bạn. |
-h,
|
Không bắt buộc | Chỉ sử dụng Apigee kết hợp | Hiện thông tin trợ giúp cho các tham số lệnh. |
‑‑insecure
|
Không bắt buộc | Chỉ sử dụng Apigee kết hợp | Cho phép kết nối máy chủ không an toàn khi sử dụng SSL. |
-o,
|
Bắt buộc | Chỉ sử dụng Apigee kết hợp | (Chuỗi) Một tổ chức Apigee. Bạn phải là quản trị viên tổ chức. |
-r,
|
Bắt buộc | Chỉ sử dụng Apigee kết hợp | (Chuỗi) Chỉ định URL thời gian chạy cho phiên bản kết hợp Apigee của bạn.
URL phải bắt đầu bằng https:// . Ví dụ: https://apitest.apigee-hybrid-docs.net
|
-v,
|
Không bắt buộc | Chỉ sử dụng Apigee kết hợp | (Không bắt buộc) Tạo kết quả chi tiết. |
Lệnh phiên bản
In phiên bản CLI.
apigee-remote-service-cli version
Sử dụng .netrc làm thông tin xác thực
apigee-remote-service-cli
sẽ tự động nhận username
và password
(để xác thực cơ bản khi cần) từ tệp .netrc
trong thư mục gốc nếu bạn đang sử dụng Edge Public Cloud và có một mục cho máy api.enterprise.apigee.com
. Nếu bạn đang sử dụng Apigee Private Cloud, thì giá trị máy sẽ giống với URL management
của bạn (Ví dụ: http://192.162.55.100
).
Ví dụ trên Edge Public Cloud:
machine api.enterprise.apigee.com login jdoe@google.com password abc123Ví dụ trên Edge Private Cloud:
machine http://192.162.55.100 login jdoe@google.com password abc123
Sử dụng tuỳ chọn lệnh ‑‑config
Tuỳ chọn ‑‑config
chỉ định vị trí của tệp cấu hình do lệnh provision
tạo. Một lợi ích hữu ích của tuỳ chọn này là cho phép bạn bỏ qua hầu hết các tham số lệnh khác mà CLI lấy từ tệp cấu hình.
Những lựa chọn này bao gồm:
- tổ chức
- môi trường
- thời gian chạy
- quản lý
- không an toàn
- vùng chứa tên
- cũ
- oBluetooth
Ví dụ: bạn có thể thực thi lệnh provision
như sau:
apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml
Tệp cấu hình
Phần này cho thấy một tệp cấu hình mẫu với tất cả các tuỳ chọn có sẵn.
global: temp_dir: /tmp/apigee-istio keep_alive_max_connection_age: 10m api_address: :5000 metrics_address: :5001 tls: cert_file: tls.crt key_file: tls.key tenant: internal_api: https://istioservices.apigee.net/edgemicro remote_service_api: https://org-test.apigee.net/remote-service org_name: org env_name: env key: mykey secret: mysecret client_timeout: 30s tls: ca_file: /opt/apigee/tls/ca.crt cert_file: /opt/apigee/tls/tls.crt key_file: /opt/apigee/tls/tls.key allow_unverified_ssl_cert: false products: refresh_rate: 2m analytics: legacy_endpoint: false file_limit: 1024 send_channel_size: 10 collection_interval: 10s auth: api_key_claim: claim api_key_cache_duration: 30m api_key_header: x-api-key api_header: :authority allow_unauthorized: false jwt_provider_key: https://org-test.apigee.net/remote-token/token append_metadata_headers: true