Materiały referencyjne

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

apigee-remote-service-cli Interfejs wiersza poleceń (CLI) pomaga udostępniać i zarządzać Apigee Adapter for Envoy.

Polecenie wyświetlania powiązań

Wyświetl listę wszystkich produktów interfejsu API powiązanych z usługą zdalną.

Wykorzystanie

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

Parametry

Parametry Obecność Używane z produktami Opis
-c,
‑‑config 		Wymagane Wszystkie (String) Ścieżka do pliku konfiguracyjnego usługi zdalnej Apigee.
Wskazówka: ta flaga umożliwia pominięcie większości innych parametrów polecenia, ponieważ interfejs wiersza poleceń może pobrać je bezpośrednio z pliku konfiguracyjnego. Zobacz Korzystanie z opcji ‑‑config.
-e,
‑‑environment 		Wymagane Wszystkie (String) Środowisko w Twojej organizacji.
-h,
‑‑help 		Opcjonalny Wszystkie Wyświetla pomoc dotyczącą parametrów polecenia.
‑‑insecure Opcjonalny Wszystkie Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z SSL.
‑‑legacy Wymagane Tylko Edge Public Cloud Jeśli używasz Apigee Edge na platformie Public Cloud, musisz ustawić tę flagę. Ustawia adresy URL zarządzania i środowiska wykonawczego w Apigee Edge na potrzeby chmury publicznej.
-m,
‑‑management 		Wymagane Tylko Edge Private Cloud (Ciąg znaków) Podstawowy adres URL zarządzania instalacją Apigee Edge Private Cloud. Domyślnie: https://api.enterprise.apigee.com
‑‑mfa Wymagane Tylko Edge Public Cloud (Ciąg znaków) Token autoryzacji wieloczynnikowej dla Apigee Edge na platformie Public Cloud. Wymagane tylko wtedy, gdy na koncie Apigee Edge skonfigurowane jest uwierzytelnianie wielopoziomowe.
‑‑opdk Wymagane Tylko Edge Private Cloud Musisz ustawić tę flagę, jeśli używasz Apigee Edge for Private Cloud.
-o,
‑‑organization 		Wymagane Wszystkie (Ciąg znaków) Organizacja Apigee. Musisz być administratorem organizacji.
-p,
‑‑password 		Wymagany
(tylko uwierzytelnianie podstawowe)		 Tylko Edge w chmurze publicznej i prywatnej (String) Hasło do Apigee. Opcjonalnie możesz podać hasło w pliku .netrc. Zobacz też Używanie pliku .netrc do przechowywania danych logowania.
-r,
‑‑runtime 		Wymagane Tylko Edge Private Cloud i Apigee Hybrid (Ciąg) Określa adres URL środowiska wykonawczego instancji chmury prywatnej lub Apigee Hybrid. Adres URL musi zaczynać się od https://. Na przykład: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalny Tylko Edge Private Cloud (String) Określa certyfikat TLS po stronie klienta, klucz prywatny i główny urząd certyfikacji dla połączenia mTLS.
-t,
‑‑token 		Wymagane
(tylko uwierzytelnianie za pomocą tokena OAuth)		 Wszystkie (String) Token OAuth lub SAML wygenerowany na podstawie informacji o koncie Apigee. Zastępuje wszystkie inne podane dane logowania.
-u,
‑‑username 		Wymagany
(tylko uwierzytelnianie podstawowe)		 Tylko Edge w chmurze publicznej i prywatnej (String) Twoja nazwa użytkownika Apigee (zwykle adres e-mail). Opcjonalnie możesz podać nazwę użytkownika w pliku .netrc. W takim przypadku nie musisz podawać nazwy użytkownika w wierszu poleceń. Zobacz też Używanie pliku .netrc do przechowywania danych logowania.
-v,
‑‑verbose 		Opcjonalny Wszystkie (Opcjonalnie) Generuje szczegółowe dane wyjściowe.

Przykład

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

Przykładowe dane wyjściowe 

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:

Polecenie pomocy

Pomoc online jest dostępna w przypadku wszystkich poleceń apigee-remote-service-cli. Wystarczy wpisać:

apigee-remote-service-cli help

Aby uzyskać pomoc dotyczącą dowolnego polecenia, wpisz:

apigee-remote-service-cli [command] help

Na przykład:

apigee-remote-service-cli provision help

Polecenie obsługi administracyjnej

Polecenie apigee-remote-service-cli provision instaluje 2 proxy interfejsu API w organizacji Apigee Edge, konfiguruje certyfikat i generuje dane logowania, które będą potrzebne do skonfigurowania Apigee Adapter for Envoy.

Wykorzystanie

apigee-remote-service-cli provision [flags]

Parametry

Parametry Obecność Używane z produktami Opis
‑‑analytics-sa Opcjonalny Tylko Apigee hybrid i Apigee X

(String) Użyj tego flagi, aby określić ścieżkę do pliku klucza konta usługi Google Cloud, w którym konto usługi ma rolę Apigee Analytics Agent. Konto usługi jest używane przez adapter do bezpośredniego przesyłania danych analitycznych do Apigee. Jeśli używasz Apigee Hybrid, ta opcja umożliwia zainstalowanie środowiska wykonawczego Hybrid w jednym klastrze, a adaptera w innym.
-c,
‑‑config 		Wymagane Wszystkie (String) Ścieżka do pliku konfiguracyjnego usługi zdalnej Apigee.
Wskazówka: ta flaga umożliwia pominięcie większości innych parametrów polecenia, ponieważ interfejs wiersza poleceń może pobrać je bezpośrednio z pliku konfiguracyjnego. Zobacz Korzystanie z opcji ‑‑config.
-e,
‑‑environment 		Wymagane Wszystkie (String) Środowisko w Twojej organizacji.
-f, ‑‑force-proxy-install Opcjonalny Wszystkie (Opcjonalnie) Wymusza ponowną instalację serwera proxy remote-service, jeśli jest on już zainstalowany w Twojej organizacji.
-h,
‑‑help 		Opcjonalny Wszystkie Wyświetla pomoc dotyczącą parametrów polecenia.
‑‑insecure Opcjonalny Wszystkie Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z SSL.
‑‑legacy Wymagane Tylko Edge Public Cloud Jeśli używasz Apigee Edge na platformie Public Cloud, musisz ustawić tę flagę. Ustawia adresy URL zarządzania i środowiska wykonawczego w Apigee Edge na potrzeby chmury publicznej.
-m,
‑‑management 		Wymagane Tylko Edge Private Cloud (Ciąg znaków) Podstawowy adres URL zarządzania instalacją Apigee Edge Private Cloud. Domyślnie: https://api.enterprise.apigee.com
‑‑mfa Wymagane Tylko Edge Public Cloud token autoryzacji wieloskładnikowej dla Apigee Edge na platformie Public Cloud, Wymagane tylko wtedy, gdy na koncie Apigee Edge skonfigurowane jest uwierzytelnianie wielopoziomowe.
-n, ‑‑namespace Opcjonalny Wszystkie (String) Emit configuration as an Envoy ConfigMap in the specified namespace. Domyślnie: apigee
‑‑opdk Wymagane Tylko Edge Private Cloud Musisz ustawić tę flagę, jeśli używasz Apigee Edge for Private Cloud.
-o,
‑‑organization 		Wymagane Wszystkie (Ciąg znaków) Organizacja Apigee. Aby dokonać aprowizacji, musisz być administratorem organizacji.
-p,
‑‑password 		Wymagany
(tylko uwierzytelnianie podstawowe)		 Tylko Edge w chmurze publicznej i prywatnej (String) Hasło do Apigee. Opcjonalnie możesz podać hasło w pliku
.netrc. W takim przypadku nie musisz podawać hasła w wierszu poleceń. Zobacz też Używanie pliku .netrc do przechowywania danych logowania.
‑‑rotate-int Opcjonalny Tylko Apigee Hybrid (Liczba całkowita) Jeśli n > 0, wygeneruj nowy klucz prywatny i zachowaj n kluczy publicznych (tylko w przypadku kluczy hybrydowych).
-r,
‑‑runtime 		Wymagane Tylko Edge Private Cloud i Apigee Hybrid (Ciąg) Określa adres URL środowiska wykonawczego instancji chmury prywatnej lub Apigee Hybrid. Adres URL musi zaczynać się od https://. Na przykład: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalny Tylko Edge Private Cloud (String) Określa certyfikat TLS po stronie klienta, klucz prywatny i główny urząd certyfikacji dla połączenia mTLS.
-t,
‑‑token 		Wymagane
(tylko uwierzytelnianie za pomocą tokena OAuth)		 Wszystkie (String) Token OAuth lub SAML wygenerowany na podstawie informacji o koncie Apigee. Zastępuje wszystkie inne podane dane logowania.
-u,
‑‑username 		Wymagany
(tylko uwierzytelnianie podstawowe)		 Tylko Edge w chmurze publicznej i prywatnej (String) Twoja nazwa użytkownika Apigee (zwykle adres e-mail). Opcjonalnie możesz podać nazwę użytkownika w pliku .netrc. Zobacz też Używanie pliku .netrc do przechowywania danych logowania.
-v,
‑‑verbose 		Opcjonalny Wszystkie (Opcjonalnie) Generuje szczegółowe dane wyjściowe.
‑‑virtual-hosts Opcjonalny Tylko Edge Private Cloud (Ciąg znaków) Zastępuje domyślne hosty wirtualne, które są default,secure. Użyj tej opcji, jeśli masz hosty wirtualne określone dla środowiska organizacji Edge inne niż te domyślne.

