Materiały referencyjne

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

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

Polecenie wyświetlania listy powiązań

Wyświetla listę wszystkich usług 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 Wszystko (Ciąg znaków) Ś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 Używanie opcji ‑‑config.
-e,
‑‑environment 		Wymagane Wszystko (string) Ś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 czasu wykonywania dla Apigee Edge w Public Cloud.
-m,
‑‑management 		Wymagane Tylko Edge Private Cloud (String) Adres URL bazy zarządzania instalacji 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 wtedy, gdy na koncie Apigee Edge skonfigurowano uwierzytelnianie wieloetapowe.
‑‑opdk Wymagane Tylko Edge Private Cloud Jeśli używasz Apigee Edge w chmurze prywatnej, musisz ustawić tę flagę.
-o,
‑‑organization 		Wymagane Wszystko (Ciąg) Organizacja Apigee. Musisz być administratorem organizacji.
-p,
‑‑password 		Wymagany
(tylko uwierzytelnianie podstawowe)		 Tylko Edge Public i Private Cloud (string) Twoje hasło do Apigee. Opcjonalnie możesz podać hasło w pliku .netrc. Zobacz też: Używanie pliku .netrc do danych logowania.
-r,
‑‑runtime 		Wymagane Tylko Edge Private Cloud i hybrydowa usługa Apigee (Ciąg) Określa adres URL środowiska wykonawczego dla instancji Private Cloud lub hybrydowej Apigee. Adres URL musi zaczynać się od https://. Na przykład: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalnie 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 autoryzacja za pomocą tokena OAuth)		 Wszystko (String) Token OAuth lub SAML wygenerowany na podstawie informacji z konta Apigee. Zastępuje wszystkie inne podane dane logowania.
-u,
‑‑username 		Wymagany
(tylko uwierzytelnianie podstawowe)		 Tylko Edge Public i Private Cloud (String) 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ż Korzystanie z pliku .netrc do 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

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

Polecenie apigee-remote-service-cli provision instaluje w organizacji Apigee Edge dwa serwery proxy API, konfiguruje certyfikat i generuje dane logowania, których potrzebujesz 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 Hybrid i Apigee X

(Ciąg znaków) Użyj tej 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. SA jest używany przez adapter do bezpośredniego przesyłania danych analitycznych do Apigee. Jeśli korzystasz z hybrydowej wersji Apigee, ta opcja umożliwia zainstalowanie środowiska wykonawczego hybrydowego w jednym klastrze, a adaptera w innym.
-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 polecenia, ponieważ interfejs wiersza poleceń może pobrać je bezpośrednio z pliku konfiguracyjnego. Zobacz Korzystanie z opcji ‑‑config.
-e,
‑‑environment 		Wymagane Wszystko (string) Środowisko w organizacji.
-f, ‑‑force-proxy-install Opcjonalnie Wszystko (Opcjonalnie) Wymusza ponowną instalację serwera proxy remote-service, jeśli jest on 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 czasu wykonywania dla Apigee Edge w Public Cloud.
-m,
‑‑management 		Wymagane Tylko Edge Private Cloud (String) Adres URL bazy zarządzania instalacji Apigee Edge for Private Cloud. Domyślnie: https://api.enterprise.apigee.com
‑‑mfa Wymagane Tylko Edge Public Cloud Token uwierzytelniania dwuskładnikowego dla Apigee Edge for Public Cloud. Wymagane tylko wtedy, gdy na koncie Apigee Edge masz skonfigurowane MFA.
-n, ‑‑namespace Opcjonalnie Wszystko (Ciąg znaków) Wyemituj konfigurację jako plik ConfigMap w Envoy w określonej przestrzeni nazw. Domyślnie: apigee
‑‑opdk Wymagane Tylko Edge Private Cloud Jeśli używasz Apigee Edge w chmurze prywatnej, musisz ustawić tę flagę.
-o,
‑‑organization 		Wymagane Wszystko (string) Organizacja Apigee. Aby skonfigurować usługę, musisz być administratorem organizacji.
-p,
‑‑password 		Wymagane
(tylko uwierzytelnianie podstawowe)		 Tylko Edge Public i Private Cloud (string) Twoje hasło do Apigee. Opcjonalnie możesz podać hasło w pliku
.netrc. W takim przypadku nie musisz podawać hasła w wierszu poleceń. Zapoznaj się też z artykułem o używaniu domeny .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 w przypadku hybrydowym)
-r,
‑‑runtime 		Wymagane Tylko Edge Private Cloud i hybrydowa usługa Apigee (Ciąg) Określa adres URL środowiska wykonawczego dla instancji Private Cloud lub hybrydowej Apigee. Adres URL musi zaczynać się od https://. Na przykład: https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		Opcjonalnie 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 autoryzacja za pomocą tokena OAuth)		 Wszystko (String) Token OAuth lub SAML wygenerowany na podstawie informacji z konta Apigee. Zastępuje wszystkie inne podane dane logowania.
-u,
‑‑username 		Wymagany
(tylko uwierzytelnianie podstawowe)		 Tylko Edge Public i Private Cloud (String) 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 domeny .netrc na potrzeby danych logowania.
-v,
‑‑verbose 		Opcjonalnie Wszystko (Opcjonalnie) Wyświetla szczegółowe dane wyjściowe.
‑‑virtual-hosts Opcjonalnie Tylko Edge Private Cloud (Tekst) Zastępuje domyślne hosty wirtualne, które są default,secure. Użyj tej opcji, jeśli masz hosty wirtualnych określonych dla środowiska organizacji w Edge innych niż te domyślne.

