Google verwendet KI-Technologie, um Inhalte in Ihre bevorzugte Sprache zu übersetzen. KI-Übersetzungen können Fehler enthalten.

Befehlszeilenreferenz für Edge Microgateway

Sie lesen gerade die Dokumentation zu Apigee Edge.
Apigee X-Dokumentation aufrufen info

Edge Microgateway v. 3.1.x

Übersicht

Mit der Edge Microgateway CLI können Sie alle Aspekte einer Edge Microgateway-Instanz steuern und verwalten.

Zertifikate verwalten

Mit den cert-Befehlen können Sie das öffentliche/private Schlüsselpaar installieren und verwalten, das zum Signieren von Inhabertokens verwendet wird, mit denen Clients sichere Aufrufe über Edge Microgateway ausführen. Die Schlüssel werden in Apigee Edge in einer verschlüsselten Schlüssel/Wert-Zuordnung (KVM) gespeichert. Edge Microgateway verwendet den öffentlichen Schlüssel, um signierte Bearertokens zu validieren. Diese Schlüssel werden generiert, wenn Sie den Befehl „edgemicro configure“ ausführen, wie unter Edge Microgateway einrichten und konfigurieren beschrieben. Sie können die hier beschriebenen cert-Befehle verwenden, um diese Schlüssel bei Bedarf neu zu generieren und zu verwalten.

Zertifikat installieren

Installiert die Schlüssel in einer verschlüsselten Schlüssel/Wert-Zuordnung (KVM) und gibt den öffentlichen Schlüssel als Ausgabe zurück. Schlüsselpaare sind auf eine bestimmte Organisation beschränkt.

Nutzung

edgemicro cert install -o [organization] -e [environment] -u [username] -p [password] --force

Parameter

Parameter	Beschreibung
`-o, --org`	Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
`-e, --env`	Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
`-u, --username`	Ihr Apigee-Nutzername. Sie müssen ein Organisationsadministrator für die angegebene Organisation sein.
`-p, --password`	Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, werden Sie dazu aufgefordert.
`-f, --force`	(Optional) Wenn bereits ein Schlüssel in der verschlüsselten KVM gespeichert ist, erzwingen Sie den Austausch.
`-h, --help`	Nutzungsinformationen ausgeben.

Beispiel

edgemicro cert install -o docs -e test -u jdoe@example.com -f

Ausgabe

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
password:
deleting vault
creating vault
adding private_key
adding public_key
installed cert

Zertifikat löschen

Löscht das Schlüsselpaar für eine Organisation.

Nutzung

edgemicro cert delete -o [organization] -e [environment] -u [username] -p [password]

Parameter

Parameter	Beschreibung
`-o, --org`	Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
`-e, --env`	Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
`-u, --username`	Ihr Apigee-Nutzername. Sie müssen ein Organisationsadministrator für die angegebene Organisation sein.
`-p, --password`	Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, werden Sie dazu aufgefordert.
`-h, --help`	Nutzungsinformationen ausgeben.

Beispiel

edgemicro cert delete -o docs -e test -u jdoe@example.com

Ausgabe

deleting vault
Vault deleted!

Zertifikat prüfen

Prüft, ob in Ihrer Organisation ein Zertifikat installiert ist.

Nutzung

edgemicro cert check -o [organization] -e [environment] -u [username] -p [password]

Parameter

Parameter	Beschreibung
`-o, --org`	Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
`-e, --env`	Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
`-u, --username`	Ihr Apigee-Nutzername. Sie müssen ein Organisationsadministrator für die angegebene Organisation sein.
`-p, --password`	Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, werden Sie dazu aufgefordert.
`-h, --help`	Nutzungsinformationen ausgeben.

Beispiel

edgemicro cert check -o docs -e test -u jdoe@example.com

Ausgabe (Erfolg)

checked cert successfully

Ausgabe (Fehler)

Wenn das Zertifikat nicht vorhanden ist, wird ein Fehler zurückgegeben.

Rufen Sie den öffentlichen Schlüssel ab

Gibt den öffentlichen Schlüssel für die angegebene Organisation zurück. Keine Authentifizierung erforderlich.

Nutzung

edgemicro cert public-key -o [organization] -e [environment]

Parameter

Parameter	Beschreibung
`-o, --org`	Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
`-e, --env`	Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
`-h, --help`	Nutzungsinformationen ausgeben.

Beispiel

edgemicro cert public-key -o docs -e test

Ausgabe (Beispiel)

