本頁面由 Cloud Translation API 翻譯而成。

參考資料

本頁內容適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

apigee-remote-service-cli 指令列介面 (CLI) 可協助您佈建及管理 Apigee Adapter for Envoy。

繫結指令

繫結會將部署至 Istio 網格的服務與 Apigee API 產品建立關聯。您可以使用 CLI 建立、移除及列出繫結。

注意：在「建立產品」使用者介面中，您可以為產品指定一或多項服務。這等同於使用 CLI 建立繫結。

新增繫結

將遠端目標繫結新增至 API 產品。

用量

Apigee Hybrid：

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -t [token]

參數

參數	類型	說明
`-c, --config`	String	(必要) Apigee 遠端服務設定檔的路徑。提示：指定這個選項時，您可以省略大部分其他指令參數。請參閱「使用 `--config` 選項」。
`-e, --env`	String	(必填) 貴機構中的環境。
`-h, --help`		顯示指令參數的說明。
`--insecure`		使用 SSL 時允許不安全的伺服器連線
`--legacy`		如果您使用 Apigee Cloud，請設定這個旗標。並設定 Edge Cloud 的管理和執行階段網址。
`--opdk`		如果您使用 Apigee for Private Cloud，請設定這個旗標。
`-o, --org`	String	(必要) Apigee 機構。您必須是機構管理員。
`-p, --password`	String	(僅限基本驗證) 您的 Apigee 密碼。您也可以視需要使用 `.netrc` 檔案指定密碼。如果這麼做，您就不需要在指令列上提供密碼。另請參閱「使用 .netrc 取得憑證」。
`-r, --runtime`	String	Apigee 執行階段基準網址 (Hybrid 或 opdk 必須提供)。
`-t, --token`	String	(僅限 OAuth 權杖驗證) 您從 Apigee 帳戶資訊產生的 OAuth 或 SAML 權杖。如要瞭解如何產生權杖，請參閱「取得 OAuth 2.0 存取權杖」和「SAML 總覽」。
`-u, --username`	String	(僅限基本驗證) 您的 Apigee 使用者名稱 (通常是電子郵件地址)。您也可以在 `.netrc` 檔案中指定使用者名稱。如果這麼做，您就不需要在指令列上提供使用者名稱。另請參閱「使用 .netrc 取得憑證」。
`-v, --verbose`		(選用) 產生詳細輸出內容。

範例

./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

列出繫結

列出繫結至遠端服務的所有 API 產品。

用量

參數

參數	類型	說明
`-c, --config`	String	(必要) Apigee 遠端服務設定檔的路徑。提示：指定這個選項時，您可以省略大部分其他指令參數。請參閱「使用 `--config` 選項」。
`-e, --env`	String	(必填) 貴機構中的環境。
`-h, --help`		顯示指令參數的說明。
`--insecure`		使用 SSL 時允許不安全的伺服器連線
`--legacy`		如果您使用 Apigee Cloud，請設定這個旗標。並設定 Edge Cloud 的管理和執行階段網址。
`--opdk`		如果您使用 Apigee for Private Cloud，請設定這個旗標。
`-o, --org`	String	(必要) Apigee 機構。您必須是機構管理員。
`-p, --password`	String	(僅限基本驗證) 您的 Apigee 密碼。您也可以視需要使用 `.netrc` 檔案指定密碼。如果這麼做，您就不需要在指令列上提供密碼。另請參閱「使用 .netrc 取得憑證」。
`-r, --runtime`	String	Apigee 執行階段基準網址 (Hybrid 或 opdk 必須提供)。
`-t, --token`	String	(僅限 OAuth 權杖驗證) 您從 Apigee 帳戶資訊產生的 OAuth 或 SAML 權杖。如要瞭解如何產生權杖，請參閱「取得 OAuth 2.0 存取權杖」和「SAML 總覽」。
`-u, --username`	String	(僅限基本驗證) 您的 Apigee 使用者名稱 (通常是電子郵件地址)。您也可以在 `.netrc` 檔案中指定使用者名稱。如果這麼做，您就不需要在指令列上提供使用者名稱。另請參閱「使用 .netrc 取得憑證」。
`-v, --verbose`		(選用) 產生詳細輸出內容。

範例

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:

移除繫結

從 API 產品中移除 Envoy 的 Remote Service 繫結。

注意：您也可以從 UI 中的產品移除服務名稱，藉此移除 Envoy 繫結的遠端服務。

用量

Apigee Hybrid：

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -t [token]

參數

