Diese Seite wurde von der Cloud Translation API übersetzt.

Referenz

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation. Weitere Informationen

Mit der apigee-remote-service-cli-Befehlszeile (CLI) können Sie den Apigee Adapter für Envoy bereitstellen und verwalten.

Befehl zum Auflisten von Bindungen

Alle API-Produkte auflisten, die an den Remote-Dienst gebunden sind.

Nutzung

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

Parameter

Parameter	Präsenz	Mit Produkten verwendet	Beschreibung
`-c, ‑‑config`	Erforderlich	Alle	(String) Der Pfad zur Konfigurationsdatei von Apigee Remote Service. Tipp: Mit diesem Flag können Sie die meisten anderen Befehlsparameter weglassen, da die Befehlszeile sie direkt aus der Konfigurationsdatei abrufen kann. Weitere Informationen finden Sie unter Option `‑‑config` verwenden.
`-e, ‑‑environment`	Erforderlich	Alle	(String) Eine Umgebung in Ihrer Organisation.
`-h, ‑‑help`	Optional	Alle	Zeigt Hilfe zu den Befehlsparametern an.
`‑‑insecure`	Optional	Alle	Unsichere Serververbindungen mit SSL zulassen.
`‑‑legacy`	Erforderlich	Nur für Edge Public Cloud	Sie müssen dieses Flag festlegen, wenn Sie Apigee Edge for Public Cloud verwenden. Legt die Verwaltungs- und Laufzeit-URLs für Apigee Edge for Public Cloud fest.
`-m, ‑‑management`	Erforderlich	Nur für Edge Private Cloud	(String) Die Management-Basis-URL für Ihre Installation von Apigee Edge for Private Cloud. Standardwert: `https://api.enterprise.apigee.com`
`‑‑mfa`	Erforderlich	Nur für Edge Public Cloud	(String) Multi-Faktor-Autorisierungstoken für Apigee Edge for Public Cloud. Nur bei MFA erforderlich ist in Ihrem Apigee Edge-Konto eingerichtet.
`‑‑opdk`	Erforderlich	Nur für Edge Private Cloud	Sie müssen dieses Flag festlegen, wenn Sie Apigee Edge for Private Cloud verwenden.
`-o, ‑‑organization`	Erforderlich	Alle	(String) Eine Apigee-Organisation. Sie müssen ein Organisationsadministrator sein.
`-p, ‑‑password`	Erforderlich (nur Basic-Auth)	Nur Edge Public und Private Cloud	(String) Ihr Apigee-Passwort. Optional können Sie das Passwort in einer `.netrc`-Datei angeben. Weitere Informationen finden Sie unter .netrc für Anmeldedaten verwenden.
`-r, ‑‑runtime`	Erforderlich	Nur Edge Private Cloud und Apigee Hybrid	(String) Gibt die Laufzeit-URL für die Private Cloud- oder Apigee Hybrid-Instanz an. Die URL muss mit `https://` beginnen. Beispiel: `https://apitest.apigee-hybrid-docs.net`
`‑‑tls‑cert ‑‑tls‑key ‑‑tls‑ca`	Optional	Nur für Edge Private Cloud	(String) Gibt das clientseitige TLS-Zertifikat, den privaten Schlüssel und die Stamm-CA für mTLS-Verbindungen an.
`-t, ‑‑token`	Erforderlich (nur OAuth-Token-Authentifizierung)	Alle	(String) Ein OAuth- oder SAML-Token, das Sie anhand Ihrer Apigee-Kontoinformationen generieren. Überschreibt alle anderen angegebenen Anmeldedaten.
`-u, ‑‑username`	Erforderlich (nur Basic-Auth)	Nur Edge Public und Private Cloud	(String) Ihr Apigee-Nutzername (in der Regel eine E-Mail-Adresse). Sie können den Nutzernamen optional in einer `.netrc`-Datei angeben. In diesem Fall müssen Sie Ihren Nutzernamen nicht in der Befehlszeile angeben. Weitere Informationen finden Sie unter .netrc für Anmeldedaten verwenden.
`-v, ‑‑verbose`	Optional	Alle	(Optional) Erzeugt eine ausführliche Ausgabe.