Edge Microgateway für Apigee Edge Cloud konfigurieren

Ermöglicht den Betrieb von Edge Microgateway mit einer Apigee Edge Cloud-Instanz. Es umschließt und führt eine Reihe von Befehlen aus, um einen erforderlichen Authentifizierungsproxy in Edge bereitzustellen, Authentifizierungstokens zu generieren und Konfigurationsdateien zu aktualisieren. Ein vollständiges funktionierendes Beispiel finden Sie unter Edge Microgateway einrichten und konfigurieren.

Nutzung

edgemicro configure -o [organization] -e [environment] -u [username] -p [password]

Parameter

Parameter	Beschreibung
`-o, --org`	Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
`-e, --env`	Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
`-u, --username`	Ihr Apigee-Nutzername. Sie müssen ein Organisationsadministrator für die angegebene Organisation sein.
`-p, --password`	Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, werden Sie dazu aufgefordert.
`-r, --url`	Optional: Gibt den Alias des virtuellen Hosts für Ihre Organisation:Umgebung an. Weitere Informationen zu virtuellen Hosts finden Sie in der Edge-Dokumentation. Standard: `org-env.apigee.net`
`-c, --configDir`	Optional: Gibt den Pfad zur Edge Microgateway-Konfigurationsdatei an. Standardmäßig befindet sich die Konfigurationsdatei unter ./config/config.yaml. (Version 2.4.x hinzugefügt)
`-x, --proxyName`	Optional: Legt den Basispfad für den edgemicro-auth-Proxy fest. Wenn der Proxy edgemicro-auth unter einem anderen Pfad als dem Standardpfad /edgemicro-auth bereitgestellt wird, können Sie mit dieser Funktion den neuen Pfad in Edge Microgateway festlegen. Der Basispfad ist standardmäßig /edgemicro-auth. (Version 2.4.x hinzugefügt)
`-t, --token`	(Optional) Ermöglicht die Verwendung eines OAuth-Tokens zur Authentifizierung anstelle von Nutzername/Passwort. Weitere Informationen finden Sie unter API-Aufrufe mit einem OAuth2-Zugriffstoken sichern. Beispiel: `edgemicro configure -o docs -e test -t <your token>`
`-v, --virtualHosts`	(Optional) Ü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. Weitere Informationen zu virtuellen Hosts finden Sie in der Edge-Dokumentation.
`-d, --debug`	(Optional) Stellt Informationen zur Fehlerbehebung bereit.
`-h, --help`	Nutzungsinformationen ausgeben.

Hinweise zur Verwendung

Mit diesem Befehl werden Konfigurationsinformationen in ~/.edgemicro/org-env-config.yaml gespeichert.

Beispiel

edgemicro configure -o docs -e test -u jdoe@example.com

Ausgabe

Bei Erfolg gibt der Befehl eine Reihe von Schlüsseln zurück, die Sie beim Starten von Edge Microgateway verwenden müssen.

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

Schlüssel generieren

Mit dem Befehl genkeys wird ein Key-Secret-Paar generiert, das von Edge Microgateway verwendet wird, um sich bei der asynchronen Übertragung von Analysedaten an Apigee Edge zu authentifizieren.

Nutzung

edgemicro genkeys -o [organization] -e [environment] -u [username] -p [password]

Parameter

Parameter	Beschreibung
`-o, --org`	Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
`-e, --env`	Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
`-u, --username`	Ihr Apigee-Nutzername. Sie müssen ein Organisationsadministrator für die angegebene Organisation sein.
`-p, --password`	Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, werden Sie dazu aufgefordert.
`-t, --token`	(Optional) Ermöglicht die Verwendung eines OAuth-Tokens zur Authentifizierung anstelle von Nutzername/Passwort. Weitere Informationen finden Sie unter API-Aufrufe mit einem OAuth2-Zugriffstoken sichern. Beispiel: `edgemicro genkeys -o docs -e test -t <your token>`
`-h, --help`	Nutzungsinformationen ausgeben.

Hinweise zur Verwendung

Bei Erfolg gibt der Befehl drei Elemente zurück. Die erste ist eine URL, die Sie in die Konfigurationsdatei einfügen müssen. Die anderen beiden sind ein Schlüsselpaar, das erforderlich ist, wenn Sie eine Edge Microgateway-Instanz starten.

