Tài liệu tham khảo

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) của apigee-remote-service-cli giúp bạn cung cấp và quản lý Bộ chuyển đổi Apigee for Envoy.

Lệnh liên kết danh sách

Liệt kê tất cả sản phẩm API được liên kết với Dịch vụ từ xa.

Cách sử dụng

apigee-remote-service-cli bindings list [flags]

Tham số

Tham số Sự hiện diện Dùng cho sản phẩm Mô tả
-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.
Mẹo: 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ể kéo trực tiếp chúng từ tệp cấu hình. Xem Sử dụng tuỳ chọn ‑‑config.
-e,
‑‑environment 		Bắt buộc Tất cả (Chuỗi) Môi trường trong tổ chức của bạn.
-h,
‑‑help 		Không bắt buộc Tất cả Hiện thông tin trợ giúp về 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 cho Public Cloud. Thiết lập URL quản lý và URL thời gian chạy cho Apigee Edge dành cho Public Cloud.
-m,
‑‑management 		Bắt buộc Chỉ Đám mây riêng tư ở cạnh (Chuỗi) URL cơ sở quản lý cho dịch vụ cài đặt trên đám mây riêng tư của Apigee Edge. 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 dành cho Public Cloud. Chỉ bắt buộc nếu xác thực đa yếu tố được thiết lập trên tài khoản Apigee Edge của bạn.
‑‑opdk Bắt buộc Chỉ Đám mây riêng tư ở cạnh Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge cho Đám mây riêng tư.
-o,
‑‑organization 		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,
‑‑password 		Bắt buộc
(Chỉ xác thực cơ bản)		 Chỉ Edge công khai và riêng tư (Chuỗi) Mật khẩu của bạn trên Apigee. Bạn có thể tuỳ ý chỉ định mật khẩu trong tệp .netrc. Xem thêm Sử dụng .netrc làm thông tin đăng nhập.
-r,
‑‑runtime 		Bắt buộc Chỉ đối với Edge Private Cloud 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 Đá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
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Không bắt buộc Chỉ Đám mây riêng tư ở cạnh (Chuỗi) Chỉ định chứng chỉ TLS phía máy khách, khoá riêng tư và tổ chức phát hành chứng chỉ gốc cho kết nối mTLS.
-t,
‑‑token 		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 dựa trên thông tin tài khoản Apigee của bạn. Ghi đè mọi thông tin đăng nhập khác đã cung cấp.
-u,
‑‑username 		Bắt buộc
(Chỉ xác thực cơ bản)		 Chỉ Edge công khai và riêng tư (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 bạn làm như vậy, thì bạn không cần cung cấp tên người dùng trên dòng lệnh. Xem Sử dụng .netrc làm thông tin đăng nhập.
-v,
‑‑verbose 		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

Tất cả lệnh apigee-remote-service-cli đều có dịch vụ trợ giúp trực tuyến. 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 Apigee của bạn Edge, thiết lập chứng chỉ và tạo thông tin đăng nhập mà bạn cần để định cấu hình Bộ chuyển đổi Apigee cho Envoy.

Cách sử dụng

apigee-remote-service-cli provision [flags]

Tham số

Tham số Sự hiện diện Dùng cho sản phẩm Mô tả
‑‑analytics-sa Không bắt buộc Chỉ dành cho kết hợp Apigee 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ò Apigee Analytics Agent. SA được sử dụng để tải trực tiếp dữ liệu phân tích lên Apigee. Nếu bạn đang sử dụng kết hợp Apigee, tuỳ chọn này cho phép bạn cài đặt môi trường thời gian chạy kết hợp trong một cụm và bộ chuyển đổi trong một cụm khác.
-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.
Mẹo: 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ể kéo trực tiếp chúng từ tệp cấu hình. Xem Sử dụng tuỳ chọn ‑‑config.
-e,
‑‑environment 		Bắt buộc Tất cả (Chuỗi) 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 đã được cài đặt trong tổ chức của bạn.
-h,
‑‑help 		Không bắt buộc Tất cả Hiện thông tin trợ giúp về 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 cho Public Cloud. Thiết lập URL quản lý và URL thời gian chạy cho Apigee Edge dành cho Public Cloud.
-m,
‑‑management 		Bắt buộc Chỉ Đám mây riêng tư ở cạnh (Chuỗi) URL cơ sở quản lý cho dịch vụ cài đặt trên đám mây riêng tư của Apigee Edge. 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 trên Public Cloud. Chỉ bắt buộc nếu xác thực đa yếu tố được thiết lập trên tài khoản Apigee Edge của bạn.
-n, ‑‑namespace Không bắt buộc Tất cả (Chuỗi) Phát ra cấu hình dưới dạng một 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ạnh Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge cho Đám mây riêng tư.
-o,
‑‑organization 		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ó thể cấp phép.
-p,
‑‑password 		Bắt buộc
(Chỉ xác thực cơ bản)		 Chỉ Edge công khai và riêng tư (Chuỗi) Mật khẩu của bạn trên Apigee. Bạn có thể tuỳ ý chỉ định mật khẩu trong tệp
.netrc. Nếu bạn làm như vậy, thì bạn không bắt buộc phải cung cấp mật khẩu của bạn trên dòng lệnh. Xem thêm Sử dụng .netrc làm thông tin đăng nhập.
‑‑rotate-int Không bắt buộc Chỉ dành cho doanh nghiệp kết hợp Apigee (Số nguyên) Nếu n > 0, tạo khoá riêng tư mới và giữ lại n khoá công khai (chỉ kết hợp)
-r,
‑‑runtime 		Bắt buộc Chỉ đối với Edge Private Cloud 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 Đá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
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Không bắt buộc Chỉ Đám mây riêng tư ở cạnh (Chuỗi) Chỉ định chứng chỉ TLS phía máy khách, khoá riêng tư và tổ chức phát hành chứng chỉ gốc cho kết nối mTLS.
-t,
‑‑token 		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 dựa trên thông tin tài khoản Apigee của bạn. Ghi đè mọi thông tin đăng nhập khác đã cung cấp.
-u,
‑‑username 		Bắt buộc
(Chỉ xác thực cơ bản)		 Chỉ Edge công khai và riêng tư (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. Xem Sử dụng .netrc làm thông tin đăng nhập.
-v,
‑‑verbose 		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ạnh (Chuỗi) Ghi đè máy chủ ảo mặc định là default,secure. Sử dụng phương án này nếu bạn có máy chủ ảo được chỉ định cho môi trường tổ chức Edge của bạn khác với các giá trị mặc định này.

Ví dụ:

Như trong ví dụ sau, bạn cần ghi lại kết quả của lệnh provision trong một tệp. Lệnh này được sử dụng làm đầu vào cho các hoạt động khác của Bộ chuyển đổi Apigee dành cho Envoy.

Ví dụ: 

apigee-remote-service-cli provision --legacy --mfa $MFA --username $USER --password $PASSWORD \
--organization $ORG --environment $ENV > config.yaml

Lệnh mẫu

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 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]

Mô tả

Lệnh này cần một tệp config.yaml hợp lệ làm dữ liệu đầu vào. Tệp nhập này là tệp được tạo thông qua cấp phép. Theo mặc định, các tệp mẫu sẽ được xuất vào 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ụ đích và tên mong muốn cho cụm của nó. Thao tác này cũng thiết lập kết nối SSL tuỳ chỉnh từ proxy Envoy đến 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 tệp trợ giúp, nếu mục tiêu không được xác định, ví dụ httpbin sẽ được tạo. Nếu không, bạn có 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ủa bạn.

Tham số

Tham số Sự hiện diện Dùng cho sản phẩm 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.
Mẹo: 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ể kéo trực tiếp chúng từ tệp cấu hình. Xem 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 về 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ụ đích (mặc định là httpbin.org)
-n, ‑‑name Bắt buộc Tất cả (Chuỗi) Tên dịch vụ đích (mặc định là httpbin.org)
‑‑out Không bắt buộc Tất cả (Chuỗi) Thư mục để tạo 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 Envoy Adapter. 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 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ỉ đối với các 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 mẫu có sẵn

Liệt kê các mẫu có sẵn để sử dụng với tham số --templates cho samples .

Cách sử dụng

apigee-remote-service-cli samples templates

Tham số

Không có.

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 lệnh gọi proxy API đã xác thực đến một đích dịch vụ từ xa. Xem Sử dụng xác thực dựa trên JWT.

Cách sử dụng

apigee-remote-service-cli token create [flags]

Tham số

Tham số Sự hiện diện Dùng cho sản phẩm Mô tả
-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.
Mẹo: 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ể kéo trực tiếp chúng từ tệp cấu hình. Xem Sử dụng tuỳ chọn ‑‑config.
-e,
‑‑environment 		Bắt buộc Tất cả (Chuỗi) Môi trường trong tổ chức của bạn.
-h,
‑‑help 		Không bắt buộc Tất cả Hiện thông tin trợ giúp về các tham số lệnh.
--i, --id Bắt buộc Tất cả (Chuỗi) Thông tin đăng nhập Key (Khoá) được tìm thấy trong ứng dụng dành cho nhà phát triển Apigee như mô tả trong 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 cho Public Cloud. Thiết lập URL quản lý và URL thời gian chạy cho Apigee Edge dành cho Public Cloud.
‑‑opdk Bắt buộc Chỉ Đám mây riêng tư ở cạnh Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge cho Đám mây riêng tư.
-o,
‑‑organization 		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,
‑‑runtime 		Bắt buộc Chỉ đối với Edge Private Cloud 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 Đá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 đăng nhập Secret (Bí mật) được tìm thấy trong ứng dụng dành cho nhà phát triển Apigee như mô tả trong Cách lấy khoá API.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Không bắt buộc Chỉ Đám mây riêng tư ở cạnh (Chuỗi) Chỉ định chứng chỉ TLS phía máy khách, khoá riêng tư và Tổ chức phát hành chứng chỉ gốc cho kết nối mTLS.
-v,
‑‑verbose 		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

Khi thành công, bạn sẽ thấy kết quả 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. 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]