參數	類型	說明
`-c, --config`	String	(必要) Apigee 遠端服務設定檔的路徑。提示：指定這個選項時，您可以省略大部分其他指令參數。請參閱「使用 `--config` 選項」。
`-e, --env`	String	(必填) 貴機構中的環境。
`-h, --help`		顯示指令參數的說明。
`--insecure`		使用 SSL 時允許不安全的伺服器連線
`--legacy`		如果您使用 Apigee Cloud，請設定這個旗標。並設定 Edge Cloud 的管理和執行階段網址。
`--opdk`		如果您使用 Apigee for Private Cloud，請設定這個旗標。
`-o, --org`	String	(必要) Apigee 機構。您必須是機構管理員。
`-p, --password`	String	(僅限基本驗證) 您的 Apigee 密碼。您也可以視需要使用 `.netrc` 檔案指定密碼。如果這麼做，您就不需要在指令列上提供密碼。另請參閱「使用 .netrc 取得憑證」。
`-r, --runtime`	String	Apigee 執行階段基準網址 (Hybrid 或 opdk 必須提供)。
`-t, --token`	String	(僅限 OAuth 權杖驗證) 您從 Apigee 帳戶資訊產生的 OAuth 或 SAML 權杖。如要瞭解如何產生權杖，請參閱「取得 OAuth 2.0 存取權杖」和「SAML 總覽」。
`-u, --username`	String	(僅限基本驗證) 您的 Apigee 使用者名稱 (通常是電子郵件地址)。您也可以在 `.netrc` 檔案中指定使用者名稱。如果這麼做，您就不需要在指令列上提供使用者名稱。另請參閱「使用 .netrc 取得憑證」。
`-v, --verbose`		(選用) 產生詳細輸出內容。

範例

./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

說明指令

所有 apigee-remote-service-cli 指令都有線上說明。只要輸入：

apigee-remote-service-cli help

如需任何指令的說明，請輸入：

apigee-remote-service-cli [command] help

例如：

apigee-remote-service-cli provision help

佈建指令

apigee-remote-service-cli provision 指令會在 Apigee 機構中安裝 Proxy、設定憑證，並產生設定 Apigee Adapter for Envoy 時所需的憑證。

用量

參數

參數	類型	說明
`-c, --config`	String	Apigee Remote Service 設定檔的路徑。提示：指定這個選項時，您可以省略大部分其他指令參數。請參閱「使用 `--config` 選項」。
`-e, --environment`	String	(必填) 貴機構中的環境。
`-f, --force-proxy-install`		(選用) 如果機構已安裝 `remote-service` Proxy，這個選項會強制重新安裝。升級注意事項：如要升級至 v1.0-beta.4 或更新版本，您必須加入 `--force-proxy-install` 標記，才能替換部署在 Apigee 的現有遠端服務 Proxy。
`-h, --help`		顯示指令參數的說明。
`-k, --key`	String	指定從 `apigee-remote-service-cli provision` 指令傳回的金鑰。
`--legacy`		Apigee Edge (設定管理和執行階段網址)
`-m, --management`	String	(如果您使用 Apigee Private Cloud，則為必填) 您的 Apigee 管理基本網址。預設值：`https://api.enterprise.apigee.com`
`-n, --namespace`	String	在指定命名空間中，將設定發布為 Envoy ConfigMap。
`--opdk`	String	Apigee OPDK。
`-o, --organization`	String	(必填) 您的 Apigee 機構。您必須是機構管理員。
`-p, --password`	String	(僅限基本驗證) 您的 Apigee 密碼。您也可以視需要使用 `.netrc` 檔案指定密碼。如果這麼做，您就不需要在指令列上提供密碼。另請參閱「使用 .netrc 取得憑證」。
`--rotate-int`	int	如果 n > 0，請產生新的私密金鑰，並保留 n 個公開金鑰 (僅限混合式)
`-r, --runtime`	String	Apigee 執行階段基準網址 (Hybrid 或 OPDK 必須提供)
`-s, --secret`	String	指定 `apigee-remote-service-cli provision` 指令傳回的密碼。
`--strength`	int	(選用) 指定用於佈建介面的 SSL 憑證加密強度。預設值 2048
`-t, --token`	String	(僅限 Hybrid) Apigee OAuth 或 SAML 權杖。
`-u, --username`	String	(僅限基本驗證) 您的 Apigee 使用者名稱 (通常是電子郵件地址)。您也可以在 `.netrc` 檔案中指定使用者名稱。另請參閱「使用 .netrc 取得憑證」。
`-v, --verbose`		(選用) 產生詳細輸出內容。
`--virtual-hosts`	String	覆寫預設虛擬主機。
`--years`	int	(選用) 佈建作業使用的 SSL 憑證到期前剩餘的年數。預設值：1

範例

請務必將 provision 指令的輸出內容擷取到檔案中，做為其他 Apigee Adapter for Envoy 作業的輸入內容。

Apigee Hybrid 範例：

apigee-remote-service-cli provision --organization $ORG --environment $ENV --runtime $RUNTIME --namespace $NAMESPACE --token $TOKEN > config.yaml

權杖指令

您可以使用 JWT 權杖發出經過驗證的 API Proxy 呼叫，不必使用 API 金鑰。權杖指令可讓您建立、檢查及輪替 JWT 權杖，以達到這個目的。

建立 JWT 權杖