Przykład

Jak pokazuje poniższy przykład, ważne jest, aby przechwycić dane wyjściowe polecenia provision w pliku, który jest używany jako dane wejściowe dla innych operacji Apigee Adapter for Envoy.

Przykład: 

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

Polecenie Samples

Tworzy i wyświetla przykładowe pliki konfiguracyjne.

Tworzenie przykładowych plików konfiguracji

Tworzy przykładowe pliki konfiguracji wdrożeń natywnego Envoy i Istio.

Wykorzystanie

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

Opis

To polecenie wymaga prawidłowego pliku config.yaml jako danych wejściowych. Ten plik wejściowy to plik wygenerowany w procesie udostępniania. Domyślnie pliki przykładowe są zapisywane w katalogu o nazwie ./samples. Polecenie utworzy ten katalog.

Jeśli używasz natywnego Envoy, polecenie przyjmuje hosta usługi docelowej i żądaną nazwę klastra. Ustawia też niestandardowe połączenie SSL z serwera proxy Envoy do klastra usługi zdalnej, jeśli folder zawierający tls.key i tls.crt jest podany za pomocą --tls.

Jeśli używasz Istio, gdzie serwer proxy Envoy działa jako sidecar, a cel nie jest określony, zostanie wygenerowany httpbin przykład. W przeciwnym razie ponosisz odpowiedzialność za przygotowanie plików konfiguracyjnych związanych z wdrażaniem usług docelowych.

Parametry

Parametry Obecność Używane z produktami Opis
‑‑adapter‑host Wymagane tylko w przypadku szablonów Envoy Wszystkie (String) Nazwa hosta adaptera (domyślnie: localhost)
-c, ‑‑config Wymagane Wszystkie (String) Ścieżka do pliku konfiguracyjnego usługi zdalnej Apigee.
Wskazówka: ta flaga umożliwia pominięcie większości innych parametrów polecenia, ponieważ interfejs wiersza poleceń może pobrać je bezpośrednio z pliku konfiguracyjnego. Zobacz Korzystanie z opcji ‑‑config.
-f, ‑‑force Opcjonalny Wszystkie Wymuś zastąpienie istniejącego katalogu.
-h, ‑‑help Opcjonalny Wszystkie Wyświetla pomoc dotyczącą parametrów polecenia.
‑‑host Wymagane tylko w przypadku szablonów Envoy Wszystkie (Ciąg znaków) Host usługi docelowej (domyślnie httpbin.org)
-n, ‑‑name Wymagane Wszystkie (String) Nazwa usługi docelowej (domyślnie httpbin.org)
‑‑out Opcjonalny Wszystkie (Ciąg znaków) Katalog, w którym mają zostać utworzone przykładowe pliki konfiguracyjne.
Domyślnie: ./samples
‑‑tag Wymagane tylko w przypadku szablonów Istio Wszystkie (String) Tag wersji obrazu adaptera Envoy. Domyślnie: v2.0.0
-t, ‑‑template Wymagane Wszystkie (String) Nazwa szablonu Envoy lub Istio. Aby wyświetlić listę dostępnych szablonów, wykonaj polecenie apigee-remote-service samples templates.
‑‑tls Opcjonalne, tylko w przypadku szablonów Envoy Wszystkie (String) Katalog zawierający pliki tls.key i tls.crt używane przez usługę adaptera.