Przykład

Jak widać w poniższym przykładzie, ważne jest przechwytywanie w pliku danych wyjściowych polecenia provision, które są używane jako dane wejściowe dla 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 do natywnych wdrożeń Envoy i Istio.

Wykorzystanie

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

Opis

To polecenie wymaga jako danych wejściowych prawidłowego pliku config.yaml. Ten plik wejściowy to plik, który został wygenerowany w ramach obsługi administracyjnej. Domyślnie pliki przykładowe są zapisywane w katalogu o nazwie ./samples. To polecenie tworzy ten katalog.

Jeśli używasz natywnej wersji Envoy, polecenie przyjmuje hosta docelowej usługi i żądaną nazwę jego klastra. Ustawia też niestandardowe połączenie SSL z serwerem proxy Envoy do klastra usługi zdalnej, jeśli folder zawierający tls.key i tls.crt jest udostępniany przez --tls.

Jeśli używasz Istio, w którym serwer proxy Envoy działa jako sidecar, a docelowe nie jest określone, wygenerowany zostanie przykład httpbin. W przeciwnym razie odpowiadasz 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 Wszystko (Ciąg) Nazwa hosta adaptera (domyślnie: localhost)
-c, ‑‑config Wymagane Wszystko (String) Ścieżka do pliku konfiguracji 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 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 znaków) 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 (String) Katalog, w którym mają być tworzone przykładowe pliki konfiguracji.
Domyślna: ./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 znaków) Nazwa szablonu Envoy lub Istio. Aby wyświetlić listę dostępnych szablonów, wykonaj polecenieapigee-remote-service samples templates.
‑‑tls Opcjonalne, tylko w przypadku szablonów Envoy Wszystko (Ciąg) Katalog zawierający pliki tls.key i tls.crt używane na potrzeby usługi adaptera.

Przykład 

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

Lista dostępnych opcji szablonu

Wyświetla listę szablonów dostępnych do użycia z parametrem --templates 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 dotyczące tokenów

Do wywoływania uwierzytelnionych wywołań proxy interfejsu API możesz użyć tokena JWT zamiast klucza interfejsu API. Polecenia dotyczące tokenów umożliwiają tworzenie, sprawdzanie i rotację tokenów JWT w tym celu.

Tworzenie tokena JWT

Możesz użyć tokena JWT, aby wykonywać uwierzytelnione wywołania serwera proxy interfejsu API do zdalnego celu usługi. Zobacz też Korzystanie z uwierzytelniania opartego na tokenach JWT.

Wykorzystanie

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

Parametry

Parametry Obecność Używane z produktami Opis
-c,
‑‑config 		Wymagane Wszystko (Ciąg znaków) Ś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 Korzystanie z opcji ‑‑config.
-e,
‑‑environment 		Wymagane Wszystko (string) Środowisko w organizacji.
-h,
‑‑help 		Opcjonalnie Wszystko Wyświetla pomoc dotyczącą parametrów polecenia.
--i, --id Wymagane Wszystko (Ciąg znaków) klucz to dane logowania, które znajdziesz w aplikacji dla deweloperów Apigee zgodnie z opisem w 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 czasu wykonywania dla Apigee Edge w Public Cloud.
‑‑opdk Wymagane Tylko Edge Private Cloud Jeśli używasz Apigee Edge w chmurze prywatnej, musisz ustawić tę flagę.
-o,
‑‑organization 		Wymagane Wszystko (string) Organizacja Apigee. Musisz być administratorem organizacji.
-r,
‑‑runtime 		Wymagane Tylko Edge Private Cloud i hybrydowa usługa Apigee (String) Określa adres URL środowiska uruchomieniowego instancji Private Cloud lub hybrydowej instancji Apigee. Adres URL musi zaczynać się od https://. Na przykład: https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret Wymagane Wszystko (Ciąg znaków) Tajemne dane logowania znalezione w aplikacji dla deweloperów Apigee zgodnie z opisem w 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