Bootstrap-URL: Diese URL verweist auf einen Apigee Edge-Dienst, mit dem eine Edge Microgateway-Instanz Analysedaten an Apigee Edge senden kann. Sie müssen diese URL in die Edge Microgateway-Konfigurationsdatei kopieren: ~/.edgemicro/org-env-config.yaml.
key: Der Schlüssel. Dieser Schlüssel und das Secret sind als Eingabe für den CLI-Befehl erforderlich, mit dem eine Instanz von Edge Microgateway gestartet wird.
secret: Das Secret.

Beispiel

edgemicro genkeys -o docs -e test -u jdoe@example.com

Ausgabe (Beispiel)

Bei Erfolg gibt der Befehl eine Reihe von Schlüsseln zurück, die Sie beim Starten von Edge Microgateway verwenden müssen.

configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1
Please copy the following property to the edge micro agent config
  bootstrap: https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/jdoe/environment/test

The following credentials are required to start edge micro
  key: db39324077989c75eac34c13d285772ea8e3b982b957b3f52916f3048511443f
  secret: 5bf8da39de0056f88fdd5f25a8602d22f312c1c8c870580a5fef55ac6637b7ae

finished

Edge Microgateway für Apigee Edge Private Cloud konfigurieren

Konfiguriert Edge Microgateway für die Verwendung mit einer Apigee Edge Private Cloud-Installation.

Nutzung

edgemicro private configure -o [organization] -e [environment] -u [username] -p [password]

Parameter

Parameter	Beschreibung
`-o, --org`	Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
`-e, --env`	Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
`-u, --username`	Ihr Apigee-Nutzername. Sie müssen ein Organisationsadministrator für die angegebene Organisation sein.
`-p, --password`	Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, werden Sie dazu aufgefordert.
`-r, --runtime-url`	Gibt die Laufzeit-URL für Ihre Private Cloud-Instanz an.
`-m, --mgmt-url`	Die URL des Verwaltungsservers für Ihre Private Cloud-Instanz.
`-v, --virtualHosts`	Durch Kommas getrennte Liste der virtuellen Hosts für Ihre Organisation:Umgebung. Standardmäßig wird „`default,secure`“ verwendet.
`-c, --configDir`	Optional: Gibt den Pfad zur Edge Microgateway-Konfigurationsdatei an. Standardmäßig befindet sich die Konfigurationsdatei unter ./config/config.yaml. (Version 2.4.x hinzugefügt)
`-t, --token`	(Optional) Ermöglicht die Verwendung eines OAuth-Tokens zur Authentifizierung anstelle von Nutzername/Passwort. Weitere Informationen finden Sie unter API-Aufrufe mit einem OAuth2-Zugriffstoken sichern. Beispiel: `edgemicro configure -o docs -e test -t <your token>`
`-d, --debug`	(Optional) Stellt Informationen zur Fehlerbehebung bereit.
`-h, --help`	Nutzungsinformationen ausgeben.

Hinweise zur Verwendung

Mit diesem Befehl werden Konfigurationsinformationen in ~/.edgemicro/org-env-config.yaml gespeichert.

Beispiel

edgemicro private configure -o docs -e test -u jdoe@example.com -r http://192.162.55.100:9002 -m http://192.162.55.100:8080

Ausgabe

Bei Erfolg gibt der Befehl eine Reihe von Schlüsseln zurück, die Sie beim Starten von Edge Microgateway verwenden müssen.

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

Edge Microgateway starten

Bevor Sie Edge Microgateway starten, müssen Sie zuerst edgemicro configure (Public Cloud) oder edgemicro private configure (Private Cloud) ausführen. Der Befehl „configure“ gibt die Schlüssel- und Secret-Werte zurück, die zum Starten von Edge Microgateway erforderlich sind.

Nutzung

edgemicro start -o [organization] -e [environment] -k [public-key] -s [secret-key]

Parameter

