Tài liệu tham khảo

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu 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ý Apigee Adapter for Envoy.

Lệnh liệt kê các liên kết

Liệt kê tất cả cá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]

Thông số

Thông số Tỷ lệ hiển thị Được dùng với 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 của 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ể kéo trực tiếp các tham số đó từ tệp cấu hình. Xem phần Sử dụng lựa chọn ‑‑config.
-e,
‑‑environment 		Bắt buộc Tất cả (Chuỗi) Một 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 các kết nối máy chủ không an toàn khi sử dụng SSL.
‑‑legacy Bắt buộc Chỉ có trên Edge Public Cloud Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge cho Đám mây công cộng. Đặt URL quản lý và thời gian chạy cho Apigee Edge cho Đám mây công cộng.
-m,
‑‑management 		Bắt buộc Chỉ dành cho Edge Private Cloud (Chuỗi) URL cơ sở quản lý cho chế độ cài đặt Apigee Edge cho Private Cloud. Mặc định: https://api.enterprise.apigee.com
‑‑mfa Bắt buộc Chỉ có trên Edge Public Cloud (Chuỗi) Mã thông báo uỷ quyền đa yếu tố cho Apigee Edge cho Đám mây công cộng. Chỉ bắt buộc nếu bạn thiết lập MFA trên tài khoản Apigee Edge.
‑‑opdk Bắt buộc Chỉ dành cho Edge Private Cloud Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge cho Private Cloud.
-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ỉ dành cho Đám mây công cộng và Đám mây riêng tư của 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. Xem thêm Sử dụng .netrc cho thông tin xác thực.
-r,
‑‑runtime 		Bắt buộc Chỉ dành cho Edge Private Cloud và Apigee hybrid (Chuỗi) Chỉ định URL thời gian chạy cho Đám mây riêng hoặc phiên bản kết hợp 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ỉ có trên Edge Private Cloud (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,
‑‑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 từ thông tin tài khoản Apigee. Ghi đè mọi thông tin đăng nhập khác được cung cấp.
-u,
‑‑username 		Bắt buộc
(Chỉ xác thực cơ bản)		 Chỉ dành cho Đám mây công cộng và Đám mây riêng tư của 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, bạn không cần cung cấp tên người dùng trên dòng lệnh. Xem thêm Sử dụng .netrc cho thông tin xác thực.
-v,
‑‑verbose 		Không bắt buộc Tất cả (Không bắt buộc) Tạo đầu ra chi tiết.

Ví dụ

apigee-remote-service-cli bindings list -o myorg -e test -u user@example.com \
-c config.yaml -p abc123

Ví dụ về đầu ra 

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

Thông tin trợ giúp trực tuyến được cung cấp 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 cung cấp

Lệnh apigee-remote-service-cli provision sẽ 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 thông tin đăng nhập mà bạn sẽ cần để định cấu hình Apigee Adapter for Envoy.

Cách sử dụng

apigee-remote-service-cli provision [flags]

Thông số

Thông số Tỷ lệ hiển thị Được dùng với sản phẩm Mô tả
‑‑analytics-sa Không bắt buộc Chỉ có Apigee Hybrid 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 trình chuyển đổi dùng để tải trực tiếp dữ liệu phân tích lên Apigee. Nếu đang sử dụng Apigee hybrid, lựa chọn này cho phép bạn cài đặt 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 của 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ể kéo trực tiếp các tham số đó từ tệp cấu hình. Xem phần Sử dụng lựa chọn ‑‑config.
-e,
‑‑environment 		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 này đã đượ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 các kết nối máy chủ không an toàn khi sử dụng SSL.
‑‑legacy Bắt buộc Chỉ có trên Edge Public Cloud Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge cho Đám mây công cộng. Đặt URL quản lý và thời gian chạy cho Apigee Edge cho Đám mây công cộng.
-m,
‑‑management 		Bắt buộc Chỉ dành cho Edge Private Cloud (Chuỗi) URL cơ sở quản lý cho chế độ cài đặt Apigee Edge cho Private Cloud. Mặc định: https://api.enterprise.apigee.com
‑‑mfa Bắt buộc Chỉ có trên Edge Public Cloud Mã thông báo uỷ quyền đa yếu tố cho Apigee Edge cho Đám mây công khai. Chỉ bắt buộc nếu bạn thiết lập MFA trên tài khoản Apigee Edge.
-n, ‑‑namespace Không bắt buộc Tất cả (Chuỗi) Phát cấu hình dưới dạng Envoy ConfigMap trong không gian tên đã chỉ định. Mặc định: apigee
‑‑opdk Bắt buộc Chỉ dành cho Edge Private Cloud Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge cho Private Cloud.
-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ể cung cấp.
-p,
‑‑password 		Bắt buộc
(Chỉ xác thực cơ bản)		 Chỉ dành cho Đám mây công cộng và Đám mây riêng tư của 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, bạn không cần cung cấp mật khẩu trên dòng lệnh. Xem thêm Sử dụng .netrc cho thông tin xác thực.
‑‑rotate-int Không bắt buộc Chỉ có Apigee Hybrid (Số nguyên) Nếu n > 0, hãy tạo khoá riêng tư mới và giữ lại n khoá công khai (chỉ dành cho chế độ kết hợp)
-r,
‑‑runtime 		Bắt buộc Chỉ dành cho Edge Private Cloud và Apigee hybrid (Chuỗi) Chỉ định URL thời gian chạy cho Đám mây riêng hoặc phiên bản kết hợp 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ỉ có trên Edge Private Cloud (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,
‑‑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 từ thông tin tài khoản Apigee. Ghi đè mọi thông tin đăng nhập khác được cung cấp.
-u,
‑‑username 		Bắt buộc
(Chỉ xác thực cơ bản)		 Chỉ dành cho Đám mây công cộng và Đám mây riêng tư của 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. Xem thêm Sử dụng .netrc cho thông tin xác thực.
-v,
‑‑verbose 		Không bắt buộc Tất cả (Không bắt buộc) Tạo đầu ra chi tiết.
‑‑virtual-hosts Không bắt buộc Chỉ dành cho Edge Private Cloud (Chuỗi) 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 máy chủ ảo cho tổ chức-môi trường Edge của mình ngoài các giá trị mặc định này.

Ví dụ

Như ví dụ sau đây cho thấy, bạn cần nắm bắt đầu ra của lệnh provision trong một tệp. Tệp này được dùng làm đầu vào cho các thao tác khác của Apigee Adapter for 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 các tệp cấu hình mẫu cho việc 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 yêu cầu bạn nhập một tệp config.yaml hợp lệ. Tệp đầu vào này là tệp được tạo thông qua quy trình cấp phép. Theo mặc định, các tệp mẫu sẽ được xuất ra một thư mục có tên là ./samples. Lệnh này 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 máy chủ đó. Thao tác này 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 một thư mục chứa tls.key và tls.crt được cung cấp thông qua --tls.

Nếu bạn đang sử dụng Istio, trong đó proxy Envoy hoạt động như một sidecar, nếu mục tiêu không được chỉ định, ví dụ httpbin sẽ được tạo. Nếu không, bạn phải 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.

Thông số

Thông số Tỷ lệ hiển thị Được dùng với sản phẩm Mô tả
‑‑adapter‑host Chỉ bắt buộc đối với 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 của 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ể kéo trực tiếp các tham số đó từ tệp cấu hình. Xem phần Sử dụng lựa 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 mẫu Envoy Tất cả (Chuỗi) Máy chủ 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ả (String) 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 các 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 hiện có, 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 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ó thể dùng với tham số --templates cho lệnh samples.

Cách sử dụng

apigee-remote-service-cli samples templates

Thông 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 các lệnh gọi được xác thực đến proxy API 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 được xác thực đến đích dịch vụ từ xa của API proxy. Xem thêm phần 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]

Thông số

Thông số Tỷ lệ hiển thị Được dùng với 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 của 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ể kéo trực tiếp các tham số đó từ tệp cấu hình. Xem phần Sử dụng lựa chọn ‑‑config.
-e,
‑‑environment 		Bắt buộc Tất cả (Chuỗi) Một 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 Khoá có trong ứng dụng nhà phát triển Apigee như mô tả trong phần Cách lấy khoá API.
‑‑insecure Không bắt buộc Tất cả Cho phép các kết nối máy chủ không an toàn khi sử dụng SSL.
‑‑legacy Bắt buộc Chỉ có trên Edge Public Cloud Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge cho Đám mây công cộng. Đặt URL quản lý và thời gian chạy cho Apigee Edge cho Đám mây công cộng.
‑‑opdk Bắt buộc Chỉ dành cho Edge Private Cloud Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge cho Private Cloud.
-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 của tổ chức.
-r,
‑‑runtime 		Bắt buộc Chỉ dành cho Edge Private Cloud và Apigee hybrid (Chuỗi) Chỉ định URL thời gian chạy cho Đám mây riêng hoặc phiên bản kết hợp 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 Apigee dành cho nhà phát triển như mô tả trong phần Cách lấy khoá API.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Không bắt buộc Chỉ có trên Edge Private Cloud (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,
‑‑verbose 		Không bắt buộc Tất cả (Không bắt buộc) Tạo đầu ra 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 một mã thông báo JST có dạng 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]

Thông số

Thông số

Thông số Tỷ lệ hiển thị Được dùng với 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 của 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ể kéo trực tiếp các tham số đó từ tệp cấu hình. Xem phần Sử dụng lựa chọn ‑‑config.
-e,
‑‑environment 		Bắt buộc Tất cả (Chuỗi) Một 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 các kết nối máy chủ không an toàn khi sử dụng SSL.
‑‑legacy Bắt buộc Chỉ có trên Edge Public Cloud Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge cho Đám mây công cộng. Đặt URL quản lý và thời gian chạy cho Apigee Edge cho Đám mây công cộng.
‑‑opdk Bắt buộc Chỉ dành cho Edge Private Cloud Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge cho Private Cloud.
-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 của tổ chức.
-r,
‑‑runtime 		Bắt buộc Chỉ dành cho Edge Private Cloud và Apigee hybrid (Chuỗi) Chỉ định URL thời gian chạy cho Đám mây riêng hoặc phiên bản kết hợp 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ỉ có trên Edge Private Cloud (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,
‑‑verbose 		Không bắt buộc Tất cả (Không bắt buộc) Tạo đầu ra 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 vòng mã thông báo JWT

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

Thông số

Thông số Tỷ lệ hiển thị Được dùng với 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 của 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ể kéo trực tiếp các tham số đó từ tệp cấu hình. Xem phần Sử dụng lựa chọn ‑‑config.
-e,
‑‑environment 		Bắt buộc Tất cả (Chuỗi) Một môi trường trong tổ chức của bạn.
-h,
‑‑help 		Không bắt buộc Chỉ dành cho Đám mây công cộng và Đám mây riêng tư của Edge Hiện thông tin trợ giúp về các tham số lệnh.
--k, --key Bắt buộc Chỉ dành cho Đám mây công cộng và Đám mây riêng tư của Edge (Chuỗi) Khoá cung cấp.
‑‑insecure Không bắt buộc Chỉ dành cho Đám mây công cộng và Đám mây riêng tư của Edge Cho phép các kết nối máy chủ không an toàn khi sử dụng SSL.
‑‑legacy Bắt buộc Chỉ có trên Edge Public Cloud Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge cho Đám mây công cộng. Đặt URL quản lý và thời gian chạy cho Apigee Edge cho Đám mây công cộng.
‑‑opdk Bắt buộc Chỉ dành cho Edge Private Cloud Bạn phải đặt cờ này nếu đang sử dụng Apigee Edge cho Private Cloud.
-o,
‑‑organization 		Bắt buộc Chỉ dành cho Đám mây công cộng và Đám mây riêng tư của Edge (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 Edge Private Cloud (Chuỗi) Chỉ định URL thời gian chạy cho Đám mây riêng hoặc phiên bản kết hợp 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) Khoá bí mật cung cấp.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Không bắt buộc Chỉ có trên Edge Private Cloud (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ữ 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 đầu ra 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]

Thông số

Thông số

Thông số Tỷ lệ hiển thị Được dùng với sản phẩm Mô tả
-c,
‑‑config 		Bắt buộc Chỉ có Apigee Hybrid (Chuỗi) Đường dẫn đến tệp cấu hình Dịch vụ từ xa của 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ể kéo trực tiếp các tham số đó từ tệp cấu hình. Xem phần Sử dụng lựa chọn ‑‑config.
-d,
‑‑duration 		Bắt buộc Chỉ có Apigee Hybrid (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,
‑‑environment 		Bắt buộc Chỉ có Apigee Hybrid (Chuỗi) Một môi trường trong tổ chức của bạn.
-h,
‑‑help 		Không bắt buộc Chỉ có Apigee Hybrid Hiện thông tin trợ giúp về các tham số lệnh.
‑‑insecure Không bắt buộc Chỉ có Apigee Hybrid Cho phép các kết nối máy chủ không an toàn khi sử dụng SSL.
-o,
‑‑organization 		Bắt buộc Chỉ có Apigee Hybrid (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ỉ có Apigee Hybrid (Chuỗi) Chỉ định URL thời gian chạy cho phiên bản kết hợp 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ỉ có Apigee Hybrid (Không bắt buộc) Tạo đầu ra chi tiết.

Lệnh phiên bản

In phiên bản CLI.

apigee-remote-service-cli version

Sử dụng .netrc cho thông tin đăng nhập

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 chính nếu bạn đang sử dụng Đám mây công khai Edge và có một mục cho máy api.enterprise.apigee.com. Nếu bạn đang sử dụng Apigee Private Cloud, 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 abc123
Ví dụ: trên Đám mây riêng tư Edge: 
machine http://192.162.55.100
login jdoe@google.com
password abc123

Sử dụng lựa chọn lệnh ‑‑config

Lựa 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 lựa chọn này là bạn có thể 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ả các lựa 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