Przykład 

apigee-remote-service-cli samples create -c ./config.yaml

Wyświetlanie listy dostępnych opcji szablonu

Wyświetla listę szablonów, których można używać z parametrem --templates w przypadku polecenia samples.

Wykorzystanie

apigee-remote-service-cli samples templates

Parametry

Brak.

Przykład 

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

Polecenia tokena

Zamiast klucza interfejsu API możesz używać tokena JWT do wykonywania uwierzytelnionych wywołań proxy interfejsu API. Polecenia tokenów umożliwiają tworzenie, sprawdzanie i rotację tokenów JWT na potrzeby tego celu.

Tworzenie tokena JWT

Możesz użyć tokena JWT do wykonywania uwierzytelnionych wywołań proxy interfejsu API do zdalnego miejsca docelowego usługi. Zobacz też Uwierzytelnianie przy użyciu tokena JWT.

Wykorzystanie

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

Parametry

Parametry Obecność Używane z produktami Opis
-c,
‑‑config 		Wymagane Wszystkie (String) Ścieżka do pliku konfiguracyjnego usługi zdalnej Apigee.
Wskazówka: ta flaga umożliwia pominięcie większości innych parametrów polecenia, ponieważ interfejs wiersza poleceń może pobrać je bezpośrednio z pliku konfiguracyjnego. Zobacz Korzystanie z opcji ‑‑config.
-e,
‑‑environment 		Wymagane Wszystkie (String) Środowisko w Twojej organizacji.
-h,
‑‑help 		Opcjonalny Wszystkie Wyświetla pomoc dotyczącą parametrów polecenia.
--i, --id Wymagane Wszystkie (String) Dane logowania Klucz znalezione w aplikacji dewelopera Apigee zgodnie z opisem w artykule Jak uzyskać klucz interfejsu API.
‑‑insecure Opcjonalny Wszystkie Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z SSL.
‑‑legacy Wymagane Tylko Edge Public Cloud Jeśli używasz Apigee Edge na platformie Public Cloud, musisz ustawić tę flagę. Ustawia adresy URL zarządzania i środowiska wykonawczego w Apigee Edge na potrzeby chmury publicznej.
‑‑opdk Wymagane Tylko Edge Private Cloud Musisz ustawić tę flagę, jeśli używasz Apigee Edge for Private Cloud.
-o,
‑‑organization 		Wymagane Wszystkie (Ciąg znaków) Organizacja Apigee. Musisz być administratorem organizacji.
-r,
‑‑runtime 		Wymagane Tylko Edge Private Cloud i Apigee Hybrid (Ciąg) Określa adres URL środowiska wykonawczego instancji chmury prywatnej lub Apigee Hybrid. Adres URL musi zaczynać się od https://. Na przykład: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret Wymagane Wszystkie (String) Dane logowania Secret znalezione w aplikacji dewelopera Apigee zgodnie z opisem w artykule Jak uzyskać klucz interfejsu API.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalny Tylko Edge Private Cloud (String) Określa certyfikat TLS po stronie klienta, klucz prywatny i główny urząd certyfikacji dla połączenia mTLS.
-v,
‑‑verbose 		Opcjonalny Wszystkie (Opcjonalnie) Generuje szczegółowe dane wyjściowe.

Przykład

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

Wyniki

Jeśli operacja się powiedzie, zobaczysz token JST podobny do tego: 
eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q

Sprawdzanie tokena JWT

Za pomocą tego polecenia możesz sprawdzić token JWT. Zobacz też Sprawdzanie tokena.

Wykorzystanie

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

Parametry

Parametry