Parameter	Beschreibung
`-o, --org`	Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
`-e, --env`	Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
`-k, --key`	Der zurückgegebene Schlüsselwert, der zurückgegeben wird, wenn Sie den Befehl „`edgemicro configure`“ ausführen.
`-s, --secret`	Der zurückgegebene Secret-Wert, der zurückgegeben wird, wenn Sie den Befehl „`edgemicro configure`“ ausführen.
`-p, --processes`	(Optional) Die Anzahl der zu startenden Prozesse. Standard: Die Anzahl der Kerne auf Ihrem System.
`-d, --pluginDir`	(Optional) Absoluter Pfad zum Plug-in-Verzeichnis.
`-r, --port`	(Optional) Überschreibt die in der Datei „~`/.edgemicro/org-env-config.yaml`“ angegebene Portnummer. Standard: 8.000
`-c, --cluster`	Optional: Startet Edge Microgateway im Clustermodus. Hinweis:Ab Version 2.3.1 wurde diese Option entfernt. In Version 2.3.1 und höher wird Edge Micro immer im Clustermodus gestartet.
`-c, --configDir`	Optional: Gibt den Pfad zur Edge Microgateway-Konfigurationsdatei an. Standardmäßig befindet sich die Konfigurationsdatei unter ./config/config.yaml. (Version 2.4.x hinzugefügt)
`-u, --configUrl`	Optional: Gibt einen Endpunkt an, von dem Edge Microgateway die Konfigurationsdatei herunterlädt. (Version 2.5.x hinzugefügt)
`-d, --debug`	(Optional) Stellt Informationen zur Fehlerbehebung bereit.
`-h, --help`	Nutzungsinformationen ausgeben.

Port festlegen

Mit dem Befehl start können Sie eine Portnummer angeben, um den in der Konfigurationsdatei angegebenen Port zu überschreiben. Sie können auch eine Portnummer mit der Umgebungsvariable PORT angeben. Beispiel:

edgemicro start -o docs -e test -k abc123 -s xyz456 -p 2 --port 8002

oder

export PORT=8002
edgemicro start -o org -e test -k key -s secret -p 2

Wenn der Port verwendet wird, gibt Edge Microgateway einen Fehler zurück.

Clustering

Edge Microgateway verwendet das Node.js-Clustermodul, um Clustering zu ermöglichen. Durch Clustering kann Edge Microgateway die Vorteile von Mehrkernsystemen nutzen. Weitere Informationen finden Sie in der Node.js-Dokumentation.

Beispiel

edgemicro start -o docs -e test -k abc123 -s xyz456

Beispielausgabe:

...

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
info: jwk_public_keys download from null returned 200 undefined
info: jwt_public_key download from https://docs-test.apigee.net/edgemicro-auth/publicKey returned 200 OK
info: products download from https://docs-test.apigee.net/edgemicro-auth/products returned 200 OK
info: config download from https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test returned 200 OK
PROCESS PID : 17991

Tokens verwalten

Mit den token-Befehlen können Sie signierte OAuth2-Zugriffstokens abrufen, decodieren und überprüfen. Weitere Informationen finden Sie unter API-Aufrufe mit einem OAuth2-Zugriffstoken sichern.

Token decodieren

Decodiert ein signiertes, codiertes Inhabertoken in seine JSON-JWT-Darstellung (Java Web Token) im Nur-Text-Format. Ein Token enthält Informationen zur Apigee Edge-Entwickler-App, die die zum Erstellen des Tokens verwendeten Schlüssel bereitgestellt hat, einschließlich Anwendungsname, client_id und Produktliste.

Nutzung

edgemicro token decode -f [filename]

Parameter

Parameter	Beschreibung
`-f, --file`	Der Name einer Datei, die das zu decodierende JWT-Token enthält.
`-h, --help`	Nutzungsinformationen ausgeben.

Beispiel

edgemicro token decode -f token.jwt

Ausgabe (Beispiel)

{ header: { typ: 'JWT', alg: 'RS256' },

  payload:
   { application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',
     client_id: 'O9ZQRZKnn1rdgcKQgsABSMdOsKS',
     scopes: [],
     api_product_list: [ 'MicroTest' ],
     iat: 1436280566,
     exp: 1436282365 },
  signature: '' }

Token generieren

Generiert ein signiertes Bearertoken. Mit dem Token können Client-Apps authentifizierte API-Aufrufe an Edge Microgateway senden. Das Token ist ein OAuth 2.0-kompatibles JSON Web Token (JWT). Als Eingabe sind der Consumer-Key (Client-ID) und der Consumer-Secret (Clientschlüssel) einer registrierten Entwickler-App in Apigee Edge erforderlich. Weitere Informationen finden Sie unter API-Aufrufe mit einem OAuth2-Zugriffstoken sichern.

Nutzung

edgemicro token get -o [org] -e [env] -i [client_id] -s [client_secret]

Parameter

