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 cấp và quản lý Trình chuyển đổi Apigee cho Envoy.
Lệnh liên kết
Liên kết liên kết một dịch vụ được triển khai cho mạng lưới Istio với một sản phẩm API Apigee. CLI cho phép bạn tạo, xoá và các liên kết danh sách.
Lưu ý: Trong giao diện người dùng Tạo sản phẩm, bạn có thể chỉ định một hoặc nhiều dịch vụ cho một sản phẩm. Việc này tương đương với việc tạo liên kết bằng CLI.Thêm mối liên kết
Thêm liên kết mục tiêu từ xa vào một sản phẩm API.
Cách sử dụng
Đối với Edge Public Cloud:
apigee-remote-service-cli bindings add [service_name] [product_name] -o [organization] -e [environment] -u [username] -p [password] -c [config]
Đối với Edge Private Cloud:
apigee-remote-service-cli bindings add [service_name] [product_name] -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]
Đối với Apigee Hybrid:
apigee-remote-service-cli bindings add [service_name] [product_name] -o [organization] -e [environment] -t [token]
Thông số
Thông số | Loại | Mô tả |
---|---|---|
-c, --config
|
Chuỗi | (Bắt buộc) Đường dẫn đến tệp cấu hình Dịch vụ từ xa Apigee. Lưu ý: Khi bạn chỉ định
tuỳ chọn này, bạn có thể bỏ qua hầu hết các tham số lệnh khác. Xem phần Sử dụng tuỳ chọn --config .
|
-e, --env
|
Chuỗi | (Bắt buộc) Môi trường trong tổ chức của bạn. |
-h, --help
|
Hiện thông tin trợ giúp về các tham số lệnh. | |
--insecure
|
Cho phép kết nối với máy chủ không an toàn khi sử dụng SSL | |
--legacy
|
Thiết lập cờ này nếu bạn đang sử dụng Apigee Edge Cloud. Chế độ này thiết lập URL quản lý và thời gian chạy cho Edge Cloud. | |
--opdk
|
Thiết lập cờ này nếu bạn đang sử dụng Apigee Edge cho Đám mây riêng tư. | |
-o, --org
|
Chuỗi | (Bắt buộc) Một tổ chức Apigee. Bạn phải là quản trị viên tổ chức. |
-p, --password
|
Chuỗi | (Chỉ bắt buộc đối với phương thức xác thực cơ bản) 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 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.
|
-r, --runtime
|
Chuỗi | URL cơ sở của môi trường thời gian chạy Apigee (bắt buộc đối với môi trường kết hợp hoặc opdk). |
-t, --token
|
Chuỗi | (Chỉ bắt buộc đối với xác thực mã thông báo OAuth) 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. Để biết thông tin về cách tạo mã thông báo, hãy xem Sử dụng get_token và Truy cập API quản lý bằng SAML. |
-u, --username
|
Chuỗi | (Chỉ bắt buộc đối với phương thức xác thực cơ bản) 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ạo đầu ra chi tiết. |
Ví dụ:
./apigee-remote-service-cli bindings add httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx product envoy-test is now bound to: httpbin.org
Liên kết danh sách
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
Đối với Edge Public Cloud:
apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password]
Đối với Cloud Private Cloud:
apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password] -r [runtime]
Thông số
Thông số | Loại | Mô tả |
---|---|---|
-c, --config
|
Chuỗi | (Bắt buộc) Đường dẫn đến tệp cấu hình Dịch vụ từ xa Apigee. Lưu ý: Khi bạn chỉ định
tuỳ chọn này, bạn có thể bỏ qua hầu hết các tham số lệnh khác. Xem phần Sử dụng tuỳ chọn --config .
|
-e, --env
|
Chuỗi | (Bắt buộc) Môi trường trong tổ chức của bạn. |
-h, --help
|
Hiện thông tin trợ giúp về các tham số lệnh. | |
--insecure
|
Cho phép kết nối với máy chủ không an toàn khi sử dụng SSL | |
--legacy
|
Thiết lập cờ này nếu bạn đang sử dụng Apigee Edge Cloud. Chế độ này thiết lập URL quản lý và thời gian chạy cho Edge Cloud. | |
--opdk
|
Thiết lập cờ này nếu bạn đang sử dụng Apigee Edge cho Đám mây riêng tư. | |
-o, --org
|
Chuỗi | (Bắt buộc) Một tổ chức Apigee. Bạn phải là quản trị viên tổ chức. |
-p, --password
|
Chuỗi | (Chỉ bắt buộc đối với phương thức xác thực cơ bản) 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 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.
|
-r, --runtime
|
Chuỗi | URL cơ sở của môi trường thời gian chạy Apigee (bắt buộc đối với môi trường kết hợp hoặc opdk). |
-t, --token
|
Chuỗi | (Chỉ bắt buộc đối với xác thực mã thông báo OAuth) 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. Để biết thông tin về cách tạo mã thông báo, hãy xem Sử dụng get_token và Truy cập API quản lý bằng SAML. |
-u, --username
|
Chuỗi | (Chỉ bắt buộc đối với phương thức xác thực cơ bản) 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ạ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 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:
Xoá một liên kết
Xoá mối liên kết của Dịch vụ từ xa dành cho Envoy khỏi một sản phẩm API.
Lưu ý: Bạn cũng có thể xoá một Dịch vụ từ xa dành cho liên kết Envoy bằng cách xoá tên dịch vụ khỏi sản phẩm trong giao diện người dùng Edge.Cách sử dụng
Đối với Edge Public Cloud:
apigee-remote-service-cli bindings remove [service_name] [product_name] -o [organization] -e [environment] -u [username] -p [password] -c [config]
Đối với Edge Private Cloud:
apigee-remote-service-cli bindings remove [service_name] [product_name] -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]
Đối với Apigee Hybrid:
apigee-remote-service-cli bindings remove [service_name] [product_name] -o [organization] -e [environment] -t [token]
Thông số
Thông số | Loại | Mô tả |
---|---|---|
-c, --config
|
Chuỗi | (Bắt buộc) Đường dẫn đến tệp cấu hình Dịch vụ từ xa Apigee. Lưu ý: Khi bạn chỉ định
tuỳ chọn này, bạn có thể bỏ qua hầu hết các tham số lệnh khác. Xem
Sử dụng tuỳ chọn --config .
|
-e, --env
|
Chuỗi | (Bắt buộc) Môi trường trong tổ chức của bạn. |
-h, --help
|
Hiện thông tin trợ giúp về các tham số lệnh. | |
--insecure
|
Cho phép kết nối với máy chủ không an toàn khi sử dụng SSL | |
--legacy
|
Thiết lập cờ này nếu bạn đang sử dụng Apigee Edge Cloud. Chế độ này thiết lập URL quản lý và thời gian chạy cho Edge Cloud. | |
--opdk
|
Thiết lập cờ này nếu bạn đang sử dụng Apigee Edge cho Đám mây riêng tư. | |
-o, --org
|
Chuỗi | (Bắt buộc) Một tổ chức Apigee. Bạn phải là quản trị viên tổ chức. |
-p, --password
|
Chuỗi | (Chỉ bắt buộc đối với phương thức xác thực cơ bản) 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 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.
|
-r, --runtime
|
Chuỗi | URL cơ sở của môi trường thời gian chạy Apigee (bắt buộc đối với môi trường kết hợp hoặc opdk). |
-t, --token
|
Chuỗi | (Chỉ bắt buộc đối với xác thực mã thông báo OAuth) 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. Để biết thông tin về cách tạo mã thông báo, hãy xem Sử dụng get_token và Truy cập API quản lý bằng SAML. |
-u, --username
|
Chuỗi | (Chỉ bắt buộc đối với phương thức xác thực cơ bản) 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ạo kết quả chi tiết. |
Ví dụ:
./apigee-remote-service-cli bindings remove httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx product envoy-test is no longer bound to: httpbin.org
Lệnh trợ giúp
Hỗ trợ 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 cấp phép
Lệnh apigee-remote-service-cli provision
sẽ cài đặt một proxy trong tổ chức Apigee Edge, thiết lập một chứng chỉ và tạo thông tin xác thực mà bạn cần để định cấu hình Trình chuyển đổi Apigee cho Envoy.
Cách sử dụng
Nếu bạn đang sử dụng Edge Public Cloud:
apigee-remote-service-cli provision -o $ORG -e $ENV -u $USERNAME -p $PASSWORD
Nếu bạn đang sử dụng Edge Private Cloud:
apigee-remote-service-cli provision --opdk -o $ORG -e $ENV -u $USERNAME --management $MGMT_SERVER_URL --runtime $RUNTIME_URL -p $PASSWORD
Thông số
Thông số | Loại | Mô tả |
---|---|---|
-c, --config
|
Chuỗi | Đường dẫn đến tệp cấu hình Dịch vụ từ xa Apigee. Lưu ý: Khi bạn chỉ định
tuỳ chọn này, bạn có thể bỏ qua hầu hết các tham số lệnh khác. Xem
Sử dụng tuỳ chọn --config .
|
-e, --environment
|
Chuỗi | (Bắt buộc) Một môi trường trong tổ chức của bạn. |
-f, --force-proxy-install
|
(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
|
Hiện thông tin trợ giúp về các tham số lệnh. | |
-k, --key
|
Chuỗi | Chỉ định khoá được trả về từ
lệnh apigee-remote-service-cli provision .
|
--legacy
|
SaaS SaaS (tính năng quản lý nhóm và URL thời gian chạy) | |
-m, --management
|
Chuỗi | (Bắt buộc nếu bạn đang sử dụng Apigee Private Cloud) URL cơ sở quản lý Apigee của bạn.
Mặc định: https://api.enterprise.apigee.com
|
-n, --namespace
|
Chuỗi | phát hành cấu hình dưới dạng Envoy ConfigMap trong không gian tên được chỉ định. |
--opdk
|
Chuỗi | Nhóm OPDK của Apigee. |
-o, --organization
|
Chuỗi | (Bắt buộc) Tổ chức Apigee của bạn. Bạn phải là quản trị viên tổ chức. |
-p, --password
|
Chuỗi | (Chỉ bắt buộc đối với phương thức xác thực cơ bản) 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 phải cung cấp mật khẩu trên dòng lệnh. Xem thêm
Sử dụng .netrc làm thông tin đăng nhập.
|
--rotate-int
|
int | 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
|
Chuỗi | URL cơ sở của môi trường thời gian chạy Apigee (bắt buộc đối với loại kết hợp hoặc opdk) |
-s, --secret
|
Chuỗi | Chỉ định khoá bí mật được trả về từ apigee-remote-service-cli provision
.
|
--strength
|
int | (Không bắt buộc) Chỉ định độ mạnh mã hóa cho các chứng chỉ SSL được sử dụng trong việc cấp phép bộ chuyển đổi. Mặc định 2048 |
-t, --token
|
Chuỗi | (Chỉ kết hợp) Mã thông báo OAuth hoặc SAML cho Apigee. |
-u, --username
|
Chuỗi | (Chỉ bắt buộc đối với phương thức xác thực cơ bản) 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 bài viết Sử dụng .netrc làm thông tin đăng nhập.
|
-v, --verbose
|
(Không bắt buộc) Tạo kết quả chi tiết. | |
--virtual-hosts
|
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. Xem Tài liệu Edge để tìm hiểu về máy chủ ảo. |
--years
|
int | (Không bắt buộc) Số năm trước khi chứng chỉ SSL dùng trong quá trình cấp phép hết hạn. Mặc định: 1 |
Ví dụ:
Hãy nhớ ghi lại kết quả của lệnh provision
trong một tệp, tệp được sử dụng
làm dữ liệu đầu vào cho các hoạt động khác của Bộ chuyển đổi Apigee dành cho Envoy.
Ví dụ về Edge Public Cloud:
apigee-remote-service-cli provision --legacy --username $USER --password $PASSWORD --organization $ORG --environment $ENV > config.yaml
Ví dụ về kết hợp Apigee:
apigee-remote-service-cli provision --organization $ORG --environment $ENV --runtime $RUNTIME --namespace $NAMESPACE --token $TOKEN > config.yaml
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 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
Đối với Edge Public Cloud:apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -o [org] -e [env]Đối với Cloud Private Cloud:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]Đối với ứng dụng kết hợp Apigee:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]
Thông số
Thông số | Loại | Mô tả |
---|---|---|
-c, --config
|
Chuỗi | (Bắt buộc) Đường dẫn đến tệp cấu hình Dịch vụ từ xa Apigee. Lưu ý: Khi bạn chỉ định
tuỳ chọn này, bạn có thể bỏ qua hầu hết các tham số lệnh khác. Xem phần Sử dụng tuỳ chọn --config .
|
-e, --env
|
Chuỗi | (Bắt buộc) Môi trường trong tổ chức của bạn. |
-h, --help
|
Hiện thông tin trợ giúp về các tham số lệnh. | |
--insecure
|
Cho phép kết nối máy chủ không an toàn khi sử dụng SSL. | |
-o, --org
|
Chuỗi | (Bắt buộc) Một tổ chức Apigee. Bạn phải là quản trị viên tổ chức. |
-r, --runtime
|
Chuỗi | URL cơ sở của thời gian chạy Apigee (chỉ bắt buộc đối với chế độ kết hợp hoặc o nhé). |
-v, --verbose
|
(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
Đối với Edge Public Cloud:apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file]Đối với Cloud Private Cloud:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]Đối với ứng dụng kết hợp Apigee:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]
Thông số
Thông số | Loại | Mô tả |
---|---|---|
-c, --config
|
Chuỗi | (Bắt buộc) Đường dẫn đến tệp cấu hình Dịch vụ từ xa của Apigee. Mẹo: Khi chỉ định tuỳ chọn này, bạn có thể bỏ qua hầu hết các tham số lệnh khác. Xem
Sử dụng tuỳ chọn --config .
|
-e, --env
|
Chuỗi | (Bắt buộc) Môi trường trong tổ chức của bạn. |
-h, --help
|
Hiện thông tin trợ giúp về các tham số lệnh. | |
--insecure
|
Cho phép kết nối máy chủ không an toàn khi sử dụng SSL. | |
-o, --org
|
Chuỗi | (Bắt buộc) Một tổ chức Apigee. Bạn phải là quản trị viên tổ chức. |
-r, --runtime
|
Chuỗi | URL cơ sở của thời gian chạy Apigee (chỉ bắt buộc đối với chế độ kết hợp hoặc o nhé). |
-v, --verbose
|
(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
Nếu 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
Vào một thời điểm nào đó sau khi tạo JWT ban đầu, bạn có thể cần thay đổi cặp khoá công khai/riêng tư do Apigee Edge lưu trữ trong bản đồ khoá-giá trị đã mã hoá (KVM). 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 Edge. 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
Nếu bạn đang sử dụng Edge Public Cloud:apigee-remote-service-cli token rotate-cert -c [config_file] -o [organization] -e [environment] -k [provision_key] -s [provision_secret] --kid [new_key_id]Nếu bạn đang sử dụng Edge Private Cloud:
apigee-remote-service-cli token rotate-cert -o [organization] -e [environment] -u [username] -p [password] -k [provision_key] -s [provision_secret] --kid [new_key_id]
Thông số
Thông số | Loại | Mô tả |
---|---|---|
-c, --config
|
Chuỗi | (Bắt buộc) Đường dẫn đến tệp cấu hình Dịch vụ từ xa Apigee. Lưu ý: Khi bạn chỉ định
tuỳ chọn này, bạn có thể bỏ qua hầu hết các tham số lệnh khác. Xem
Sử dụng tuỳ chọn --config .
|
-e, --env
|
Chuỗi | (Bắt buộc) Môi trường trong tổ chức của bạn. |
-h, --help
|
Hiện thông tin trợ giúp về các tham số lệnh. | |
--insecure
|
Cho phép kết nối với máy chủ không an toàn khi sử dụng SSL | |
--truncate
|
int | Số lượng chứng chỉ cần giữ trong jwk (mặc định là 2) |
-o, --org
|
Chuỗi | (Bắt buộc) Một tổ chức Apigee. Bạn phải là quản trị viên tổ chức. |
-r, --runtime
|
Chuỗi | URL cơ sở của thời gian chạy Apigee (bắt buộc đối với chế độ kết hợp hoặc oPE). |
-v, --verbose
|
(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
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 Apigee Private Cloud, giá trị máy sẽ giống với URL management
(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
Lệnh Phiên bản
In phiên bản CLI.
apigee-remote-service-cli version
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
. Một lợi ích hữu ích của lựa 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 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 allow_unverified_ssl_cert: false products: refresh_rate: 2m analytics: legacy_endpoint: false file_limit: 1024 send_channel_size: 10 collection_interval: 10s fluentd_endpoint: apigee-udca-myorg-test.apigee.svc.cluster.local:20001 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 auth: api_key_claim: claim api_key_cache_duration: 30m api_key_header: x-api-key api_target_header: :authority reject_unauthorized: true jwks_poll_interval: 0s