Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
Interfejs wiersza poleceń (CLI) apigee-remote-service-cli ułatwia udostępnienie adaptera Apigee dla Envoy i zarządzanie nim.
Polecenia powiązania
Powiązanie wiąże usługę wdrożoną w siatce Istio z usługą Apigee API. Interfejs wiersza poleceń pozwala tworzyć, usuwać, wyświetlać i weryfikować powiązania.
Dodaj powiązanie
Dodaje powiązanie celu usługi zdalnej do usługi API.
Wykorzystanie
W przypadku chmury publicznej Edge:
apigee-remote-service-cli bindings add [service_name] [product_name] -o [organization] -e [environment] -u [username] -p [password] -c [config]
W przypadku chmury prywatnej na brzegu sieci:
apigee-remote-service-cli bindings add [service_name] [product_name] -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]
Gdzie:
target_nameto nazwa celu usługi zdalnej, który ma być powiązany z usługą.product_nameto nazwa usługi, z którą chcesz ją powiązać.
Flagi
| Parametry | Typ | Opis |
|---|---|---|
-c, --config
|
Ciąg znaków | (Wymagane) Ścieżka do pliku konfiguracyjnego 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. Zapoznaj się z artykułem o korzystaniu z opcji --config.
|
-e, --env
|
Ciąg znaków | (Wymagane) Środowisko w Twojej organizacji. |
-h, --help
|
Wyświetla pomoc dotyczącą parametrów polecenia. | |
--insecure
|
Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z protokołu SSL | |
--legacy
|
Ustaw tę flagę, jeśli korzystasz z Apigee Edge Cloud. Ustawia on adresy URL zarządzania i środowiska wykonawczego dla Edge Cloud. | |
--mfa
|
Token autoryzacji wielopoziomowej Apigee (używany tylko z --legacy)
|
|
--opdk
|
Ustaw tę flagę, jeśli używasz Apigee Edge dla chmury prywatnej. | |
-o, --org
|
Ciąg znaków | (Wymagane) Organizacja Apigee. Musisz być administratorem organizacji. |
-p, --password
|
Ciąg znaków | (Wymagane tylko w przypadku uwierzytelniania podstawowego) Hasło Apigee. Hasło możesz opcjonalnie podać w pliku .netrc. Jeśli to zrobisz, nie musisz podawać hasła w wierszu poleceń. Zapoznaj się też z informacjami o używaniu .netrc do podawania danych logowania.
|
-r, --runtime
|
Ciąg znaków | (Tylko Private Cloud) Określa adres URL środowiska wykonawczego Twojej instancji Private Cloud. |
-t, --token
|
Ciąg znaków | (Wymagane tylko w przypadku uwierzytelniania tokenem OAuth) Token OAuth lub SAML wygenerowany na podstawie informacji o koncie Apigee. Informacje o generowaniu tokenów znajdziesz w artykułach o używaniu get_token i uzyskiwaniu dostępu do interfejsu API zarządzania przez SAML. |
-u, --username
|
Ciąg znaków | (Wymagane tylko w przypadku uwierzytelniania podstawowego) Nazwa użytkownika Apigee (zwykle jest to adres e-mail).
Opcjonalnie możesz podać nazwę użytkownika w pliku .netrc. Jeśli to zrobisz, nie musisz podawać swojej nazwy użytkownika w wierszu poleceń. Zapoznaj się też z artykułem o używaniu .netrc do podawania danych logowania.
|
-v, --verbose
|
(Opcjonalnie) Generuje szczegółowe dane wyjściowe. |
Przykład
./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
Wyświetlenie listy powiązań
Wyświetlanie listy wszystkich usług API powiązanych z Usługą zdalną.
Wykorzystanie
W przypadku chmury publicznej Edge:
apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password]
W przypadku chmury prywatnej na brzegu sieci:
apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password] -r [runtime]
Parametry
| Parametry | Typ | Opis |
|---|---|---|
-c, --config
|
Ciąg znaków | (Wymagane) Ścieżka do pliku konfiguracyjnego 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, jak używać opcji --config.
|
-e, --env
|
Ciąg znaków | (Wymagane) Środowisko w Twojej organizacji. |
-h, --help
|
Wyświetla pomoc dotyczącą parametrów polecenia. | |
--insecure
|
Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z protokołu SSL | |
--legacy
|
Ustaw tę flagę, jeśli korzystasz z Apigee Edge Cloud. Ustawia on adresy URL zarządzania i środowiska wykonawczego dla Edge Cloud. | |
--mfa
|
Token autoryzacji wielopoziomowej Apigee (używany tylko z --legacy)
|
|
--opdk
|
Ustaw tę flagę, jeśli używasz Apigee Edge dla chmury prywatnej. | |
-o, --org
|
Ciąg znaków | (Wymagane) Organizacja Apigee. Musisz być administratorem organizacji. |
-p, --password
|
Ciąg znaków | (Wymagane tylko w przypadku uwierzytelniania podstawowego) Hasło Apigee. Hasło możesz opcjonalnie podać w pliku .netrc. Jeśli to zrobisz, nie musisz podawać hasła w wierszu poleceń. Zapoznaj się też z informacjami o używaniu .netrc do podawania danych logowania.
|
-r, --runtime
|
Ciąg znaków | (Tylko Private Cloud) Określa adres URL środowiska wykonawczego Twojej instancji Private Cloud. |
-t, --token
|
Ciąg znaków | (Wymagane tylko w przypadku uwierzytelniania tokenem OAuth) Token OAuth lub SAML wygenerowany na podstawie informacji o koncie Apigee. Informacje o generowaniu tokenów znajdziesz w artykułach o używaniu get_token i uzyskiwaniu dostępu do interfejsu API zarządzania przez SAML. |
-u, --username
|
Ciąg znaków | (Wymagane tylko w przypadku uwierzytelniania podstawowego) Nazwa użytkownika Apigee (zwykle jest to adres e-mail).
Opcjonalnie możesz podać nazwę użytkownika w pliku .netrc. Jeśli to zrobisz, nie musisz podawać swojej nazwy użytkownika w wierszu poleceń. Zapoznaj się też z artykułem o używaniu .netrc do podawania danych logowania.
|
-v, --verbose
|
(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
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:
Usuwanie wiązania
Usuń powiązanie usługi zdalnej dla Envoy z usługi API.
Wykorzystanie
W przypadku chmury publicznej Edge:
apigee-remote-service-cli bindings remove [service_name] [product_name] -o [organization] -e [environment] -u [username] -p [password] -c [config]
W przypadku chmury prywatnej na brzegu sieci:
apigee-remote-service-cli bindings remove [service_name] [product_name] -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]
Gdzie:
target_nameto nazwa celu usługi zdalnej, który ma zostać oddzielony od usługi.product_nameto nazwa produktu, od którego ma nastąpić usunięcie powiązania.
Parametry
| Parametry | Typ | Opis |
|---|---|---|
-c, --config
|
Ciąg znaków | (Wymagane) Ścieżka do pliku konfiguracyjnego 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. Zapoznaj się z artykułem o korzystaniu z opcji --config.
|
-e, --env
|
Ciąg znaków | (Wymagane) Środowisko w Twojej organizacji. |
-h, --help
|
Wyświetla pomoc dotyczącą parametrów polecenia. | |
--insecure
|
Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z protokołu SSL | |
--legacy
|
Ustaw tę flagę, jeśli korzystasz z Apigee Edge Cloud. Ustawia on adresy URL zarządzania i środowiska wykonawczego dla Edge Cloud. | |
--mfa
|
Token autoryzacji wielopoziomowej Apigee (używany tylko z --legacy)
|
|
--opdk
|
Ustaw tę flagę, jeśli używasz Apigee Edge dla chmury prywatnej. | |
-o, --org
|
Ciąg znaków | (Wymagane) Organizacja Apigee. Musisz być administratorem organizacji. |
-p, --password
|
Ciąg znaków | (Wymagane tylko w przypadku uwierzytelniania podstawowego) Hasło Apigee. Hasło możesz opcjonalnie podać w pliku .netrc. Jeśli to zrobisz, nie musisz podawać hasła w wierszu poleceń. Zapoznaj się też z informacjami o używaniu .netrc do podawania danych logowania.
|
-r, --runtime
|
Ciąg znaków | (Tylko Private Cloud) Określa adres URL środowiska wykonawczego Twojej instancji Private Cloud. |
-t, --token
|
Ciąg znaków | (Wymagane tylko w przypadku uwierzytelniania tokenem OAuth) Token OAuth lub SAML wygenerowany na podstawie informacji o koncie Apigee. Informacje o generowaniu tokenów znajdziesz w artykułach o używaniu get_token i uzyskiwaniu dostępu do interfejsu API zarządzania przez SAML. |
-u, --username
|
Ciąg znaków | (Wymagane tylko w przypadku uwierzytelniania podstawowego) Nazwa użytkownika Apigee (zwykle jest to adres e-mail).
Opcjonalnie możesz podać nazwę użytkownika w pliku .netrc. Jeśli to zrobisz, nie musisz podawać swojej nazwy użytkownika w wierszu poleceń. Zapoznaj się też z artykułem o używaniu .netrc do podawania danych logowania.
|
-v, --verbose
|
(Opcjonalnie) Generuje szczegółowe dane wyjściowe. |
Przykład
./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
Weryfikowanie powiązania
Sprawdź, czy wskazana powiązana usługa API i powiązane z nią aplikacje dewelopera także są powiązane z usługą zdalną. Jeśli nie określisz nazwy usługi API, polecenie sprawdzi wszystkie powiązane produkty.
Wykorzystanie
W przypadku chmury publicznej Edge:
apigee-remote-service-cli bindings verify [product_name] -o [organization] -e [environment] -u [username] -p [password] -c [config]
W przypadku chmury prywatnej na brzegu sieci:
apigee-remote-service-cli bindings verify [product_name] -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]
Gdzie nazwa_produktu jest opcjonalna. Jeśli nie określisz nazwy produktu, zostaną sprawdzone wszystkie powiązane produkty.
Parametry
| Parametry | Typ | Opis |
|---|---|---|
-c, --config
|
Ciąg znaków | (Wymagane) Ścieżka do pliku konfiguracyjnego 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. Zapoznaj się z artykułem o korzystaniu z opcji --config.
|
-e, --env
|
Ciąg znaków | (Wymagane) Środowisko w Twojej organizacji. |
-h, --help
|
Wyświetla pomoc dotyczącą parametrów polecenia. | |
--insecure
|
Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z protokołu SSL | |
--legacy
|
Ustaw tę flagę, jeśli korzystasz z Apigee Edge Cloud. Ustawia on adresy URL zarządzania i środowiska wykonawczego dla Edge Cloud. | |
--mfa
|
Token autoryzacji wielopoziomowej Apigee (używany tylko z --legacy)
|
|
--opdk
|
Ustaw tę flagę, jeśli używasz Apigee Edge dla chmury prywatnej. | |
-o, --org
|
Ciąg znaków | (Wymagane) Organizacja Apigee. Musisz być administratorem organizacji. |
-r, --runtime
|
Ciąg znaków | (Tylko Private Cloud) Określa adres URL środowiska wykonawczego Twojej instancji Private Cloud. |
-t, --token
|
Ciąg znaków | (Wymagane tylko w przypadku uwierzytelniania tokenem OAuth) Token OAuth lub SAML wygenerowany na podstawie informacji o koncie Apigee. Informacje o generowaniu tokenów znajdziesz w artykułach o używaniu get_token i uzyskiwaniu dostępu do interfejsu API zarządzania przez SAML. |
-v, --verbose
|
(Opcjonalnie) Generuje szczegółowe dane wyjściowe. |
Przykład
./apigee-remote-service-cli bindings verify my-product -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx app my-app associated with product my-product is verified
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 serwer proxy w organizacji Apigee Edge, konfiguruje certyfikat i generuje dane logowania potrzebne do skonfigurowania adaptera Apigee dla Envoy.
Wykorzystanie
Jeśli korzystasz z Edge Public Cloud:
apigee-remote-service-cli provision -o $ORG -e $ENV -u $USERNAME -p $PASSWORD
Jeśli korzystasz z Edge Private Cloud:
apigee-remote-service-cli provision --opdk -o $ORG -e $ENV -u $USERNAME --management $MGMT_SERVER_URL --runtime $RUNTIME_URL -p $PASSWORD
Parametry
| Parametry | Typ | Opis |
|---|---|---|
-c, --config
|
Ciąg znaków | Ścieżka do pliku konfiguracyjnego usługi zdalnej Apigee. Zobacz też
Korzystanie z opcji --config.
|
-e, --environment
|
Ciąg znaków | (Wymagane) Środowisko w Twojej organizacji. |
-f, --force-proxy-install
|
(Opcjonalnie) Wymusza ponowną instalację serwera proxy remote-service, jeśli jest on już zainstalowany w organizacji.
|
|
-h, --help
|
Wyświetla pomoc dotyczącą parametrów polecenia. | |
-k, --key
|
Ciąg znaków | Określa klucz zwrócony z polecenia apigee-remote-service-cli provision.
|
--legacy
|
Ustaw tę flagę, jeśli korzystasz z Apigee Edge Cloud. Ustawia on adresy URL zarządzania i środowiska wykonawczego dla Edge Cloud. | |
--mfa
|
Token autoryzacji wielopoziomowej Apigee (używany tylko z --legacy)
|
|
-m, --management
|
Ciąg znaków | (Wymagane, jeśli korzystasz z Apigee Private Cloud) Twój podstawowy adres URL do zarządzania Apigee.
Domyślny: https://api.enterprise.apigee.com
|
-n, --namespace
|
Ciąg znaków | Emituj konfigurację jako obiekt ConfigMap Envoy w określonej przestrzeni nazw. Domyślnie: apigee |
--opdk
|
Ciąg znaków | Apigee OPDK. |
-o, --organization
|
Ciąg znaków | (Wymagane) Twoja organizacja Apigee. Musisz być administratorem organizacji. |
-p, --password
|
Ciąg znaków | (Wymagane tylko w przypadku uwierzytelniania podstawowego) Hasło Apigee. Hasło możesz opcjonalnie podać w pliku .netrc. Jeśli to zrobisz, nie musisz podawać hasła w wierszu poleceń. Zapoznaj się też z informacjami o używaniu .netrc do podawania danych logowania.
|
--rotate-int
|
int | Jeśli n > 0, wygeneruj nowy klucz prywatny i zachowaj n kluczy publicznych (tylko hybrydowe) |
-r, --runtime
|
Ciąg znaków | (Tylko Private Cloud) Określa adres URL środowiska wykonawczego Twojej instancji Private Cloud. |
-s, --secret
|
Ciąg znaków | Określa obiekt tajny zwrócony przez polecenie apigee-remote-service-cli provision.
|
--strength
|
int | (Opcjonalnie) Określa siłę szyfrowania certyfikatów SSL używanych do udostępniania adaptera. Domyślnie 2048 |
-t, --token
|
Ciąg znaków | (Tylko hybrydowy) token OAuth lub SAML Apigee. |
-u, --username
|
Ciąg znaków | (Wymagane tylko w przypadku uwierzytelniania podstawowego) Nazwa użytkownika Apigee (zwykle jest to adres e-mail).
Opcjonalnie możesz podać nazwę użytkownika w pliku .netrc.
Zapoznaj się też z informacjami na temat używania domeny .netrc.
|
-v, --verbose
|
(Opcjonalnie) Generuje szczegółowe dane wyjściowe. | |
--virtual-hosts
|
Ciąg znaków | Zastępuje domyślne hosty wirtualne default,secure. Użyj tej opcji, jeśli w środowisku organizacji Edge masz określone hosty wirtualne inne niż te domyślne.
Informacje o hostach wirtualnych znajdziesz w dokumentacji Edge.
|
--years
|
int | (Opcjonalnie) Liczba lat, po której certyfikat SSL używany do obsługi administracyjnej wygaśnie. Domyślnie: 1 |
Przykład
Pamiętaj, aby zapisać w pliku dane wyjściowe polecenia provision, które będą używane jako dane wejściowe innych adapterów Apigee na potrzeby operacji Envoy.
Przykład chmury publicznej Edge:
apigee-remote-service-cli provision --legacy --mfa $MFA --username $USER --password $PASSWORD --organization $ORG --environment $ENV > config.yaml
Polecenie Przykład
Tworzy przykładowe pliki konfiguracji dla natywnych wdrożeń Envoy lub Istio.
Wykorzystanie
apigee-remote-service-cli samples create [flags]
Opis
Polecenie wymaga prawidłowego pliku config.yaml wygenerowanego przy użyciu obsługi administracyjnej.
Domyślnie przykładowe pliki są umieszczane w katalogu o nazwie ./samples. Polecenie utworzy dla Ciebie ten katalog.
Jeśli korzystasz z natywnego środowiska Envoy, polecenie pobiera docelowego hosta usługi i pożądaną nazwę klastra. Ustawia też niestandardowe połączenie SSL z serwera proxy Envoy do zdalnego klastra usług, jeśli folder zawierający tls.key i tls.crt jest udostępniany przez --tls.
Jeśli używasz Istio, gdzie serwer proxy Envoy działa jako pomocnicza, jeśli miejsce docelowe jest nieokreślone, zostanie wygenerowany przykład httpbin. W innym przypadku musisz przygotować pliki konfiguracji związane z wdrażaniem usług docelowych.
Parametry
| Parametry | Typ | Opis |
|---|---|---|
-c, --config
|
Ciąg znaków | (Wymagane) Ścieżka do pliku konfiguracyjnego 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. Zapoznaj się z artykułem o korzystaniu z opcji --config.
|
-f, --force
|
Wymuś zastąpienie istniejącego katalogu. | |
-h, --help
|
Wyświetla pomoc dotyczącą parametrów polecenia. | |
--host
|
Docelowy host usługi (domyślnie „httpbin.org”) | |
-n, --name
|
Nazwa usługi docelowej (domyślnie „httpbin”) | |
--out
|
Katalog, w którym zostaną utworzone przykładowe pliki konfiguracyjne. Domyślny: ./samples
|
|
-t, --template
|
Nazwa szablonu. Jeśli przeprowadzasz wdrożenie Istio (tylko w wersji hybrydowej), wybierz jedną z dostępnych opcji Istio. Użyj opcji natywnej w przypadku natywnych wdrożeń Envoy. Dostępne opcje:
|
|
--tls
|
Katalog, w którym są przechowywane klucz TLS i pliki crt. |
Przykład
apigee-remote-service-cli samples create -c ./config.yaml
Polecenia tokena
Zamiast używać klucza interfejsu API do wykonywania uwierzytelnionych wywołań serwera proxy interfejsu API, możesz użyć tokena JWT. Polecenia tokena umożliwiają tworzenie, sprawdzanie i rotowanie tokenów JWT.
Tworzenie tokena JWT
Za pomocą tokena JWT możesz wysłać uwierzytelnione wywołania serwera proxy interfejsu API do zdalnego celu usługi. Przeczytaj też informacje o używaniu uwierzytelniania za pomocą JWT.Wykorzystanie
W przypadku chmury publicznej Edge:apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -o [org] -e [env]W przypadku chmury prywatnej Edge:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]
Parametry
| Parametry | Typ | Opis |
|---|---|---|
-c, --config
|
Ciąg znaków | (Wymagane) Ścieżka do pliku konfiguracyjnego 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. Zapoznaj się z artykułem o korzystaniu z opcji --config.
|
-e, --env
|
Ciąg znaków | (Wymagane) Środowisko w Twojej organizacji. |
-h, --help
|
Wyświetla pomoc dotyczącą parametrów polecenia. | |
--insecure
|
Podczas korzystania z protokołu SSL zezwalaj na niezabezpieczone połączenia serwera. | |
-o, --org
|
Ciąg znaków | (Wymagane) Organizacja Apigee. Musisz być administratorem organizacji. |
-r, --runtime
|
Ciąg znaków | (Tylko Private Cloud) Określa adres URL środowiska wykonawczego Twojej instancji Private Cloud. |
-v, --verbose
|
(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
Po zakończeniu zobaczysz dane wyjściowe tokena JST podobne do tych: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
W przypadku chmury publicznej Edge:apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file]W przypadku chmury prywatnej Edge:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]
Parametry
| Parametry | Typ | Opis |
|---|---|---|
-c, --config
|
Ciąg znaków | (Wymagane) Ścieżka do pliku konfiguracyjnego 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. Zapoznaj się z artykułem o korzystaniu z opcji --config.
|
-e, --env
|
Ciąg znaków | (Wymagane) Środowisko w Twojej organizacji. |
-h, --help
|
Wyświetla pomoc dotyczącą parametrów polecenia. | |
--insecure
|
Podczas korzystania z protokołu SSL zezwalaj na niezabezpieczone połączenia serwera. | |
-o, --org
|
Ciąg znaków | (Wymagane) Organizacja Apigee. Musisz być administratorem organizacji. |
-r, --runtime
|
Ciąg znaków | (Tylko Private Cloud) Określa adres URL środowiska wykonawczego Twojej instancji Private Cloud. |
-v, --verbose
|
(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, zobaczysz wyniki 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
Być może jakiś czas po początkowym wygenerowaniu tokena JWT może wymagać zmiany pary kluczy (publicznego i prywatnego) przechowywanej przez Apigee Edge w zaszyfrowanej mapie par klucz-wartość (KVM). Proces generowania nowej pary kluczy jest nazywany rotacją kluczy. Podczas rotacji kluczy nowa para kluczy prywatny/publiczny jest generowana i przechowywana w KVM „istio” w organizacji/środowisku Apigee Edge. Oprócz tego stary klucz publiczny zostaje zachowany razem z pierwotną wartością identyfikatora klucza.Wykorzystanie
Jeśli korzystasz z chmury publicznej Edge:apigee-remote-service-cli token rotate-cert -c [config_file] -o [organization] -e [environment] -k [provision_key] -s [provision_secret] --kid [new_key_id]Jeśli korzystasz z 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]
Parametry
| Parametry | Typ | Opis |
|---|---|---|
-c, --config
|
Ciąg znaków | (Wymagane) Ścieżka do pliku konfiguracyjnego 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. Zapoznaj się z artykułem o korzystaniu z opcji --config.
|
-e, --env
|
Ciąg znaków | (Wymagane) Środowisko w Twojej organizacji. |
-h, --help
|
Wyświetla pomoc dotyczącą parametrów polecenia. | |
--insecure
|
Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z protokołu SSL | |
--truncate
|
int | Liczba certyfikatów do zachowania w jwks (domyślnie 2) |
-o, --org
|
Ciąg znaków | (Wymagane) Organizacja Apigee. Musisz być administratorem organizacji. |
-r, --runtime
|
Ciąg znaków | (Tylko Private Cloud) Określa adres URL środowiska wykonawczego Twojej instancji Private Cloud. |
-v, --verbose
|
(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
Korzystanie z pliku .netrc do podawania danych logowania
apigee-remote-service-cli automatycznie pobiera username i password (na potrzeby podstawowego uwierzytelniania tam, gdzie jest to wymagane) z pliku .netrc w katalogu głównym, jeśli korzystasz z chmury publicznej Edge i masz wpis api.enterprise.apigee.com komputera. Jeśli korzystasz z prywatnej chmury Apigee, wartość maszyny jest taka sama jak adres URL management (na przykład: http://192.162.55.100).
Na przykład w chmurze publicznej Edge w chmurze:
machine api.enterprise.apigee.com login jdoe@google.com password abc123Na przykład w Edge Private Cloud:
machine http://192.162.55.100 login jdoe@google.com password abc123
Polecenie wersji
Wydrukuj wersję interfejsu wiersza poleceń.
apigee-remote-service-cli version
Korzystanie z opcji polecenia --config
Opcja --config określa lokalizację pliku konfiguracyjnego wygenerowanego przez polecenie provision. Przydatną zaletą tej opcji jest to, że pozwala pominąć większość innych parametrów poleceń pobieranych przez interfejs wiersza poleceń z pliku konfiguracji.
Dostępne opcje to:- organizacja
- środowisko
- środowisko wykonawcze
- Zarządzanie
- niezabezpieczony
- przestrzeń nazw
- starsze
- Opdk
Polecenie provision możesz na przykład wykonać w ten sposób:
apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml
Plik konfiguracji
W tej sekcji znajduje się 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
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