您可以使用 JWT 權杖，對遠端服務目標進行經過驗證的 API Proxy 呼叫。另請參閱使用以 JWT 為基礎的驗證機制。

用量

Apigee Hybrid：

apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]

參數

參數	類型	說明
`-c, --config`	String	(必要) Apigee 遠端服務設定檔的路徑。提示：指定這個選項時，您可以省略大部分其他指令參數。請參閱「使用 `--config` 選項」。
`-e, --env`	String	(必填) 貴機構中的環境。
`-h, --help`		顯示指令參數的說明。
`--insecure`		使用 SSL 時允許不安全的伺服器連線。
`-o, --org`	String	(必要) Apigee 機構。您必須是機構管理員。
`-r, --runtime`	String	Apigee 執行階段基準網址 (僅適用於 Hybrid 或 OPDK)。
`-v, --verbose`		(選用) 產生詳細輸出內容。

範例

apigee-remote-service-cli token create -o myorg -e test -i YUmlZAcBKNsTAelJqPZFl3sh58ObATX9 -s icTARgaKHqvUH1dq -c config.yaml

輸出

成功後，您會看到類似下列的 JST 權杖輸出內容：

eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q

檢查 JWT 權杖

您可以使用這個指令檢查 JWT 權杖。另請參閱「檢查權杖」。

用量

Apigee Hybrid：

apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]

參數

參數	類型	說明
`-c, --config`	String	(必要) Apigee 遠端服務設定檔的路徑。提示：指定這個選項時，您可以省略大部分其他指令參數。請參閱「使用 `--config` 選項」。
`-e, --env`	String	(必填) 貴機構中的環境。
`-h, --help`		顯示指令參數的說明。
`--insecure`		使用 SSL 時允許不安全的伺服器連線。
`-o, --org`	String	(必要) Apigee 機構。您必須是機構管理員。
`-r, --runtime`	String	Apigee 執行階段基準網址 (僅適用於 Hybrid 或 OPDK)。
`-v, --verbose`		(選用) 產生詳細輸出內容。

範例

apigee-remote-service-cli token inspect -c config.yaml <<< $TOKEN

輸出

成功後，您會看到類似以下的輸出內容：

{
	"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.

輪替 JWT 權杖

在您首次產生 JWT 後，可能需要變更 Apigee 儲存在加密鍵/值對應 (KVM) 中的公開/私密金鑰組。這個產生新金鑰組的過程稱為金鑰輪替。輪替金鑰時，系統會產生新的私密/公開金鑰組，並儲存在 Apigee 機構/環境的「istio」KVM 中。此外，系統會保留舊公開金鑰及其原始金鑰 ID 值。

用量

參數

參數	類型	說明
`-c, --config`	String	(必要) Apigee 遠端服務設定檔的路徑。提示：指定這個選項時，您可以省略大部分其他指令參數。請參閱「使用 `--config` 選項」。
`-e, --env`	String	(必填) 貴機構中的環境。
`-h, --help`		顯示指令參數的說明。
`--insecure`		使用 SSL 時允許不安全的伺服器連線
`--truncate`	int	要在 jwks 中保留的憑證數量 (預設為 2)
`-o, --org`	String	(必要) Apigee 機構。您必須是機構管理員。
`-r, --runtime`	String	Apigee 執行階段基準網址 (Hybrid 或 opdk 必須提供)。
`-v, --verbose`		(選用) 產生詳細輸出內容。

範例

apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test -k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 -s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08

輸出

certificate successfully rotated

使用 .netrc 取得憑證

apigee-remote-service-cli會自動從主目錄中的 .netrc 檔案擷取 username 和 password (視需要進行基本驗證)，前提是您使用 Apigee，且機器 api.enterprise.apigee.com 有項目。passwordapi.enterprise.apigee.com如果您使用 Apigee 私有雲，機器值與 management 網址相同 (例如：http://192.162.55.100)。

版本指令

列印 CLI 版本。

apigee-remote-service-cli version

使用 `--config` 指令選項

--config 選項會指定 provision 指令產生的設定檔位置。這個選項的實用優點是，您可以略過大部分其他指令參數，CLI 會從設定檔中提取這些參數。這些選項包括：

組織
環境
執行階段
管理
不安全
命名空間
舊版
opdk

舉例來說，您可以執行類似下列的 provision 指令：

apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml

設定檔

本節會顯示設定檔範例，其中包含所有可用選項。

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

參考資料 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

繫結指令

新增繫結

用量

參數

範例

列出繫結

用量

參數

範例

移除繫結

用量

參數

範例

說明指令

佈建指令

用量

參數

範例

權杖指令

建立 JWT 權杖

用量

參數

範例

輸出

檢查 JWT 權杖

用量

參數

範例

輸出

輪替 JWT 權杖

用量

參數

範例

輸出

使用 .netrc 取得憑證

版本指令

使用 --config 指令選項

設定檔

參考資料

使用 `--config` 指令選項