W przypadku powodzenia 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 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 polecenia, ponieważ interfejs wiersza poleceń może pobrać je bezpośrednio z pliku konfiguracyjnego. Zobacz Używanie opcji ‑‑config.
-e,
‑‑environment 		Wymagane Wszystko (string) Środowisko w organizacji.
-f,
‑‑file 		Wymagane Wszystko (Ciąg znaków) 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 czasu wykonywania dla Apigee Edge w Public Cloud.
‑‑opdk Wymagane Tylko Edge Private Cloud Jeśli używasz Apigee Edge w chmurze prywatnej, musisz ustawić tę flagę.
-o,
‑‑organization 		Wymagane Wszystko (string) Organizacja Apigee. Musisz być administratorem organizacji.
-r,
‑‑runtime 		Wymagane Tylko Edge Private Cloud i hybrydowa usługa Apigee (Ciąg) Określa adres URL środowiska wykonawczego dla instancji Private Cloud lub hybrydowej Apigee. Adres URL musi zaczynać się od https://. Na 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

W przypadku powodzenia 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.

Rotacja tokena JWT

Po wygenerowaniu tokena JWT może okazać się konieczna zmiana pary kluczy publiczny-prywatny przechowywanej przez Apigee w zaszyfrowanej mapie klucz-wartość (KVM). Ten proces generowania nowej pary kluczy nazywa się rotacją kluczy. Gdy rotujesz klucze, nowa para kluczy prywatnych/publicznych jest generowana i przechowywana w KVM „istio” w organizacji/środowisku Apigee. Dodatkowo stary klucz publiczny jest przechowywany 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 znaków) Ścieżka do pliku konfiguracyjnego zdalnej usługi 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 Wszystko (string) Środowisko w organizacji.
-h,
‑‑help 		Opcjonalnie Tylko Edge Public i Private Cloud Wyświetla pomoc dotyczącą parametrów polecenia.
--k, --key Wymagane Tylko Edge Public i Private Cloud (Ciąg) Klucz udostępniania.
‑‑insecure Opcjonalnie Tylko Edge Public i Private Cloud 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 czasu wykonywania dla Apigee Edge w Public Cloud.
‑‑opdk Wymagane Tylko Edge Private Cloud Jeśli używasz Apigee Edge w chmurze prywatnej, musisz ustawić tę flagę.
-o,
‑‑organization 		Wymagane Tylko Edge Public i Private Cloud (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://. Na 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 (Tekst) Określa certyfikat TLS po stronie klienta, klucz prywatny i główny urząd certyfikacji dla 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

Tworzenie 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 usługa Apigee (Ciąg znaków) Ścieżka do pliku konfiguracyjnego zdalnej usługi 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 Korzystanie z opcji ‑‑config.
-d,
‑‑duration 		Wymagane Tylko hybrydowa usługa Apigee (Ciąg znaków) czas ważności wewnętrznego tokena JWT od momentu utworzenia (domyślnie: 10m0s (10 minut)).
-e,
‑‑environment 		Wymagane Tylko Apigee hybrydowa (Ciąg) Środowisko w organizacji.
-h,
‑‑help 		Opcjonalnie Tylko hybrydowa usługa Apigee Wyświetla pomoc dotyczącą parametrów polecenia.
‑‑insecure Opcjonalnie Tylko hybrydowa usługa Apigee Zezwalaj na niezabezpieczone połączenia z serwerem podczas korzystania z protokołu SSL.
-o,
‑‑organization 		Wymagane Tylko Apigee hybrydowa (string) Organizacja Apigee. Musisz być administratorem organizacji.
-r,
‑‑runtime 		Wymagane Tylko hybrydowa usługa Apigee (Ciąg) Określa adres URL środowiska wykonawczego instancji hybrydowej Apigee. Adres URL musi zaczynać się od https://. Na przykład: https://apitest.apigee-hybrid-docs.net
-v,
‑‑verbose 		Opcjonalnie Tylko hybrydowa usługa Apigee (Opcjonalnie) Generuje szczegółowe dane wyjściowe.

Polecenie version

Wydrukuj wersję interfejsu wiersza poleceń.

apigee-remote-service-cli version

Korzystanie z pliku .netrc do logowania

Jeśli korzystasz z Edge Public Cloud i masz wpis dotyczący maszyny api.enterprise.apigee.com, usługa apigee-remote-service-cli automatycznie pobiera wartości username i password (w razie potrzeby do uwierzytelniania podstawowego) z pliku .netrc w Twoim katalogu domowym. Jeśli korzystasz z Apigee Private Cloud, wartość maszyny jest taka sama jak adres URL 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 konfiguracji wygenerowanego przez polecenie provision. Przydatną zaletą tej opcji jest to, że pozwala ona pominąć większość innych parametrów polecenia, które interfejs CLI pobiera z pliku konfiguracyjnego. 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

Ta sekcja zawiera 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