Materiały referencyjne

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.

Wyświetlenie listy powiązań

Wyświetlanie listy wszystkich usług 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 Wszystko (Ciąg) Ś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,
‑‑environment 		Wymagane Wszystko (Ciąg) Środowisko w organizacji.
-h,
‑‑help 		Opcjonalnie Wszystko Wyświetla pomoc dotyczącą parametrów polecenia.
‑‑insecure Opcjonalnie Wszystko Podczas korzystania z protokołu SSL zezwalaj na niezabezpieczone połączenia serwera.
‑‑legacy Wymagane Tylko Edge Public Cloud Musisz ustawić tę flagę, jeśli używasz Apigee Edge w chmurze publicznej. Konfiguruje adresy URL zarządzania i środowiska wykonawczego dla Apigee Edge dla chmury publicznej.
-m,
‑‑management 		Wymagane Tylko chmura prywatna Edge (Ciąg) Podstawowy adres URL zarządzania dla instalacji Apigee Edge dla chmury prywatnej. Domyślny: https://api.enterprise.apigee.com
‑‑mfa Wymagane Tylko Edge Public Cloud (Ciąg) Token autoryzacji wielopoziomowej dla Apigee Edge dla chmury publicznej. Wymagane tylko wtedy, gdy na koncie Apigee Edge skonfigurowano MFA.
‑‑opdk Wymagane Tylko chmura prywatna Edge Musisz ustawić tę flagę, jeśli używasz Apigee Edge dla Private Cloud.
-o,
‑‑organization 		Wymagane Wszystko (Ciąg) Organizacja Apigee. Musisz być administratorem organizacji.
-p,
‑‑password 		Wymagana
(tylko uwierzytelnianie podstawowe)		 Tylko chmura publiczna i prywatna na brzegu sieci (Ciąg) Twoje hasło do Apigee. Hasło możesz opcjonalnie podać w pliku .netrc. Zapoznaj się też z informacjami o używaniu .netrc do podawania danych logowania.
-r,
‑‑runtime 		Wymagane Tylko chmura Private Cloud i Apigee – tylko połączenie hybrydowe (Ciąg) Określa adres URL środowiska wykonawczego dla instancji hybrydowej Private Cloud lub Apigee. Adres URL musi zaczynać się od https://. Przykład: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalnie Tylko chmura prywatna Edge (Ciąg) Określa certyfikat TLS po stronie klienta, klucz prywatny i główny urząd certyfikacji na potrzeby połączenia mTLS.
-t,
‑‑token 		Wymagany
(tylko uwierzytelnianie tokenem OAuth)		 Wszystko (Ciąg) Token OAuth lub SAML wygenerowany na podstawie informacji o koncie Apigee. Zastępuje wszystkie inne podane dane logowania.
-u,
‑‑username 		Wymagana
(tylko uwierzytelnianie podstawowe)		 Tylko chmura publiczna i prywatna na brzegu sieci (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ć swojej nazwy użytkownika w wierszu poleceń. Zapoznaj się też z artykułem o używaniu .netrc do podawania 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 organizacji Apigee Edge, konfiguruje certyfikat i generuje dane logowania potrzebne do skonfigurowania adaptera Apigee dla Envoy.

Wykorzystanie

apigee-remote-service-cli provision [flags]

Parametry

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

(Ciąg znaków) Użyj tej flagi, aby określić ścieżkę do pliku klucza konta usługi Google Cloud, gdzie konto usługi ma rolę Apigee Analytics Agent. Usługa jest używana przez adapter bezpośrednio do przesyłania danych analitycznych do Apigee. Jeśli korzystasz z hybrydowego środowiska Apigee, ta opcja umożliwia zainstalowanie hybrydowego środowiska wykonawczego w jednym klastrze, a adapter w innym.
-c,
‑‑config 		Wymagane Wszystko (Ciąg) Ś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,
‑‑environment 		Wymagane Wszystko (Ciąg) Środowisko w organizacji.
-f, ‑‑force-proxy-install Opcjonalnie Wszystko (Opcjonalnie) Wymusza ponowną instalację serwera proxy remote-service, jeśli jest on już zainstalowany w organizacji.
-h,
‑‑help 		Opcjonalnie Wszystko Wyświetla pomoc dotyczącą parametrów polecenia.
‑‑insecure Opcjonalnie Wszystko Podczas korzystania z protokołu SSL zezwalaj na niezabezpieczone połączenia serwera.
‑‑legacy Wymagane Tylko Edge Public Cloud Musisz ustawić tę flagę, jeśli używasz Apigee Edge w chmurze publicznej. Konfiguruje adresy URL zarządzania i środowiska wykonawczego dla Apigee Edge dla chmury publicznej.
-m,
‑‑management 		Wymagane Tylko chmura prywatna Edge (Ciąg) Podstawowy adres URL zarządzania dla instalacji Apigee Edge dla chmury prywatnej. Domyślny: https://api.enterprise.apigee.com
‑‑mfa Wymagane Tylko Edge Public Cloud Token autoryzacji wielopoziomowej dla Apigee Edge dla chmury publicznej. Wymagane tylko wtedy, gdy na koncie Apigee Edge skonfigurowano MFA.
-n, ‑‑namespace Opcjonalnie Wszystko (Ciąg) Emituj konfigurację jako obiekt ConfigMap Envoy w określonej przestrzeni nazw. Domyślny: apigee
‑‑opdk Wymagane Tylko chmura prywatna Edge Musisz ustawić tę flagę, jeśli używasz Apigee Edge dla Private Cloud.
-o,
‑‑organization 		Wymagane Wszystko (Ciąg) Organizacja Apigee. Aby udostępnić, musisz być administratorem organizacji.
-p,
‑‑password 		Wymagana
(tylko uwierzytelnianie podstawowe)		 Tylko chmura publiczna i prywatna na brzegu sieci (Ciąg) Twoje hasło do 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 Opcjonalnie Tylko Apigee hybrydowe (Liczba całkowita) Jeśli n > 0, wygeneruj nowy klucz prywatny i zachowaj n kluczy publicznych (tylko hybrydowe)
-r,
‑‑runtime 		Wymagane Tylko chmura Private Cloud i Apigee – tylko połączenie hybrydowe (Ciąg) Określa adres URL środowiska wykonawczego dla instancji hybrydowej Private Cloud lub Apigee. Adres URL musi zaczynać się od https://. Przykład: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalnie Tylko chmura prywatna Edge (Ciąg) Określa certyfikat TLS po stronie klienta, klucz prywatny i główny urząd certyfikacji na potrzeby połączenia mTLS.
-t,
‑‑token 		Wymagany
(tylko uwierzytelnianie tokenem OAuth)		 Wszystko (Ciąg) Token OAuth lub SAML wygenerowany na podstawie informacji o koncie Apigee. Zastępuje wszystkie inne podane dane logowania.
-u,
‑‑username 		Wymagana
(tylko uwierzytelnianie podstawowe)		 Tylko chmura publiczna i prywatna na brzegu sieci (Ciąg) Twoja nazwa użytkownika Apigee (zwykle adres e-mail). Opcjonalnie możesz podać nazwę użytkownika w pliku .netrc. Zapoznaj się też z artykułem o używaniu .netrc do podawania danych logowania.
-v,
‑‑verbose 		Opcjonalnie Wszystko (Opcjonalnie) Generuje szczegółowe dane wyjściowe.
‑‑virtual-hosts Opcjonalnie Tylko chmura prywatna Edge (Ciąg) Zastępuje domyślne hosty wirtualne, czyli default,secure. Użyj tej opcji, jeśli w środowisku organizacji Edge masz określone hosty wirtualne inne niż te domyślne.

Przykład

Jak widać na przykładzie poniżej, dane wyjściowe polecenia provision należy zapisać w pliku, który jest używany jako dane wejściowe innych adapterów Apigee na potrzeby operacji Envoy.

Przykład: 

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

Polecenie Przykład

Tworzy i wyświetla przykładowe pliki konfiguracji.

Tworzenie przykładowych plików konfiguracji

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

Wykorzystanie

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

Opis

To polecenie wymaga prawidłowego pliku config.yaml jako danych wejściowych. Jest to plik wygenerowany podczas 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 Obecność Używane z produktami Opis
‑‑adapter‑host Wymagane tylko dla szablonów Envoy Wszystko (Ciąg) Nazwa hosta adaptera (domyślnie: localhost)
-c, ‑‑config Wymagane Wszystko (Ciąg) Ś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 Opcjonalnie Wszystko Wymuś zastąpienie istniejącego katalogu.
-h, ‑‑help Opcjonalnie Wszystko Wyświetla pomoc dotyczącą parametrów polecenia.
‑‑host Wymagane tylko dla szablonów Envoy Wszystko (Ciąg) Docelowy host usługi (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.
Wartość domyślna: ./samples
‑‑tag Wymagane tylko dla szablonów Istio Wszystko (Ciąg) Tag wersji obrazu adaptera Envoy. Domyślny: v2.0.0
-t, ‑‑template Wymagane Wszystko (Ciąg) Nazwa szablonu Envoy lub Istio. Aby zobaczyć dostępną listę szablonów, wykonaj polecenie apigee-remote-service samples templates.
‑‑tls Opcjonalnie, tylko w przypadku szablonów Envoy Wszystko (Ciąg) Katalog zawierający pliki tls.key i tls.crt używany na potrzeby usługi adaptera.

Przykład 

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

Wyświetlenie listy dostępnych szablonów

Zawiera listę szablonów, których można używać z parametrem --templates w poleceniu 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 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

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 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,
‑‑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) Klucz z danymi logowania znalezionymi w aplikacji dla deweloperów Apigee zgodnie z opisem w sekcji Jak uzyskać klucz interfejsu API.
‑‑insecure Opcjonalnie Wszystko Podczas korzystania z protokołu SSL zezwalaj na niezabezpieczone połączenia serwera.
‑‑legacy Wymagane Tylko Edge Public Cloud Musisz ustawić tę flagę, jeśli używasz Apigee Edge w chmurze publicznej. Konfiguruje adresy URL zarządzania i środowiska wykonawczego dla Apigee Edge dla chmury publicznej.
‑‑opdk Wymagane Tylko chmura prywatna Edge Musisz ustawić tę flagę, jeśli używasz Apigee Edge dla Private Cloud.
-o,
‑‑organization 		Wymagane Wszystko (Ciąg) Organizacja Apigee. Musisz być administratorem organizacji.
-r,
‑‑runtime 		Wymagane Tylko chmura Private Cloud i Apigee – tylko połączenie hybrydowe (Ciąg) Określa adres URL środowiska wykonawczego dla instancji hybrydowej Private Cloud lub Apigee. Adres URL musi zaczynać się od https://. Przykład: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret Wymagane Wszystko (Ciąg) Dane logowania Secret w aplikacji dla deweloperów Apigee zgodnie z opisem w sekcji Jak uzyskać klucz interfejsu API.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalnie Tylko chmura prywatna Edge (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

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

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 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,
‑‑environment 		Wymagane Wszystko (Ciąg) Środowisko w organizacji.
-f,
‑‑file 		Wymagane Wszystko (Ciąg) Plik tokena (domyślnie: użyj stdin)
-h,
‑‑help 		Opcjonalnie Wszystko Wyświetla pomoc dotyczącą parametrów polecenia.
‑‑insecure Opcjonalnie Wszystko Podczas korzystania z protokołu SSL zezwalaj na niezabezpieczone połączenia serwera.
‑‑legacy Wymagane Tylko Edge Public Cloud Musisz ustawić tę flagę, jeśli używasz Apigee Edge w chmurze publicznej. Konfiguruje adresy URL zarządzania i środowiska wykonawczego dla Apigee Edge dla chmury publicznej.
‑‑opdk Wymagane Tylko chmura prywatna Edge Musisz ustawić tę flagę, jeśli używasz Apigee Edge dla Private Cloud.
-o,
‑‑organization 		Wymagane Wszystko (Ciąg) Organizacja Apigee. Musisz być administratorem organizacji.
-r,
‑‑runtime 		Wymagane Tylko chmura Private Cloud i Apigee – tylko połączenie hybrydowe (Ciąg) Określa adres URL środowiska wykonawczego dla instancji hybrydowej Private Cloud lub Apigee. Adres URL musi zaczynać się od https://. Przykład: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalnie Tylko chmura prywatna Edge (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, 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 w jej 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. Oprócz tego stary klucz publiczny zostaje zachowany razem 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 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,
‑‑environment 		Wymagane Wszystko (Ciąg) Środowisko w organizacji.
-h,
‑‑help 		Opcjonalnie Tylko chmura publiczna i prywatna na brzegu sieci Wyświetla pomoc dotyczącą parametrów polecenia.
--k, --key Wymagane Tylko chmura publiczna i prywatna na brzegu sieci (Ciąg) Klucz obsługi administracyjnej.
‑‑insecure Opcjonalnie Tylko chmura publiczna i prywatna na brzegu sieci Podczas korzystania z protokołu SSL zezwalaj na niezabezpieczone połączenia serwera.
‑‑legacy Wymagane Tylko Edge Public Cloud Musisz ustawić tę flagę, jeśli używasz Apigee Edge w chmurze publicznej. Konfiguruje adresy URL zarządzania i środowiska wykonawczego dla Apigee Edge dla chmury publicznej.
‑‑opdk Wymagane Tylko chmura prywatna Edge Musisz ustawić tę flagę, jeśli używasz Apigee Edge dla Private Cloud.
-o,
‑‑organization 		Wymagane Tylko chmura publiczna i prywatna na brzegu sieci (Ciąg) Organizacja Apigee. Musisz być administratorem organizacji.
-r,
‑‑runtime 		Wymagane Tylko chmura prywatna Edge (Ciąg) Określa adres URL środowiska wykonawczego dla instancji hybrydowej Private Cloud lub Apigee. Adres URL musi zaczynać się od https://. Przykład: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret Wymagane Wszystko (Ciąg) Obiekt tajny rezerwacji.
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalnie Tylko chmura prywatna Edge (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 (wartość domyślna to 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

Utwórz token wewnętrzny

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 Apigee hybrydowe (Ciąg) Ś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.
-d,
‑‑duration 		Wymagane Tylko Apigee hybrydowe (Ciąg) prawidłowy czas wewnętrznego tokena JWT od momentu utworzenia (domyślnie: 10m0s (10 minut)).
-e,
‑‑environment 		Wymagane Tylko Apigee hybrydowe (Ciąg) Środowisko w organizacji.
-h,
‑‑help 		Opcjonalnie Tylko Apigee hybrydowe Wyświetla pomoc dotyczącą parametrów polecenia.
‑‑insecure Opcjonalnie Tylko Apigee hybrydowe Podczas korzystania z protokołu SSL zezwalaj na niezabezpieczone połączenia serwera.
-o,
‑‑organization 		Wymagane Tylko Apigee hybrydowe (Ciąg) Organizacja Apigee. Musisz być administratorem organizacji.
-r,
‑‑runtime 		Wymagane Tylko Apigee hybrydowe (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 Apigee hybrydowe (Opcjonalnie) Generuje szczegółowe dane wyjściowe.

Polecenie wersji

Wydrukuj wersję interfejsu wiersza poleceń.

apigee-remote-service-cli version

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 abc123
Na przykład w Edge Private Cloud: 
machine http://192.162.55.100
login jdoe@google.com
password abc123

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