Beispiel

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

Beispielausgabe

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:

Hilfebefehl

Onlinehilfe wird für alle apigee-remote-service-cli-Befehle bereitgestellt. Geben Sie einfach Folgendes ein:

apigee-remote-service-cli help

Wenn Sie Hilfe zu einem Befehl benötigen, geben Sie Folgendes ein:

apigee-remote-service-cli [command] help

Beispiel:

apigee-remote-service-cli provision help

Bereitstellungsbefehl

Mit dem Befehl apigee-remote-service-cli provision werden zwei API-Proxys in Ihrer Apigee Edge-Organisation installiert, ein Zertifikat eingerichtet und Anmeldedaten generiert, die Sie zum Konfigurieren von Apigee Adapter for Envoy benötigen.

Nutzung

apigee-remote-service-cli provision [flags]

Parameter

Parameter	Präsenz	Mit Produkten verwendet	Beschreibung
`‑‑analytics-sa`	Optional	Nur Apigee Hybrid und Apigee X	(String) Mit diesem Flag geben Sie den Pfad zu einer Schlüsseldatei des Google Cloud-Dienstkontos an, wobei das Dienstkonto die Rolle `Apigee Analytics Agent` hat. SA wird vom Adapter verwendet, um Analysedaten direkt in Apigee hochzuladen. Wenn Sie Apigee Hybrid verwenden, können Sie mit dieser Option die Hybrid-Laufzeit in einem Cluster und den Adapter in einem anderen Cluster installieren. Hinweis: Wir empfehlen Ihnen, die Installation zu aktualisieren, um die direkte Methode zum Hochladen von Analysen zu verwenden. Die nicht direkte Methode zum Hochladen von Analysen, in der Fluentd verwendet wurde, wurde verworfen.
`-c, ‑‑config`	Erforderlich	Alle	(String) Der Pfad zur Konfigurationsdatei von Apigee Remote Service. Tipp: Mit diesem Flag können Sie die meisten anderen Befehlsparameter weglassen, da die Befehlszeile sie direkt aus der Konfigurationsdatei abrufen kann. Weitere Informationen finden Sie unter Option `‑‑config` verwenden.
`-e, ‑‑environment`	Erforderlich	Alle	(String) Eine Umgebung in Ihrer Organisation.
`-f, ‑‑force-proxy-install`	Optional	Alle	(Optional) Erzwingt die Neuinstallation des `remote-service`-Proxys, wenn er bereits in Ihrer Organisation installiert ist. UPGRADE HINWEIS: Wenn Sie ein Upgrade auf Version 1.1.0 oder eine spätere Version durchführen, müssen Sie das Flag `--force-proxy-install` einfügen, um den vorhandenen Remotedienst-Proxy zu ersetzen, der auf Apigee bereitgestellt wird.
`-h, ‑‑help`	Optional	Alle	Zeigt Hilfe zu den Befehlsparametern an.
`‑‑insecure`	Optional	Alle	Unsichere Serververbindungen mit SSL zulassen.
`‑‑legacy`	Erforderlich	Nur für Edge Public Cloud	Sie müssen dieses Flag festlegen, wenn Sie Apigee Edge for Public Cloud verwenden. Legt die Verwaltungs- und Laufzeit-URLs für Apigee Edge for Public Cloud fest.
`-m, ‑‑management`	Erforderlich	Nur für Edge Private Cloud	(String) Die Management-Basis-URL für Ihre Installation von Apigee Edge for Private Cloud. Standardwert: `https://api.enterprise.apigee.com`
`‑‑mfa`	Erforderlich	Nur für Edge Public Cloud	Multi-Faktor-Autorisierungstoken für Ihr Apigee Edge for Public Cloud. Nur bei MFA erforderlich ist in Ihrem Apigee Edge-Konto eingerichtet.
`-n, ‑‑namespace`	Optional	Alle	(String) Konfiguration als Envoy-ConfigMap im angegebenen Namespace. Standardwert: `apigee`
`‑‑opdk`	Erforderlich	Nur für Edge Private Cloud	Sie müssen dieses Flag festlegen, wenn Sie Apigee Edge for Private Cloud verwenden.
`-o, ‑‑organization`	Erforderlich	Alle	(String) Eine Apigee-Organisation. Sie müssen ein Organisationsadministrator sein, um bereitgestellt zu werden.
`-p, ‑‑password`	Erforderlich (nur Basic-Auth)	Nur Edge Public und Private Cloud	(String) Ihr Apigee-Passwort. Optional können Sie das Passwort in einer Datei `.netrc`. In diesem Fall müssen Sie Ihr Passwort nicht in der Befehlszeile angeben. Siehe auch .netrc als Anmeldedaten verwenden
`‑‑rotate-int`	Optional	Nur Apigee Hybrid	(Ganzzahl) Wenn n > 0, generieren Sie einen neuen privaten Schlüssel und behalten Sie n öffentliche Schlüssel (nur Hybrid) bei.
`-r, ‑‑runtime`	Erforderlich	Nur Edge Private Cloud und Apigee Hybrid	(String) Gibt die Laufzeit-URL für die Private Cloud- oder Apigee Hybrid-Instanz an. Die URL muss mit `https://` beginnen. Beispiel: `https://apitest.apigee-hybrid-docs.net`
`‑‑tls‑cert ‑‑tls‑key ‑‑tls‑ca`	Optional	Nur für Edge Private Cloud	(String) Gibt das clientseitige TLS-Zertifikat, den privaten Schlüssel und die Stamm-CA für mTLS-Verbindungen an.
`-t, ‑‑token`	Erforderlich (nur OAuth-Token-Authentifizierung)	Alle	(String) Ein OAuth- oder SAML-Token, das Sie anhand Ihrer Apigee-Kontoinformationen generieren. Überschreibt alle anderen angegebenen Anmeldedaten.
`-u, ‑‑username`	Erforderlich (nur Basic-Auth)	Nur Edge Public und Private Cloud	(String) Ihr Apigee-Nutzername (in der Regel eine E-Mail-Adresse). Sie können den Nutzernamen optional in einer `.netrc`-Datei angeben. Weitere Informationen finden Sie unter .netrc für Anmeldedaten verwenden.
`-v, ‑‑verbose`	Optional	Alle	(Optional) Erzeugt eine ausführliche Ausgabe.
`‑‑virtual-hosts`	Optional	Nur für Edge Private Cloud	(String) Überschreibt die standardmäßigen virtuellen Hosts, die `default,secure` sind. Verwenden Sie diese Option, wenn Sie virtuelle Hosts für Ihre Edge-Organisationsumgebung außer den Standardeinstellungen festgelegt haben.