Tham số

Tham số

Tham số Sự hiện diện Dùng cho sản phẩm Mô tả
-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.
Mẹo: 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ể kéo trực tiếp chúng từ tệp cấu hình. Xem Sử dụng tuỳ chọn ‑‑config.
-e,
‑‑environment 		Bắt buộc Tất cả (Chuỗi) Môi trường trong tổ chức của bạn.
-f,
‑‑file 		Bắt buộc Tất cả (Chuỗi) Tệp mã thông báo (mặc định: sử dụng stdin)
-h,
‑‑help 		Không bắt buộc Tất cả Hiện thông tin trợ giúp về 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 cho Public Cloud. Thiết lập URL quản lý và URL thời gian chạy cho Apigee Edge dành cho Public Cloud.
‑‑opdk Bắt buộc Chỉ Đám mây riêng tư ở cạnh Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge cho Đám mây riêng tư.
-o,
‑‑organization 		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,
‑‑runtime 		Bắt buộc Chỉ đối với Edge Private Cloud 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 Đá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
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Không bắt buộc Chỉ Đám mây riêng tư ở cạnh (Chuỗi) Chỉ định chứng chỉ TLS phía máy khách, khoá riêng tư và Tổ chức phát hành chứng chỉ gốc cho kết nối mTLS.
-v,
‑‑verbose 		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

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 nào đó sau khi tạo JWT lần đầu, bạn có thể cần thay đổi khoá công khai/riêng tư cặp ứng dụng do Apigee lưu trữ trong bản đồ khoá-giá trị (KVM) đã mã hoá. Quá trình tạo một cặp khoá mới được gọi là xoay vòng khoá. Khi bạn thay đổi khoá, một cặp khoá riêng tư/công khai mới được tạo và lưu trữ trong "istio" KVM trong 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]