Parameter	Beschreibung
`-o, --org`	Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
`-e, --env`	Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
`-1, --key`	Die Client-ID der Entwickler-App, die mit Ihrem Microgateway-kompatiblen Proxy verknüpft ist.
`-s, --secret`	Der Clientschlüssel aus der Entwickler-App, die mit Ihrem Microgateway-kompatiblen Proxy verknüpft ist.
`-h, --help`	Nutzungsinformationen ausgeben.

Beispiel

edgemicro token get -o docs -e test -i 5UzOwAXGoOeo60aew94PPG5MAZE3aJp -s 6vahKFGS9a3qMLwz

Ausgabe (Beispiel)

{ token: 'eyJ0eXAiOiJKV1JhbGciOiJSUzI1NiJ9Glvbl9uYW1lIjoiNWNiMGY0NTV6TV3
EtOWMzOC00YmJjLWIzNzEtZGMxZTQzOGMxIiwiY2xpZW50X2lkIjoiNVV6T3dBWEdvSU9lbz
YwYWV3OTRQN0c1TUFaRTNhSnAiLCJzY2MiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIkVkZ2
VNaWNyb1Rlc3RQcm9kdWN0Il0sImlhdCI3ODEyMzQ2MSwiZXhwIjoxNDc4MTI1MjYwfQ.Dx5
f5U7PXm8koNGmFX4N6VrxKMJnpndKgoJ5zWSJvBZ6Ccvhlpd85ipIIA5S2A5nx4obYWp_rpY
RJpIGYwyxP6Oq2j0rxnVjdCC4qyYMgthZjhKgEBVBe3s1ndP72GP2vV6PsSA9RQ2-yzsy9r0
TzhAZ3NJTxT1tS0XKqKngE-OhR3fJHVLAzdMDT0AmS9H0Z2NAJtQOuK6RTpCjG9B6Bc48AEM
sj7QSM-1LWiQ8LdY8k_BoC06qsTI7bCQGWwTuqL-ismbcx2bxovUxSemZIaoROfuF-dCZHG3
2aTP75WxBvvNgBBvPvQtPzbeSOtEaww' }

Token bestätigen

Überprüft ein signiertes Bearer-Token anhand des öffentlichen Schlüssels, der in Apigee Edge für die angegebene Organisation und Umgebung gespeichert ist.

Nutzung

edgemicro token verify -o [org] -e [env] -f [filename]

Parameter

Parameter	Beschreibung
`-o, --org`	Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
`-e, --env`	Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
`-f, --file`	Der Name einer Datei, die das zu überprüfende JWT enthält.
`-h, --help`	Nutzungsinformationen ausgeben.

Beispiel

edgemicro token get -o docs -e test -f token.jwt

Beispielausgabe für ein gültiges Token

{ application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

Beispielausgabe für ungültiges Token

{ [JsonWebTokenError: invalid token] name: 'JsonWebTokenError', message: 'invalid token' }

Beispielausgabe für ein abgelaufenes Token

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

  expiredAt: Tue Jul 07 2015 09:19:25 GMT-0600 (MDT) }

Neue Edge Microgateway-Konfiguration initialisieren

Führen Sie diesen Befehl einmal aus, nachdem Sie Edge Microgateway zum ersten Mal installiert haben. Erstellt eine neue Standardkonfigurationsdatei: ~/.edgemicro/default.yaml.

Nutzung

edgemicro init

Parameter

Parameter	Beschreibung
`-c, --configDir`	Optional: Gibt den Pfad zur Edge Microgateway-Konfigurationsdatei an. Standardmäßig befindet sich die Konfigurationsdatei unter ./config/config.yaml. (Version 2.4.x hinzugefügt)
`-h, --help`	Nutzungsinformationen ausgeben.

Beispiel

edgemicro init

Ausgabe (Erfolg)

config initialized to /MyHome/.edgemicro/default.yaml

Edge Microgateway-Konfiguration prüfen

Prüft, ob Edge Microgateway richtig konfiguriert ist.

Nutzung

edgemicro verify -o [organization] -e [environment] -k [public-key] -s [secret-key]

Parameter

Beispiel

edgemicro verify -o docs -e test -k abc123 -s xyz456

Ausgabe (Erfolg)

logging to /var/tmp/edgemicro-My-Machine.local-a0c48610-a148-11e6-8466-93f081b05988
installed plugin from analytics
installed plugin from oauth
a0c48610-a148-11e6-8466-93f081b05988 edge micro listening on port 8000
verifying analytics negative case: OK
verifying bootstrap url availability:OK
verifying jwt_public_key availability: OK
verifying products availability: OK
verifying quota with configured products: OK
verifying analytics with payload: OK
verification complete

Status des Microgateway-Clusters prüfen

Edge Microgateway wird standardmäßig im Clustermodus gestartet. Mit diesem Befehl können Sie den Status des Clusters prüfen.

Nutzung

edgemicro status

Parameter

Parameter	Beschreibung
`-h, --help`	Nutzungsinformationen ausgeben.

Beispiel

edgemicro status

Ausgabe (Erfolg)

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
edgemicro is running with 8 workers

Microgateway-Cluster stoppen

Stoppt den Edge Microgateway-Cluster.

Nutzung

edgemicro stop

Parameter

Parameter	Beschreibung
`-h, --help`	Nutzungsinformationen ausgeben.

Beispiel

edgemicro stop

Ausgabe (Erfolg)

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
Stop Completed Successfully

Microgateway-Cluster neu laden

Ermöglicht einen Neustart ohne Ausfallzeiten nach einer Konfigurationsänderung. Lädt das Edge Microgateway neu, indem eine neue Konfiguration abgerufen wird.

Nutzung

edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]