Parametry Obecność Używane z produktami Opis
-c,
‑‑config 		Wymagane Wszystkie (String) Ścieżka do pliku konfiguracyjnego usługi zdalnej Apigee.
Wskazówka: ta flaga umożliwia pominięcie większości innych parametrów polecenia, ponieważ interfejs wiersza poleceń może pobrać je bezpośrednio z pliku konfiguracyjnego. Zobacz Korzystanie z opcji ‑‑config.
-e,
‑‑environment 		Wymagane Wszystkie (String) Środowisko w Twojej organizacji.
-f,
‑‑file 		Wymagane Wszystkie (Ciąg znaków) Plik tokena (domyślnie: użyj stdin)
-h,
‑‑help 		Opcjonalny Wszystkie Wyświetla pomoc dotyczącą parametrów polecenia.
‑‑insecure Opcjonalny Wszystkie Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z SSL.
‑‑legacy Wymagane Tylko Edge Public Cloud Jeśli używasz Apigee Edge na platformie Public Cloud, musisz ustawić tę flagę. Ustawia adresy URL zarządzania i środowiska wykonawczego w Apigee Edge na potrzeby chmury publicznej.
‑‑opdk Wymagane Tylko Edge Private Cloud Musisz ustawić tę flagę, jeśli używasz Apigee Edge for Private Cloud.
-o,
‑‑organization 		Wymagane Wszystkie (Ciąg znaków) Organizacja Apigee. Musisz być administratorem organizacji.
-r,
‑‑runtime 		Wymagane Tylko Edge Private Cloud i Apigee Hybrid (Ciąg) Określa adres URL środowiska wykonawczego instancji chmury prywatnej lub Apigee Hybrid. Adres URL musi zaczynać się od https://. Na przykład: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalny Tylko Edge Private Cloud (String) Określa certyfikat TLS po stronie klienta, klucz prywatny i główny urząd certyfikacji dla połączenia mTLS.
-v,
‑‑verbose 		Opcjonalny Wszystkie (Opcjonalnie) Generuje szczegółowe dane wyjściowe.

Przykład

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

Wyniki