Tham số

Tham số Sự hiện diện Dùng cho sản phẩm Mô tả
-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.
Mẹo: 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ể kéo trực tiếp chúng từ tệp cấu hình. Xem Sử dụng tuỳ chọn ‑‑config.
-e,
‑‑environment 		Bắt buộc Tất cả (Chuỗi) Môi trường trong tổ chức của bạn.
-h,
‑‑help 		Không bắt buộc Chỉ Edge công khai và riêng tư Hiện thông tin trợ giúp về các tham số lệnh.
--k, --key Bắt buộc Chỉ Edge công khai và riêng tư (Chuỗi) Khoá cấp phép.
‑‑insecure Không bắt buộc Chỉ Edge công khai và riêng tư 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 cho Public Cloud. Thiết lập URL quản lý và URL thời gian chạy cho Apigee Edge dành cho Public Cloud.
‑‑opdk Bắt buộc Chỉ Đám mây riêng tư ở cạnh Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge cho Đám mây riêng tư.
-o,
‑‑organization 		Bắt buộc Chỉ Edge công khai và riêng tư (Chuỗi) Một tổ chức Apigee. Bạn phải là quản trị viên tổ chức.
-r,
‑‑runtime 		Bắt buộc Chỉ Đám mây riêng tư ở cạnh (Chuỗi) Chỉ định URL thời gian chạy cho phiên bản kết hợp của Đá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 cho việc cấp phép.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Không bắt buộc Chỉ Đám mây riêng tư ở cạnh (Chuỗi) Chỉ định chứng chỉ TLS phía máy khách, khoá riêng tư và tổ chức phát hành chứng chỉ 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ữ trong JWKS (mặc định là 2).
-v,
‑‑verbose 		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 để cho phép các lệnh gọi API dịch vụ từ xa.