Parameter

Parameter	Beschreibung
`-o, --org`	Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
`-e, --env`	Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
`-k, --key`	Der zurückgegebene Schlüsselwert, der zurückgegeben wird, wenn Sie den Befehl „`edgemicro configure`“ ausführen.
`-s, --secret`	Der zurückgegebene Secret-Wert, der zurückgegeben wird, wenn Sie den Befehl „`edgemicro configure`“ ausführen.
`-h, --help`	Nutzungsinformationen ausgeben.

Beispiel

edgemicro reload -o docs -e test -k abc123 -s xyz456

Ausgabe (Erfolg)

...

Reload Completed Successfully

KVM upgraden

Wenn Sie die Schlüsselrotation verwenden möchten, muss in Ihrer Apigee Edge-Organisation eine aktualisierte Schlüssel/Wert-Zuordnung installiert sein. (Version 2.5.x hinzugefügt)

Hinweis:Wenn Sie Ihre aktuelle Edge Micro-Instanz vor Version 2.5.2 konfiguriert haben, müssen Sie Ihr KVM-System aktualisieren, um die Schlüsselrotation zu verwenden. Dieses Upgrade ist nur einmal erforderlich.

Nutzung

edgemicro upgradekvm -o [organization] -e [environment] -u [username]

Parameter

Parameter	Beschreibung
`-o, --org`	Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
`-e, --env`	Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
`-u, --username`	Ihr Apigee-Nutzername. Sie müssen ein Organisationsadministrator für die angegebene Organisation sein.
`-p, --password`	Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, werden Sie dazu aufgefordert.
`-v, --virtualhost`	Optional: Der virtuelle Host des Proxys.
`-t, --token`	(Optional) Ermöglicht die Verwendung eines OAuth-Tokens für die Authentifizierung anstelle von Nutzername/Passwort. Weitere Informationen finden Sie unter API-Aufrufe mit einem OAuth2-Zugriffstoken sichern. Beispiel: `edgemicro upgradekvm -o docs -e test -t <your token>`
`-b, --baseuri`	(Optional) Der Basis-URI für Ihre Organisation in Apigee Edge. Der Standard-Basis-URI für Apigee-Cloudbereitstellungen ist api.enterprise.apigee.com. Bei On-Premise-Bereitstellungen kann die Basis-URL abweichen.

Beispiel

edgemicro upgradekvm -o docs -e test -u jdoe@example.com

Ausgabe (Erfolg)

Bei Erfolg gibt der Befehl eine Ausgabe ähnlich der folgenden zurück:

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
password:
Checking for certificate...
Certificate found!
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT6yVoT/h6pvkPlkUUtv
Hgs7MbDPcWxto7dZqJBwQ4oOQ0IJ2P4XGigc3kYUyPp5lFHg1ssP9+0onRpqn6Lq
z7N5iaTSv5YXb26bU2kSOl4hbwcljIzauAnBzQ13VaQ5SoflRxMGSZmTqZeu5jkQ
3JZ7F6k2bCar5sk1k84vd4WXcCVyngFlrMtlux5z0vOU56QYZFvvKYl/wOHNPLLB
Js54531CV1ZfhV3nDDq9Lh5D1C/oQVlm1Lc7BJoEUmKeFATmSsi50c14ScsmdtJ1
HqC/brSXCd185P6ifu2RH7IHKzNfcD4NlfAVmDScng4w5RxBan2avbmAJrokQ4b5
WQIDAQAB
-----END PUBLIC KEY-----
KVM update complete