Jeśli operacja się powiedzie, zobaczysz dane wyjściowe podobne do tych: 
{
	"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.

Przeprowadzanie rotacji tokena JWT

Po wygenerowaniu tokena JWT może zajść potrzeba zmiany pary kluczy publicznego i prywatnego przechowywanej przez Apigee na zaszyfrowanej mapie klucz-wartość (KVM). Proces generowania nowej pary kluczy nazywa się rotacją kluczy. Podczas rotacji kluczy generowana jest nowa para kluczy prywatnych/publicznych, która jest przechowywana w maszynie wirtualnej KVM „istio” w Twojej organizacji lub środowisku Apigee. Stary klucz publiczny jest też zachowywany wraz z pierwotną wartością identyfikatora klucza.

Wykorzystanie

apigee-remote-service-cli token rotate-cert [flags]

Parametry

Parametry Obecność Używane z produktami Opis
-c,
‑‑config 		Wymagane Wszystkie (String) Ścieżka do pliku konfiguracyjnego usługi zdalnej Apigee.
Wskazówka: ta flaga umożliwia pominięcie większości innych parametrów polecenia, ponieważ interfejs wiersza poleceń może pobrać je bezpośrednio z pliku konfiguracyjnego. Zobacz Korzystanie z opcji ‑‑config.
-e,
‑‑environment 		Wymagane Wszystkie (String) Środowisko w Twojej organizacji.
-h,
‑‑help 		Opcjonalny Tylko Edge w chmurze publicznej i prywatnej Wyświetla pomoc dotyczącą parametrów polecenia.
--k, --key Wymagane Tylko Edge w chmurze publicznej i prywatnej (String) Klucz udostępniania.
‑‑insecure Opcjonalny Tylko Edge w chmurze publicznej i prywatnej Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z SSL.
‑‑legacy Wymagane Tylko Edge Public Cloud Jeśli używasz Apigee Edge na platformie Public Cloud, musisz ustawić tę flagę. Ustawia adresy URL zarządzania i środowiska wykonawczego w Apigee Edge na potrzeby chmury publicznej.
‑‑opdk Wymagane Tylko Edge Private Cloud Musisz ustawić tę flagę, jeśli używasz Apigee Edge for Private Cloud.
-o,
‑‑organization 		Wymagane Tylko Edge w chmurze publicznej i prywatnej (Ciąg znaków) Organizacja Apigee. Musisz być administratorem organizacji.
-r,
‑‑runtime 		Wymagane Tylko Edge Private Cloud (Ciąg) Określa adres URL środowiska wykonawczego instancji chmury prywatnej lub Apigee Hybrid. Adres URL musi zaczynać się od https://. Na przykład: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret Wymagane Wszystkie (String) Tajny klucz do aprowizacji.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalny Tylko Edge Private Cloud (String) Określa certyfikat TLS po stronie klienta, klucz prywatny i główny urząd certyfikacji dla połączenia mTLS.
--t, ‑‑truncate Wymagane Wszystkie (Liczba całkowita) Liczba certyfikatów do przechowywania w JWKS (domyślnie 2).
-v,
‑‑verbose 		Opcjonalny Wszystkie (Opcjonalnie) Generuje szczegółowe dane wyjściowe.

Przykład

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

Wyniki

certificate successfully rotated

Tworzenie tokena wewnętrznego

Utwórz token JWT do autoryzowania wywołań interfejsu API usługi zdalnej.

Wykorzystanie

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

Parametry

Parametry

Parametry Obecność Używane z produktami Opis
-c,
‑‑config 		Wymagane Tylko Apigee Hybrid (String) Ścieżka do pliku konfiguracyjnego usługi zdalnej Apigee.
Wskazówka: ta flaga umożliwia pominięcie większości innych parametrów polecenia, ponieważ interfejs wiersza poleceń może pobrać je bezpośrednio z pliku konfiguracyjnego. Zobacz Korzystanie z opcji ‑‑config.
-d,
‑‑duration 		Wymagane Tylko Apigee Hybrid (String) ważny czas wewnętrznego tokena JWT od momentu utworzenia (domyślnie: 10m0s (10 minut)).
-e,
‑‑environment 		Wymagane Tylko Apigee Hybrid (String) Środowisko w Twojej organizacji.
-h,
‑‑help 		Opcjonalny Tylko Apigee Hybrid Wyświetla pomoc dotyczącą parametrów polecenia.
‑‑insecure Opcjonalny Tylko Apigee Hybrid Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z SSL.
-o,
‑‑organization 		Wymagane Tylko Apigee Hybrid (Ciąg znaków) Organizacja Apigee. Musisz być administratorem organizacji.
-r,
‑‑runtime 		Wymagane Tylko Apigee Hybrid (String) Określa adres URL środowiska wykonawczego instancji Apigee Hybrid. Adres URL musi zaczynać się od https://. Na przykład: https://apitest.apigee-hybrid-docs.net
-v,
‑‑verbose 		Opcjonalny Tylko Apigee Hybrid (Opcjonalnie) Generuje szczegółowe dane wyjściowe.

Polecenie wersji

Wydrukuj wersję interfejsu wiersza poleceń.

apigee-remote-service-cli version

Używanie pliku .netrc do przechowywania danych logowania

apigee-remote-service-cli automatycznie pobiera username i password (w przypadku podstawowego uwierzytelniania, gdy jest to potrzebne) z pliku .netrc w katalogu domowym, jeśli korzystasz z Edge Public Cloud i masz wpis dla urządzenia api.enterprise.apigee.com. Jeśli korzystasz z Apigee Private Cloud, wartość maszyny jest taka sama jak adres URL management (np. http://192.162.55.100). Przykład w przypadku Edge Public Cloud: 
machine api.enterprise.apigee.com
login jdoe@google.com
password abc123
Na przykład w przypadku Edge Private Cloud: 
machine http://192.162.55.100
login jdoe@google.com
password abc123

Używanie opcji polecenia ‑‑config

Opcja ‑‑config określa lokalizację pliku konfiguracyjnego wygenerowanego przez polecenie provision. Zaletą tej opcji jest to, że pozwala pominąć większość innych parametrów poleceń, które interfejs wiersza poleceń pobiera z pliku konfiguracyjnego. Opcje te obejmują:
  • organizacja
  • środowisko
  • środowisko wykonawcze
  • zarządzanie
  • niezabezpieczone
  • przestrzeń nazw
  • starsze
  • opdk

Możesz na przykład wykonać polecenie provision w ten sposób: 

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

Plik konfiguracji

Ta sekcja zawiera przykładowy plik konfiguracyjny ze wszystkimi dostępnymi opcjami. 

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