Cách sử dụng

apigee-remote-service-cli token internal [flags]

Tham số

Tham số

Tham số Sự hiện diện Dùng cho sản phẩm Mô tả
-c,
‑‑config 		Bắt buộc Chỉ dành cho doanh nghiệp kết hợp Apigee (Chuỗi) Đường dẫn đến tệp cấu hình Dịch vụ từ xa Apigee.
Mẹo: 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ể kéo trực tiếp chúng từ tệp cấu hình. Xem Sử dụng tuỳ chọn ‑‑config.
-d,
‑‑duration 		Bắt buộc Chỉ dành cho doanh nghiệp kết hợp Apigee (Chuỗi) thời gian hợp lệ của JWT nội bộ từ khi tạo (mặc định: 10m0s (10 phút)).
-e,
‑‑environment 		Bắt buộc Chỉ dành cho doanh nghiệp kết hợp Apigee (Chuỗi) Môi trường trong tổ chức của bạn.
-h,
‑‑help 		Không bắt buộc Chỉ dành cho doanh nghiệp kết hợp Apigee Hiện thông tin trợ giúp về các tham số lệnh.
‑‑insecure Không bắt buộc Chỉ dành cho doanh nghiệp kết hợp Apigee Cho phép kết nối máy chủ không an toàn khi sử dụng SSL.
-o,
‑‑organization 		Bắt buộc Chỉ dành cho doanh nghiệp kết hợp Apigee (Chuỗi) Một tổ chức Apigee. Bạn phải là quản trị viên tổ chức.
-r,
‑‑runtime 		Bắt buộc Chỉ dành cho doanh nghiệp kết hợp Apigee (Chuỗi) Chỉ định URL thời gian chạy cho phiên bản kết hợp của Apigee. URL phải bắt đầu bằng https://. Ví dụ: https://apitest.apigee-hybrid-docs.net
-v,
‑‑verbose 		Không bắt buộc Chỉ dành cho doanh nghiệp kết hợp Apigee (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 đăng nhập

apigee-remote-service-cli tự động nhận username và password (để xác thực cơ bản khi cần) từ .netrc trong thư mục gốc nếu bạn đang sử dụng Edge Public Cloud và có một mục nhập cho máy api.enterprise.apigee.com. Nếu bạn đang sử dụng dịch vụ đám mây riêng tư Apigee, giá trị trên máy 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 abc123
Ví 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 được tạo bởi lệnh provision. 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. Các 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
  • không gian tên
  • cũ
  • opdk

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 trình bày một tệp cấu hình mẫu với tất 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