edgemicro-auth-Proxy aktualisieren

Wenn Sie die Schlüsselrotation verwenden möchten, muss in Ihrer Apigee Edge-Organisation ein aktualisierter edgemicro-auth-Proxy bereitgestellt sein. (Version 2.5.x hinzugefügt)

Hinweis:Wenn Sie Ihre aktuelle Edge Micro-Instanz vor Version 2.5.2 konfiguriert haben, müssen Sie dieses Proxy aktualisieren, wenn Sie die Schlüsselrotation verwenden möchten. Sie müssen dieses Upgrade nur einmal durchführen.

Nutzung

edgemicro upgradeauth -o [organization] -e [environment] -u [username]

Parameter

Parameter	Beschreibung
`-o, --org`	Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
`-e, --env`	Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
`-u, --username`	Ihr Apigee-Nutzername. Sie müssen ein Organisationsadministrator für die angegebene Organisation sein.
`-p, --password`	Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, werden Sie dazu aufgefordert.
`-v, --virtualhost`	Optional: Der virtuelle Host des Proxys.
`-b, --baseuri`	(Optional) Der Basis-URI für Ihre Organisation in Apigee Edge. Der Standard-Basis-URI für Apigee-Cloudbereitstellungen ist api.enterprise.apigee.com. Bei On-Premise-Bereitstellungen kann die Basis-URL abweichen.

Beispiel

edgemicro upgradeauth -o docs -e test -u jdoe@example.com

Ausgabe (Erfolg)

Bei Erfolg gibt der Befehl eine Ausgabe ähnlich der folgenden zurück:

Going to create revision 2 of API edgemicro-auth
Using /Users/jdoe/npm/lib/node_modules/edgemicro/node_modules/microgateway-edgeauth/apiproxy/edgemicro-auth.xml as the root file
Creating revision 2 of API edgemicro-auth
Uploading java resource micro-gateway-products-javacallout-2.0.0.jar
Uploading jsc resource generate-verify-jwt.js
Uploading jsc resource send-public-key.js
Uploading jsc resource set-jwt-variables.js
Uploading jsc resource set-response.js
Uploading node resource index.js
Uploading node resource node_modules_apigee-access.zip
Uploading node resource node_modules_base64url.zip
Uploading node resource node_modules_buffer-equal-constant-time.zip
Uploading node resource node_modules_ecdsa-sig-formatter.zip
Uploading node resource node_modules_jsrsasign.zip
Uploading node resource node_modules_jwa.zip
Uploading node resource node_modules_jws.zip
Uploading node resource node_modules_safe-buffer.zip
Uploading node resource package.json
Uploading policy Access-App-Info-2.xml
Uploading policy Access-App-Info.xml
Uploading policy AccessTokenRequest.xml
Uploading policy Add-Custom-Claims.xml
Uploading policy Create-OAuth-Request.xml
Uploading policy Create-Refresh-Request.xml
Uploading policy Extract-API-Key.xml
Uploading policy Extract-OAuth-Params.xml
Uploading policy Extract-Refresh-Params.xml
Uploading policy Get-Private-Key.xml
Uploading policy Get-Public-Key.xml
Uploading policy Get-Public-Keys.xml
Uploading policy JavaCallout.xml
Uploading policy Products-to-JSON-2.xml
Uploading policy Products-to-JSON.xml
Uploading policy Raise-Fault-Unknown-Request.xml
Uploading policy RefreshAccessToken.xml
Uploading policy Send-Public-Key.xml
Uploading policy Set-JWT-Variables.xml
Uploading policy Set-Response.xml
Uploading policy Verify-API-Key.xml
Uploading target TargetEndpoint-1
Uploading proxy default
Deploying revision 2 of edgemicro-auth to test
Deployment on test successful
edgemicro-auth proxy upgraded

Schlüssel rotieren

Verwenden Sie den Befehl edgemicro rotatekey, um die öffentlichen/privaten Schlüsselpaare zu rotieren, die zum Generieren der JWT-Tokens verwendet wurden, die für die OAuth-Sicherheit in Edge Microgateway verwendet werden.

Weitere Informationen finden Sie unter JWT-Schlüssel rotieren.

Nutzung