Beispiel

Wie das folgende Beispiel zeigt, ist es wichtig, die Ausgabe des Befehls provision in einer Datei zu erfassen, die als Eingabe für andere Apigee Adapter for Envoy-Vorgänge verwendet wird.

Beispiel:

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

Befehl "Beispiele"

Beispielkonfigurationsdateien erstellen und auflisten

Beispielkonfigurationsdateien erstellen

Beispielkonfigurationsdateien für native Envoy- und Istio-Bereitstellungen erstellen

Nutzung

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

Beschreibung

Für diesen Befehl ist als Eingabe eine gültige config.yaml-Datei erforderlich. Diese Eingabedatei ist die Datei, die durch die Bereitstellung generiert wurde. Standardmäßig werden die Beispieldateien in ein Verzeichnis mit dem Namen ./samples ausgegeben. Mit diesem Befehl wird dieses Verzeichnis für Sie erstellt.

Wenn Sie natives Envoy verwenden, verwendet der Befehl den Zieldiensthost und den gewünschten Namen für seinen Cluster. Außerdem wird eine benutzerdefinierte SSL-Verbindung vom Envoy-Proxy zum Remote-Dienstcluster eingerichtet, wenn ein Ordner mit tls.key und tls.crt über --tls bereitgestellt wird.

Wenn Sie Istio verwenden, wobei der Envoy-Proxy als Sidecar fungiert und das Ziel nicht spezifiziert ist, wird das Beispiel httpbin generiert. Andernfalls sind Sie für die Vorbereitung der Konfigurationsdateien für die Bereitstellung Ihrer Zieldienste verantwortlich.

Parameter

Parameter	Präsenz	Mit Produkten verwendet	Beschreibung
`‑‑adapter‑host`	Nur für Envoy-Vorlagen erforderlich	Alle	(String) Der Adapterhostname (Standard: `localhost`)
`-c, ‑‑config`	Erforderlich	Alle	(String) Pfad zur Konfigurationsdatei von Apigee Remote Service. Tipp: Mit diesem Flag können Sie die meisten anderen Befehlsparameter weglassen, da die Befehlszeile sie direkt aus der Konfigurationsdatei abrufen kann. Weitere Informationen finden Sie unter Option `‑‑config` verwenden.
`-f, ‑‑force`	Optional	Alle	Überschreiben des vorhandenen Verzeichnisses erzwingen.
`-h, ‑‑help`	Optional	Alle	Zeigt Hilfe zu den Befehlsparametern an.
`‑‑host`	Nur für Envoy-Vorlagen erforderlich	Alle	(String) Der Zieldiensthost (Standard `httpbin.org`)
`-n, ‑‑name`	Erforderlich	Alle	(String) Der Name des Zieldienstes (Standard `httpbin.org`)
`‑‑out`	Optional	Alle	(String) Das Verzeichnis, in dem die Beispielkonfigurationsdateien erstellt werden sollen. Standard: `./samples`
`‑‑tag`	Nur für Istio-Vorlagen erforderlich	Alle	(String) Das Versions-Tag des Envoy-Adapter-Image. Standardwert: `v2.0.0`
`-t, ‑‑template`	Erforderlich	Alle	(String) Der Name der Envoy- oder Istio-Vorlage. Führen Sie den Befehl `apigee-remote-service samples templates` aus, um die verfügbare Vorlagenliste aufzurufen.
`‑‑tls`	Optional, nur für Envoy-Vorlagen	Alle	(String) Das Verzeichnis mit den Dateien `tls.key` und `tls.crt`, die für den Adapterdienst verwendet werden.

Beispiel

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

Verfügbare Vorlagenoptionen auflisten

Listet die Vorlagen auf, die mit dem Parameter --templates für den Befehl samples verwendet werden können.

Nutzung

apigee-remote-service-cli samples templates

Parameter

–

Beispiel

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

Tokenbefehle

Sie können authentifizierte API-Proxyaufrufe mit einem JWT-Token durchführen, anstatt einen API-Schlüssel zu verwenden. Mit den Tokenbefehlen können Sie JWT-Tokens zu diesem Zweck erstellen, prüfen und rotieren.

JWT-Token erstellen

Sie können ein JWT-Token verwenden, um authentifizierte API-Proxyaufrufe an ein Remote-Dienstziel zu senden. Siehe auch JWT-basierte Authentifizierung verwenden.

Nutzung

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

Parameter

Parameter	Präsenz	Mit Produkten verwendet	Beschreibung
`-c, ‑‑config`	Erforderlich	Alle	(String) Der Pfad zur Konfigurationsdatei von Apigee Remote Service. Tipp: Mit diesem Flag können Sie die meisten anderen Befehlsparameter weglassen, da die Befehlszeile sie direkt aus der Konfigurationsdatei abrufen kann. Weitere Informationen finden Sie unter Option `‑‑config` verwenden.
`-e, ‑‑environment`	Erforderlich	Alle	(String) Eine Umgebung in Ihrer Organisation.
`-h, ‑‑help`	Optional	Alle	Zeigt Hilfe zu den Befehlsparametern an.
`--i, --id`	Erforderlich	Alle	(String) Die Schlüssel-Anmeldedaten, die aus der Apigee-Entwickler-App abgerufen werden können, wie unter API-Schlüssel abrufen beschrieben.
`‑‑insecure`	Optional	Alle	Unsichere Serververbindungen mit SSL zulassen.
`‑‑legacy`	Erforderlich	Nur für Edge Public Cloud	Sie müssen dieses Flag festlegen, wenn Sie Apigee Edge for Public Cloud verwenden. Legt die Verwaltungs- und Laufzeit-URLs für Apigee Edge for Public Cloud fest.
`‑‑opdk`	Erforderlich	Nur für Edge Private Cloud	Sie müssen dieses Flag festlegen, wenn Sie Apigee Edge for Private Cloud verwenden.
`-o, ‑‑organization`	Erforderlich	Alle	(String) Eine Apigee-Organisation. Sie müssen ein Organisationsadministrator sein.
`-r, ‑‑runtime`	Erforderlich	Nur Edge Private Cloud und Apigee Hybrid	(String) Gibt die Laufzeit-URL für die Private Cloud- oder Apigee Hybrid-Instanz an. Die URL muss mit `https://` beginnen. Beispiel: `https://apitest.apigee-hybrid-docs.net`
`--s, ‑‑secret`	Erforderlich	Alle	(String) Die Secret-Anmeldedaten, die aus der Apigee-Entwickler-App abgerufen werden können, wie unter API-Schlüssel abrufen beschrieben.
`‑‑tls‑cert ‑‑tls‑key ‑‑tls‑ca`	Optional	Nur für Edge Private Cloud	(String) Gibt das clientseitige TLS-Zertifikat, den privaten Schlüssel und die Stamm-CA für mTLS-Verbindungen an.
`-v, ‑‑verbose`	Optional	Alle	(Optional) Erzeugt eine ausführliche Ausgabe.

Beispiel

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

Ausgabe

Bei Erfolg wird ein JavaScript-Token wie dieses ausgegeben:

eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q

JWT-Token prüfen

Sie können ein JWT-Token mit diesem Befehl prüfen. Siehe auch Token prüfen.

Nutzung

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

Parameter

Parameter	Präsenz	Mit Produkten verwendet	Beschreibung
`-c, ‑‑config`	Erforderlich	Alle	(String) Der Pfad zur Konfigurationsdatei von Apigee Remote Service. Tipp: Mit diesem Flag können Sie die meisten anderen Befehlsparameter weglassen, da die Befehlszeile sie direkt aus der Konfigurationsdatei abrufen kann. Weitere Informationen finden Sie unter Option `‑‑config` verwenden.
`-e, ‑‑environment`	Erforderlich	Alle	(String) Eine Umgebung in Ihrer Organisation.
`-f, ‑‑file`	Erforderlich	Alle	(String) Die Tokendatei (Standard: `stdin` verwenden)
`-h, ‑‑help`	Optional	Alle	Zeigt Hilfe zu den Befehlsparametern an.
`‑‑insecure`	Optional	Alle	Unsichere Serververbindungen mit SSL zulassen.
`‑‑legacy`	Erforderlich	Nur für Edge Public Cloud	Sie müssen dieses Flag festlegen, wenn Sie Apigee Edge for Public Cloud verwenden. Legt die Verwaltungs- und Laufzeit-URLs für Apigee Edge for Public Cloud fest.
`‑‑opdk`	Erforderlich	Nur für Edge Private Cloud	Sie müssen dieses Flag festlegen, wenn Sie Apigee Edge for Private Cloud verwenden.
`-o, ‑‑organization`	Erforderlich	Alle	(String) Eine Apigee-Organisation. Sie müssen ein Organisationsadministrator sein.
`-r, ‑‑runtime`	Erforderlich	Nur Edge Private Cloud und Apigee Hybrid	(String) Gibt die Laufzeit-URL für die Private Cloud- oder Apigee Hybrid-Instanz an. Die URL muss mit `https://` beginnen. Beispiel: `https://apitest.apigee-hybrid-docs.net`
`‑‑tls‑cert ‑‑tls‑key ‑‑tls‑ca`	Optional	Nur für Edge Private Cloud	(String) Gibt das clientseitige TLS-Zertifikat, den privaten Schlüssel und die Stamm-CA für mTLS-Verbindungen an.
`-v, ‑‑verbose`	Optional	Alle	(Optional) Erzeugt eine ausführliche Ausgabe.

Beispiel

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

Ausgabe

Bei Erfolg sieht die Ausgabe in etwa so aus:

{
	"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.

JWT-Token rotieren

Nach der ersten Generierung eines JWT müssen Sie möglicherweise das Paar aus öffentlichen und privaten Schlüsseln ändern, das von Apigee in seiner verschlüsselten Schlüsselwertzuordnung (KVM) gespeichert wird. Das Generieren eines neuen Schlüsselpaars wird als Schlüsselrotation bezeichnet. Wenn Sie Schlüssel rotieren, wird ein neues privates/öffentliches Schlüsselpaar generiert und in der KVM in „istio“ in Ihrer Apigee-Organisation/-Umgebung gespeichert. Außerdem bleibt der alte öffentliche Schlüssel mit seinem ursprünglichen Schlüssel-ID-Wert erhalten.

Nutzung

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

Parameter

Parameter	Präsenz	Mit Produkten verwendet	Beschreibung
`-c, ‑‑config`	Erforderlich	Alle	(String) Der Pfad zur Konfigurationsdatei von Apigee Remote Service. Tipp: Mit diesem Flag können Sie die meisten anderen Befehlsparameter weglassen, da die Befehlszeile sie direkt aus der Konfigurationsdatei abrufen kann. Weitere Informationen finden Sie unter Option `‑‑config` verwenden.
`-e, ‑‑environment`	Erforderlich	Alle	(String) Eine Umgebung in Ihrer Organisation.
`-h, ‑‑help`	Optional	Nur Edge Public und Private Cloud	Zeigt Hilfe zu den Befehlsparametern an.
`--k, --key`	Erforderlich	Nur Edge Public und Private Cloud	(String) Der Bereitstellungsschlüssel.
`‑‑insecure`	Optional	Nur Edge Public und Private Cloud	Unsichere Serververbindungen mit SSL zulassen.
`‑‑legacy`	Erforderlich	Nur für Edge Public Cloud	Sie müssen dieses Flag festlegen, wenn Sie Apigee Edge for Public Cloud verwenden. Legt die Verwaltungs- und Laufzeit-URLs für Apigee Edge for Public Cloud fest.
`‑‑opdk`	Erforderlich	Nur für Edge Private Cloud	Sie müssen dieses Flag festlegen, wenn Sie Apigee Edge for Private Cloud verwenden.
`-o, ‑‑organization`	Erforderlich	Nur Edge Public und Private Cloud	(String) Eine Apigee-Organisation. Sie müssen ein Organisationsadministrator sein.
`-r, ‑‑runtime`	Erforderlich	Nur für Edge Private Cloud	(String) Gibt die Laufzeit-URL für die Private Cloud- oder Apigee Hybrid-Instanz an. Die URL muss mit `https://` beginnen. Beispiel: `https://apitest.apigee-hybrid-docs.net`
`--s, ‑‑secret`	Erforderlich	Alle	(String) Das Bereitstellungs-Secret.
`‑‑tls‑cert ‑‑tls‑key ‑‑tls‑ca`	Optional	Nur für Edge Private Cloud	(String) Gibt das clientseitige TLS-Zertifikat, den privaten Schlüssel und die Stamm-CA für mTLS-Verbindungen an.
`--t, ‑‑truncate`	Erforderlich	Alle	(Ganzzahl) Die Anzahl der Zertifikate, die in JWKS beibehalten werden sollen (Standard 2).
`-v, ‑‑verbose`	Optional	Alle	(Optional) Erzeugt eine ausführliche Ausgabe.

Beispiel

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

Ausgabe

certificate successfully rotated

Internes Token erstellen

JWT-Token zum Autorisieren von API-Aufrufen für Remotedienste erstellen

Nutzung

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

Parameter

Parameter	Präsenz	Mit Produkten verwendet	Beschreibung
`-c, ‑‑config`	Erforderlich	Nur Apigee Hybrid	(String) Der Pfad zur Konfigurationsdatei von Apigee Remote Service. Tipp: Mit diesem Flag können Sie die meisten anderen Befehlsparameter weglassen, da die Befehlszeile sie direkt aus der Konfigurationsdatei abrufen kann. Weitere Informationen finden Sie unter Option `‑‑config` verwenden.
`-d, ‑‑duration`	Erforderlich	Nur Apigee Hybrid	(String) Eine gültige Zeit des internen JWT von der Erstellung (Standard: `10m0s` (10 Minuten))
`-e, ‑‑environment`	Erforderlich	Nur Apigee Hybrid	(String) Eine Umgebung in Ihrer Organisation.
`-h, ‑‑help`	Optional	Nur Apigee Hybrid	Zeigt Hilfe zu den Befehlsparametern an.
`‑‑insecure`	Optional	Nur Apigee Hybrid	Unsichere Serververbindungen mit SSL zulassen.
`-o, ‑‑organization`	Erforderlich	Nur Apigee Hybrid	(String) Eine Apigee-Organisation. Sie müssen ein Organisationsadministrator sein.
`-r, ‑‑runtime`	Erforderlich	Nur Apigee Hybrid	(String) Gibt die Laufzeit-URL für Ihre Apigee-Hybrid-Instanz an. Die URL muss mit `https://` beginnen. Beispiel: `https://apitest.apigee-hybrid-docs.net`
`-v, ‑‑verbose`	Optional	Nur Apigee Hybrid	(Optional) Erzeugt eine ausführliche Ausgabe.

Versionsbefehl

Die CLI-Version drucken

apigee-remote-service-cli version

.netrc für Anmeldedaten verwenden

apigee-remote-service-cli ruft automatisch username und password (zur einfachen Authentifizierung, falls erforderlich) aus einer .netrc-Datei in Ihrem Basisverzeichnis ab, wenn Sie sich in der Edge Public Cloud befinden und einen Eintrag für die api.enterprise.apigee.com-Maschine haben. Wenn Sie in Apigee Private Cloud sind, ist der Maschinenwert mit Ihrer management-URL identisch (z. B. http://192.162.55.100). Beispiel in Edge Public Cloud:

machine api.enterprise.apigee.com
login jdoe@google.com
password abc123

Zum Beispiel in Edge Private Cloud:

machine http://192.162.55.100
login jdoe@google.com
password abc123

Mit der Befehlsoption `‑‑config`

Die Option ‑‑config gibt den Speicherort der Konfigurationsdatei an, die vom Befehl provision generiert wurde. Ein hilfreicher Vorteil dieser Option besteht darin, dass Sie die meisten anderen Befehlsparameter überspringen können, die die Befehlszeile mit der Konfigurationsdatei abruft. Diese Optionen umfassen unter anderem:

Organisation
Umgebung
runtime
Verwaltung
Unsicher
Namespace
legacy
opdk

Führen Sie beispielsweise den Befehl provision so aus:

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

Konfigurationsdatei

In diesem Abschnitt sehen Sie eine Beispielkonfigurationsdatei mit allen verfügbaren Optionen.

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

Referenz

Befehl zum Auflisten von Bindungen

Nutzung

Parameter

Beispiel

Beispielausgabe

Hilfebefehl

Bereitstellungsbefehl

Nutzung

Parameter

Beispiel

Befehl "Beispiele"

Beispielkonfigurationsdateien erstellen

Nutzung

Beschreibung

Parameter

Beispiel

Verfügbare Vorlagenoptionen auflisten

Nutzung

Parameter

Beispiel

Tokenbefehle

JWT-Token erstellen

Nutzung

Parameter

Beispiel

Ausgabe

JWT-Token prüfen

Nutzung

Parameter

Parameter

Beispiel

Ausgabe

JWT-Token rotieren

Nutzung

Parameter

Beispiel

Ausgabe

Internes Token erstellen

Nutzung

Parameter

Parameter

Versionsbefehl

.netrc für Anmeldedaten verwenden

Mit der Befehlsoption ‑‑config

Konfigurationsdatei

Mit der Befehlsoption `‑‑config`