Materiały referencyjne

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Interfejs wiersza poleceń apigee-remote-service-cli pomaga udostępnić adapter Apigee dla Envoy i nim zarządzać.

Polecenie wyświetlania powiązań

Wyświetla wszystkie usługi API powiązane z usługą zdalną.

Wykorzystanie

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

Parametry

Parametry Obecność Używane z produktami Opis
-c,
‑‑config 		Wymagane Wszystko (Ciąg) Ścieżka do pliku konfiguracji usługi zdalnej Apigee.
Wskazówka: ta flaga umożliwia pominięcie większości innych parametrów poleceń, ponieważ interfejs wiersza poleceń może pobierać je bezpośrednio z pliku konfiguracji. Zobacz Użyj opcji ‑‑config.
-e,
‑‑environment 		Wymagane Wszystko (Ciąg) Środowisko w organizacji.
-h,
‑‑help 		Opcjonalnie Wszystko Wyświetla pomoc dotyczącą parametrów polecenia.
‑‑insecure Opcjonalnie Wszystko Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z protokołu SSL.
‑‑legacy Wymagane Tylko Edge Public Cloud Musisz ustawić tę flagę, jeśli korzystasz z Apigee Edge dla Cloud Public Cloud. Ustawia adresy URL zarządzania i działania dla Apigee Edge dla chmury publicznej.
-m,
‑‑management 		Wymagane Tylko Edge Private Cloud (Ciąg) Podstawowy adres URL zarządzania instalacją Apigee Edge for Private Cloud. Domyślnie: https://api.enterprise.apigee.com
‑‑mfa Wymagane Tylko Edge Public Cloud (Ciąg) Token autoryzacji wielopoziomowej dla Apigee Edge dla Cloud Public Cloud. Wymagane tylko w przypadku MFA jest skonfigurowana na Twoim koncie Apigee Edge.
‑‑opdk Wymagane Tylko Edge Private Cloud Musisz ustawić tę flagę, jeśli korzystasz z Apigee Edge dla Private Cloud.
-o,
‑‑organization 		Wymagane Wszystko (Ciąg) Organizacja Apigee. Musisz być administratorem organizacji.
-p,
‑‑password 		Wymagane
(tylko uwierzytelnianie podstawowe)		 Tylko brzegowe chmury publiczne i prywatne (Ciąg) Twoje hasło do Apigee. Opcjonalnie możesz określić hasło w pliku .netrc. Zobacz też Używanie .netrc na potrzeby danych logowania
-r,
‑‑runtime 		Wymagane Tylko Edge Private Cloud i hybrydowy Apigee (Ciąg) Określa adres URL środowiska wykonawczego dla instancji Private Cloud lub hybrydowej Apigee. Adres URL musi zaczynać się od https://. Przykład: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalnie Tylko Edge Private Cloud (Ciąg) Określa certyfikat TLS po stronie klienta, klucz prywatny i główny urząd certyfikacji na potrzeby połączenia mTLS.
-t,
‑‑token 		Wymagane
(tylko uwierzytelnianie tokenem OAuth)		 Wszystko (Ciąg) Wygenerowany token OAuth lub SAML na podstawie informacji o koncie Apigee. Zastępuje wszystkie inne podane dane logowania.
-u,
‑‑username 		Wymagane
(tylko uwierzytelnianie podstawowe)		 Tylko brzegowe chmury publiczne i prywatne (Ciąg) Twoja nazwa użytkownika Apigee (zwykle adres e-mail). Opcjonalnie możesz podać nazwę użytkownika w pliku .netrc. Jeśli to zrobisz, nie musisz podawać nazwy użytkownika w wierszu poleceń. Zobacz a także używanie domeny .netrc jako danych logowania.
-v,
‑‑verbose 		Opcjonalnie Wszystko (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

W przypadku wszystkich poleceń apigee-remote-service-cli dostępna jest pomoc online. Po prostu wpisz:

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 udostępniania

Polecenie apigee-remote-service-cli provision instaluje 2 serwery proxy interfejsu API w Apigee Organizacja brzegowa, konfigurowanie certyfikatu i generowanie danych logowania ani skonfigurować adaptera Apigee dla Envoy.

Wykorzystanie

apigee-remote-service-cli provision [flags]

Parametry

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

(Ciąg) Użyj tej flagi, aby określić ścieżkę do pliku klucza konta usługi Google Cloud, gdzie konto usługi ma przypisaną rolę Apigee Analytics Agent. Używany jest identyfikator SA przez adapter, aby przesyłać dane analityczne bezpośrednio do Apigee. Jeśli korzystasz z Apigee, ta opcja pozwala zainstalować hybrydowe środowisko wykonawcze w jednym klastrze w innej grupie.
-c,
‑‑config 		Wymagane Wszystko (Ciąg) Ścieżka do pliku konfiguracji usługi zdalnej Apigee.
Wskazówka: ta flaga umożliwia pominięcie większości innych parametrów poleceń, ponieważ interfejs wiersza poleceń może pobierać je bezpośrednio z pliku konfiguracji. Zobacz Użyj opcji ‑‑config.
-e,
‑‑environment 		Wymagane Wszystko (Ciąg) Środowisko w organizacji.
-f, ‑‑force-proxy-install Opcjonalnie Wszystko (Opcjonalnie) Wymusza ponowne zainstalowanie serwera proxy remote-service, jeśli jest jest już zainstalowany w Twojej organizacji.
-h,
‑‑help 		Opcjonalnie Wszystko Wyświetla pomoc dotyczącą parametrów polecenia.
‑‑insecure Opcjonalnie Wszystko Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z protokołu SSL.
‑‑legacy Wymagane Tylko Edge Public Cloud Musisz ustawić tę flagę, jeśli korzystasz z Apigee Edge dla Cloud Public Cloud. Ustawia adresy URL zarządzania i działania dla Apigee Edge dla chmury publicznej.
-m,
‑‑management 		Wymagane Tylko Edge Private Cloud (Ciąg) Podstawowy adres URL zarządzania instalacją Apigee Edge for Private Cloud. Domyślnie: https://api.enterprise.apigee.com
‑‑mfa Wymagane Tylko Edge Public Cloud Token autoryzacji wielopoziomowej dla Apigee Edge dla Cloud Public Cloud. Wymagane tylko w przypadku MFA jest skonfigurowana na Twoim koncie Apigee Edge.
-n, ‑‑namespace Opcjonalnie Wszystko (Ciąg) Konfiguracja emisji jako obiekt ConfigMap Envoy w określonej przestrzeni nazw. Domyślnie: apigee
‑‑opdk Wymagane Tylko Edge Private Cloud Musisz ustawić tę flagę, jeśli korzystasz z Apigee Edge dla Private Cloud.
-o,
‑‑organization 		Wymagane Wszystko (Ciąg) Organizacja Apigee. Aby włączyć obsługę administracyjną, musisz być administratorem organizacji.
-p,
‑‑password 		Wymagane
(tylko uwierzytelnianie podstawowe)		 Tylko brzegowe chmury publiczne i prywatne (Ciąg) Twoje hasło do Apigee. Opcjonalnie możesz określić hasła w pliku
.netrc. Jeśli to zrobisz, nie musisz: wpisz hasło w wierszu poleceń. Zobacz też Używanie .netrc na potrzeby danych logowania
‑‑rotate-int Opcjonalnie Tylko Apigee hybrydowa (Liczba całkowita) Jeśli n > 0, wygeneruj nowy klucz prywatny i zachowaj n kluczy publicznych (tylko hybrydowe)
-r,
‑‑runtime 		Wymagane Tylko Edge Private Cloud i hybrydowy Apigee (Ciąg) Określa adres URL środowiska wykonawczego dla instancji Private Cloud lub hybrydowej Apigee. Adres URL musi zaczynać się od https://. Przykład: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalnie Tylko Edge Private Cloud (Ciąg) Określa certyfikat TLS po stronie klienta, klucz prywatny i główny urząd certyfikacji na potrzeby połączenia mTLS.
-t,
‑‑token 		Wymagane
(tylko uwierzytelnianie tokenem OAuth)		 Wszystko (Ciąg) Wygenerowany token OAuth lub SAML na podstawie informacji o koncie Apigee. Zastępuje wszystkie inne podane dane logowania.
-u,
‑‑username 		Wymagane
(tylko uwierzytelnianie podstawowe)		 Tylko brzegowe chmury publiczne i prywatne (Ciąg) Twoja nazwa użytkownika Apigee (zwykle adres e-mail). Opcjonalnie możesz podać nazwę użytkownika w pliku .netrc. Zobacz a także używanie domeny .netrc jako danych logowania.
-v,
‑‑verbose 		Opcjonalnie Wszystko (Opcjonalnie) Generuje szczegółowe dane wyjściowe.
‑‑virtual-hosts Opcjonalnie Tylko Edge Private Cloud (Ciąg) Zastępuje domyślne hosty wirtualne, którymi jest default,secure. Użyj tej opcji, jeśli mają ustawione hosty wirtualne dla środowiska organizacji Edge inne niż te domyślne.

Przykład

Jak widać w przykładzie poniżej, ważne jest przechwytywanie danych wyjściowych polecenia provision w pliku, który jest używany jako dane wejściowe do innych operacji adaptera Apigee dla Envoy.

Przykład: 

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

Polecenie dotyczące przykładów

Tworzy przykładowe pliki konfiguracji i wyświetla ich listę.

Tworzenie przykładowych plików konfiguracji

Tworzy przykładowe pliki konfiguracji na potrzeby natywnych wdrożeń Envoy i Istio.

Wykorzystanie

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

Opis

To polecenie wymaga podania prawidłowego pliku config.yaml jako danych wejściowych. Plik wejściowy to plik, który został generowanych przez obsługę administracyjną. Domyślnie przykładowe pliki są przesyłane do katalogu o nazwie ./samples. Polecenie który utworzy dla Ciebie katalog.

Jeśli używasz natywnego serwera Envoy, polecenie przyjmie docelowy host usługi i pożądaną nazwę jej klaster. Ustawia też niestandardowe połączenie SSL między serwerem proxy Envoy a usługą zdalną klastra, jeśli folder zawierający tls.key i tls.crt został udostępniony w --tls.

Jeśli korzystasz z Istio, gdzie serwer proxy Envoy działa jako plik pomocniczy, a wartość docelowa nie jest określona, zostanie wygenerowany przykład żądania httpbin. W przeciwnym razie musisz przygotować plików konfiguracji 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. Wszystko (Ciąg) Nazwa hosta adaptera (domyślnie: localhost)
-c, ‑‑config Wymagane Wszystko (Ciąg) Ścieżka do pliku konfiguracji usługi zdalnej Apigee.
Wskazówka: ta flaga umożliwia pominięcie większości innych parametrów poleceń, ponieważ interfejs wiersza poleceń może pobierać je bezpośrednio z pliku konfiguracji. Zobacz Użyj opcji ‑‑config.
-f, ‑‑force Opcjonalnie Wszystko Wymuś zastąpienie istniejącego katalogu.
-h, ‑‑help Opcjonalnie Wszystko Wyświetla pomoc dotyczącą parametrów polecenia.
‑‑host Wymagane tylko w przypadku szablonów Envoy. Wszystko (Ciąg) Host usługi docelowej (domyślnie httpbin.org)
-n, ‑‑name Wymagane Wszystko (Ciąg) Nazwa usługi docelowej (domyślnie httpbin.org)
‑‑out Opcjonalnie Wszystko (Ciąg) Katalog, w którym mają zostać utworzone przykładowe pliki konfiguracyjne.
Domyślnie: ./samples
‑‑tag Wymagane tylko w przypadku szablonów Istio Wszystko (Ciąg) Tag wersji obrazu karty Envoy. Domyślnie: v2.0.0
-t, ‑‑template Wymagane Wszystko (Ciąg) Nazwa szablonu Envoy lub Istio. Aby zobaczyć listę dostępnych szablonów, uruchom polecenie apigee-remote-service samples templates
‑‑tls Opcjonalnie, tylko w przypadku szablonów Envoy Wszystko (Ciąg) Katalog z plikami tls.key i tls.crt używanego na potrzeby usługi adaptera.

Przykład 

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

Wyświetl listę dostępnych opcji szablonów

Wyświetla listę szablonów, których można używać z parametrem --templates w elemencie 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 dotyczące tokena

Zamiast klucza interfejsu API możesz używać tokena JWT do wykonywania uwierzytelnionych wywołań serwera proxy interfejsu API. Polecenia dotyczące tokenów umożliwiają tworzenie, sprawdzanie i rotowanie tokenów JWT w tym celu.

Tworzenie tokena JWT

Tokenu JWT możesz używać do wykonywania uwierzytelnionego wywołania serwera proxy interfejsu API do zdalnego celu usługi. Zobacz Użycie uwierzytelniania JWT.

Wykorzystanie

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

Parametry

Parametry Obecność Używane z produktami Opis
-c,
‑‑config 		Wymagane Wszystko (Ciąg) Ścieżka do pliku konfiguracji usługi zdalnej Apigee.
Wskazówka: ta flaga umożliwia pominięcie większości innych parametrów poleceń, ponieważ interfejs wiersza poleceń może pobierać je bezpośrednio z pliku konfiguracji. Zobacz Użyj opcji ‑‑config.
-e,
‑‑environment 		Wymagane Wszystko (Ciąg) Środowisko w organizacji.
-h,
‑‑help 		Opcjonalnie Wszystko Wyświetla pomoc dotyczącą parametrów polecenia.
--i, --id Wymagane Wszystko (Ciąg) Dane logowania klucza znalezione w aplikacji dewelopera Apigee zgodnie z opisem w tym artykule: Jak uzyskać klucz interfejsu API
‑‑insecure Opcjonalnie Wszystko Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z protokołu SSL.
‑‑legacy Wymagane Tylko Edge Public Cloud Musisz ustawić tę flagę, jeśli korzystasz z Apigee Edge dla Cloud Public Cloud. Ustawia adresy URL zarządzania i działania dla Apigee Edge dla chmury publicznej.
‑‑opdk Wymagane Tylko Edge Private Cloud Musisz ustawić tę flagę, jeśli korzystasz z Apigee Edge dla Private Cloud.
-o,
‑‑organization 		Wymagane Wszystko (Ciąg) Organizacja Apigee. Musisz być administratorem organizacji.
-r,
‑‑runtime 		Wymagane Tylko Edge Private Cloud i hybrydowy Apigee (Ciąg) Określa adres URL środowiska wykonawczego dla instancji Private Cloud lub hybrydowej Apigee. Adres URL musi zaczynać się od https://. Przykład: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret Wymagane Wszystko (Ciąg) Secret (Tajne dane logowania) znalezione w aplikacji dla deweloperów Apigee, zgodnie z opisem w tym artykule: Jak uzyskać klucz interfejsu API
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalnie Tylko Edge Private Cloud (Ciąg) Określa certyfikat TLS po stronie klienta, klucz prywatny i główny urząd certyfikacji na potrzeby połączenia mTLS.
-v,
‑‑verbose 		Opcjonalnie Wszystko (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

Gdy operacja się uda, wyświetli się 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. Przeczytaj też sekcję Sprawdzanie tokena.

Wykorzystanie

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

Parametry

Parametry

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

Przykład

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

Wyniki

Jeśli operacja się uda, zostaną wyświetlone 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.

Rotacja tokena JWT

W pewnym momencie po pierwszym wygenerowaniu tokena JWT może być konieczna zmiana klucza publicznego/prywatnego. zapisane przez Apigee w zaszyfrowanej mapie klucz-wartość (KVM). Ten proces generowania jest to tzw. rotacja kluczy. Podczas rotacji kluczy nowa para kluczy prywatny/publiczny jest generowana i przechowywana w folderze „istio” KVM w organizacji/środowisku Apigee. Dodatkowo stary klucz publiczny zostanie zachowany 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 Wszystko (Ciąg) Ścieżka do pliku konfiguracji usługi zdalnej Apigee.
Wskazówka: ta flaga umożliwia pominięcie większości innych parametrów poleceń, ponieważ interfejs wiersza poleceń może pobierać je bezpośrednio z pliku konfiguracji. Zobacz Użyj opcji ‑‑config.
-e,
‑‑environment 		Wymagane Wszystko (Ciąg) Środowisko w organizacji.
-h,
‑‑help 		Opcjonalnie Tylko brzegowe chmury publiczne i prywatne Wyświetla pomoc dotyczącą parametrów polecenia.
--k, --key Wymagane Tylko brzegowe chmury publiczne i prywatne (Ciąg) Klucz udostępniania.
‑‑insecure Opcjonalnie Tylko brzegowe chmury publiczne i prywatne Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z protokołu SSL.
‑‑legacy Wymagane Tylko Edge Public Cloud Musisz ustawić tę flagę, jeśli korzystasz z Apigee Edge dla Cloud Public Cloud. Ustawia adresy URL zarządzania i działania dla Apigee Edge dla chmury publicznej.
‑‑opdk Wymagane Tylko Edge Private Cloud Musisz ustawić tę flagę, jeśli korzystasz z Apigee Edge dla Private Cloud.
-o,
‑‑organization 		Wymagane Tylko brzegowe chmury publiczne i prywatne (Ciąg) Organizacja Apigee. Musisz być administratorem organizacji.
-r,
‑‑runtime 		Wymagane Tylko Edge Private Cloud (Ciąg) Określa adres URL środowiska wykonawczego dla instancji Private Cloud lub hybrydowej Apigee. Adres URL musi zaczynać się od https://. Przykład: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret Wymagane Wszystko (Ciąg) Obiekt tajny udostępniania.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalnie Tylko Edge Private Cloud (Ciąg) Określa certyfikat TLS po stronie klienta, klucz prywatny i główny urząd certyfikacji na potrzeby połączenia mTLS.
--t, ‑‑truncate Wymagane Wszystko (Liczba całkowita) Liczba certyfikatów do zachowania w JWKS (domyślnie 2).
-v,
‑‑verbose 		Opcjonalnie Wszystko (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

Utworzenie tokena wewnętrznego

Utwórz token JWT do autoryzacji 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 hybrydowa platforma Apigee (Ciąg) Ścieżka do pliku konfiguracji usługi zdalnej Apigee.
Wskazówka: ta flaga umożliwia pominięcie większości innych parametrów poleceń, ponieważ interfejs wiersza poleceń może pobierać je bezpośrednio z pliku konfiguracji. Zobacz Użyj opcji ‑‑config.
-d,
‑‑duration 		Wymagane Tylko hybrydowa platforma Apigee (Ciąg) prawidłowy czas wewnętrznego tokena JWT od utworzenia (domyślnie: 10m0s (10 minut)).
-e,
‑‑environment 		Wymagane Tylko Apigee hybrydowa (Ciąg) Środowisko w organizacji.
-h,
‑‑help 		Opcjonalnie Tylko hybrydowa platforma Apigee Wyświetla pomoc dotyczącą parametrów polecenia.
‑‑insecure Opcjonalnie Tylko hybrydowa platforma Apigee Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z protokołu SSL.
-o,
‑‑organization 		Wymagane Tylko hybrydowa platforma Apigee (Ciąg) Organizacja Apigee. Musisz być administratorem organizacji.
-r,
‑‑runtime 		Wymagane Tylko hybrydowa platforma Apigee (Ciąg) Określa adres URL środowiska wykonawczego dla instancji hybrydowej Apigee. Adres URL musi zaczynać się od https://. Przykład: https://apitest.apigee-hybrid-docs.net
-v,
‑‑verbose 		Opcjonalnie Tylko hybrydowa platforma Apigee (Opcjonalnie) Generuje szczegółowe dane wyjściowe.

Polecenie dotyczące wersji

Wydrukuj wersję interfejsu wiersza poleceń.

apigee-remote-service-cli version

Używanie domeny .netrc na potrzeby danych logowania

apigee-remote-service-cli automatycznie odbierze: username i password (w razie potrzeby do podstawowego uwierzytelniania) z urządzenia .netrc w katalogu głównym, jeśli korzystasz z Edge Public Cloud i masz wpis dla maszyna api.enterprise.apigee.com. Jeśli korzystasz z Apigee Private Cloud, wartość maszyn jest taka sama jak adresu URL w atrybucie management (np. http://192.162.55.100). Na przykład w Edge Public Cloud: 
machine api.enterprise.apigee.com
login jdoe@google.com
password abc123
Na przykład w Edge Private Cloud: 
machine http://192.162.55.100
login jdoe@google.com
password abc123

Za pomocą opcji polecenia ‑‑config

Opcja ‑‑config określa lokalizację pliku konfiguracyjnego wygenerowanego przez polecenie provision. Zaletą tej opcji jest to, że umożliwia pominięcie większości innych parametrów poleceń, które interfejs wiersza poleceń pobiera z pliku konfiguracji. Dostępne opcje:
  • 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

W tej sekcji znajdziesz przykładowy plik konfiguracji 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