edgemicro rotatekey -o [organization] -e [environment] -u [username] -k [kid]

Parameter

Parameter	Beschreibung
`-o, --org`	(Erforderlich) Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
`-e, --env`	(Erforderlich) Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
-u, --username	(Erforderlich) Ihr Apigee-Nutzername. Sie müssen ein Organisationsadministrator für die angegebene Organisation sein.
`-p, --password`	Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, werden Sie dazu aufgefordert.
`-k, --kid`	(Erforderlich) Eine ID, die zum Abgleichen eines bestimmten Schlüssels verwendet wird. Edge Microgateway verwendet diesen Wert, um bei der Schlüsselrotation zwischen einer Reihe von Schlüsseln auszuwählen. Weitere Informationen finden Sie in Abschnitt 4.5 der JSON Web Key-Spezifikation.
`-b, --baseuri`	(Optional) Der Basis-URI für Ihre Organisation in Apigee Edge. Der Standard-Basis-URI für Apigee-Cloudbereitstellungen ist api.enterprise.apigee.com. Bei On-Premise-Bereitstellungen kann die Basis-URL abweichen.

Beispiel

edgemicro rotatekey -o jdoe -e test -u jdoe@google.com -k 2

Ausgabe (Erfolg)

Bei Erfolg gibt der Befehl eine Ausgabe ähnlich der folgenden zurück:

current nodejs version is v12.5.0
current edgemicro version is 3.0.2
password:
Checking if private key exists in the KVM...
Checking for certificate...
Found Certificate
Generating New key/cert pair...
Extract new public key
Key Rotation successfully completed!

Nach der Rotation können Sie in der Edge-Benutzeroberfläche sehen, dass dem Microgateway-KVM neue Schlüssel hinzugefügt wurden.

Dauerhaftes Monitoring

Mit dem Befehl edgemicro forever können Sie den Forever-Prozess verwalten. Das ist ein Node.js-Tool, das eine Node.js-App automatisch neu startet, falls sie abstürzt oder einen Fehler aufweist. Siehe auch Dauerhaftes Monitoring.

Nutzung

Sie müssen die folgenden Umgebungsvariablen festlegen, bevor Sie den Befehl edgemicro forever ausführen:

EDGEMICRO_ORG: Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
EDGEMICRO_ENV: Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
EDGEMICRO_KEY: Der Schlüsselwert, der zurückgegeben wurde, als Sie den Befehl „edgemicro configure“ ausgeführt haben.
EDGEMICRO_SECRET: Der zurückgegebene geheime Wert, der zurückgegeben wurde, als Sie den Befehl „edgemicro configure“ ausgeführt haben.

edgemicro forever -f [forever_file] -a [start|stop]

Parameter

Parameter	Beschreibung
`-f, --file`	Gibt den Speicherort der `forever.json`-Datei an.
`-a, --action`	`start` oder `stop`. Der Standardwert ist „start“.

Beispiele:

So starten Sie Forever:

edgemicro forever -f ~/mydir/forever.json -a start

So beenden Sie Forever:

edgemicro forever -a stop

Schlüssel widerrufen

Verwenden Sie den Befehl edgemicro revokekeys, um die Schlüssel- und Secret-Anmeldedaten für eine Edge Microgateway-Konfiguration zu widerrufen.

Nutzung

edgemicro revokekeys -o [organization] -e [environment] -u [username]
-k [key] -s [secret]

Parameter

Parameter	Beschreibung
`-o, --org`	(Erforderlich) Die Apigee-Organisation, für die Sie Edge Microgateway konfiguriert haben.
`-e, --env`	(Erforderlich) Eine Umgebung, für die Sie Edge Microgateway konfiguriert haben.
`-u, --username`	(Erforderlich) Ihr Apigee-Nutzername. Sie müssen ein Organisationsadministrator für die angegebene Organisation sein.
`-p, --password`	Optional: Ihr Passwort. Wenn Sie diesen Parameter nicht in der Befehlszeile angeben, werden Sie dazu aufgefordert.
`-k, --key`	(Erforderlich) Der Schlüssel, der widerrufen werden soll.
`-s, --secret`	(Erforderlich) Das Secret, das widerrufen werden soll.

Beispiele

edgemicro revokekeys -o myorg -e test -u jdoe@apigee.com
-k 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f -s 4b5d6355b874f7c46838893823e8d929dcb2e42fb9aebcb535089c9b98513

Bei Erfolg wird die folgende Meldung angezeigt:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully