Referenz

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

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

Befehlszeilenbefehle mit der Option `‑‑config` vereinfachen

Die Option ‑‑config gibt den Speicherort der config.yaml-Datei an, die vom Befehl provision generiert wurde. Ein Vorteil dieser Option ist, dass Sie damit die meisten anderen Befehlsparameter überspringen können, da sie von der Befehlszeile direkt aus der config.yaml-Datei abgerufen werden.

Beachten Sie, dass alle angegebenen Befehlszeilenparameter Werte in der Datei config.yaml überschreiben.

Diese Optionen umfassen unter anderem:

Organisation
Umgebung
runtime
Management
Unsicher
Namespace
legacy
opdk

Sie können diese Option beim Upgraden des Adapters verwenden. In diesem Fall müssen Sie jedoch das Flag --force-proxy-install einfügen. Führen Sie beispielsweise den Befehl provision so aus:

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

Wenn Sie die Werte in der alten Konfigurationsdatei nicht ändern, müssen Sie keine neuen speichern, da sie mit dem Original identisch sind.

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	Presence	Mit Produkten verwendet	Beschreibung
`-c, ‑‑config`	Optional	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`	Optional, wenn `--config` vorhanden ist; andernfalls 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`	–	Nur für Edge Public Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`-m, ‑‑management`	–	Nur für Edge Private Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`‑‑mfa`	–	Nur für Edge Public Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`‑‑opdk`	–	Nur für Edge Private Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`-o, ‑‑organization`	Optional, wenn `--config` vorhanden ist; andernfalls erforderlich.	Alle	(String) Eine Apigee-Organisation. Sie müssen ein Organisationsadministrator sein.
`-p, ‑‑password`	– (Nur Basisauthentifizierung)	Nur Edge Public und Private Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`-r, ‑‑runtime`	Optional, wenn `--config` vorhanden ist; andernfalls erforderlich.	Nur 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.example.net`
`‑‑tls‑cert ‑‑tls‑key ‑‑tls‑ca`	–	Nur für Edge Private Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`-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`	– (Nur Basisauthentifizierung)	Nur Edge Public und Private Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`-v, ‑‑verbose`	Optional	Alle	(Optional) Erzeugt eine ausführliche Ausgabe.

Beispiel

apigee-remote-service-cli bindings list -o myorg -e test --token $TOKEN \
-c config.yaml

Beispielausgabe

API 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	Presence	Mit Produkten verwendet	Beschreibung
`‑‑analytics-sa`	Optional	Nur Apigee Hybrid und Apigee	(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. Mit dieser Option kann der Adapter Analysen hochladen, ohne Standardanmeldedaten für Anwendungen auf dem Host zu haben. Wenn Sie diese Option nicht angeben, verwendet der Adapter die Standardanmeldedaten für das Dienstkonto.
`-c, ‑‑config`	Optional	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`	Optional, wenn `--config` vorhanden ist; andernfalls 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`	–	Nur für Edge Public Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`-m, ‑‑management`	–	Nur für Edge Private Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`‑‑mfa`	–	Nur für Edge Public Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`-n, ‑‑namespace`	Optional, wenn `--config` vorhanden ist. Der Standardwert ist `apigee`.	Nur für Kubernetes-Deployments	(String) Konfiguration als Envoy-ConfigMap im angegebenen Namespace. Standardwert: `apigee`
`‑‑opdk`	–	Nur für Edge Private Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`-o, ‑‑organization`	Optional, wenn `--config` vorhanden ist; andernfalls erforderlich.	Alle	(String) Eine Apigee-Organisation. Sie müssen ein Organisationsadministrator sein, um bereitgestellt zu werden.
`-p, ‑‑password`	– (Nur Basisauthentifizierung)	Nur Edge Public und Private Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`‑‑rotate`	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`	Optional, wenn `--config` vorhanden ist; andernfalls 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.example.net`
`‑‑tls‑cert ‑‑tls‑key ‑‑tls‑ca`	–	Nur für Edge Private Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`-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`	– (Nur Basisauthentifizierung)	Nur Edge Public und Private Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`-v, ‑‑verbose`	Optional	Alle	(Optional) Erzeugt eine ausführliche Ausgabe.
`‑‑virtual-hosts`	–	Nur für Edge Private Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.

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	Presence	Mit Produkten verwendet	Beschreibung
`‑‑adapter‑host`	Nur für Envoy-Vorlagen verwendet	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 verwendet	Alle	(String) Der Zieldiensthost (Standard `httpbin.org`)
`-n, ‑‑name`	Optional	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`	Wird nur für Istio-Vorlagen verwendet	Alle	(String) Das Versions-Tag des Envoy-Adapter-Image. Standard: Aktuelle Releaseversion
`-t, ‑‑template`	Optional	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. Standardeinstellung: `istio-1.9` Der Standard funktioniert für alle Versionen von Istio 1.9 und höher.
`‑‑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	Presence	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`	Optional, wenn `--config` vorhanden ist; andernfalls 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`	–	Nur für Edge Public Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`‑‑opdk`	–	Nur für Edge Private Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`-o, ‑‑organization`	Optional, wenn `--config` vorhanden ist; andernfalls erforderlich.	Alle	(String) Eine Apigee-Organisation. Sie müssen ein Organisationsadministrator sein.
`-r, ‑‑runtime`	Optional, wenn `--config` vorhanden ist; andernfalls erforderlich.	Nur 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.example.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`	–	Nur für Edge Private Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`-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	Presence	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`	Optional, wenn `--config` vorhanden ist; andernfalls 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`	–	Nur für Edge Public Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`‑‑opdk`	–	Nur für Edge Private Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`-o, ‑‑organization`	Optional, wenn `--config` vorhanden ist; andernfalls erforderlich.	Alle	(String) Eine Apigee-Organisation. Sie müssen ein Organisationsadministrator sein.
`-r, ‑‑runtime`	Optional, wenn `--config` vorhanden ist; andernfalls erforderlich.	Nur 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.example.net`
`‑‑tls‑cert ‑‑tls‑key ‑‑tls‑ca`	–	Nur für Edge Private Cloud	Dieser Parameter gilt nicht für Apigee-Installationen.
`-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	Presence	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`	Optional, wenn `--config` vorhanden ist; andernfalls erforderlich.	Alle	(String) Eine Umgebung in Ihrer Organisation.
`-h, ‑‑help`	–	Nur Edge Public und Private Cloud	Zeigt Hilfe zu den Befehlsparametern an.
`--k, --key`	–	Nur Edge Public und Private Cloud	(String) Der Bereitstellungsschlüssel.
`‑‑insecure`	–	Nur Edge Public und Private Cloud	Unsichere Serververbindungen mit SSL zulassen.
`‑‑legacy`	–	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`	–	Nur für Edge Private Cloud	Sie müssen dieses Flag festlegen, wenn Sie Apigee Edge for Private Cloud verwenden.
`-o, ‑‑organization`	Optional, wenn `--config` vorhanden ist; andernfalls erforderlich.	Nur Edge Public und Private Cloud	(String) Eine Apigee-Organisation. Sie müssen ein Organisationsadministrator sein.
`-r, ‑‑runtime`	–	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.example.net`
`--s, ‑‑secret`	Erforderlich	Alle	(String) Das Bereitstellungs-Secret.
`‑‑tls‑cert ‑‑tls‑key ‑‑tls‑ca`	–	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	Presence	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`	Optional, wenn `--config` vorhanden ist; andernfalls 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`	Optional, wenn `--config` vorhanden ist; andernfalls erforderlich.	Nur Apigee Hybrid	(String) Eine Apigee-Organisation. Sie müssen ein Organisationsadministrator sein.
`-r, ‑‑runtime`	Optional, wenn `--config` vorhanden ist; andernfalls 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.example.net`
`-v, ‑‑verbose`	Optional	Nur Apigee Hybrid	(Optional) Erzeugt eine ausführliche Ausgabe.

Versionsbefehl

Die CLI-Version drucken

apigee-remote-service-cli version

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

Befehlszeilenbefehle mit der Option ‑‑config vereinfachen

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

Konfigurationsdatei

Befehlszeilenbefehle mit der Option `‑‑config` vereinfachen