<ph type="x-smartling-placeholder"></ph>
Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur
Apigee X-Dokumentation. Weitere Informationen
Edge Microgateway Version 2.5.x
Übersicht
Mit der Edge Microgateway-Befehlszeile können Sie alle Aspekte eines Edge Microgateways steuern und verwalten Instanz.
<ph type="x-smartling-placeholder">Zertifikate verwalten
Mit den cert
-Befehlen kannst du das Paar aus öffentlichem/privatem Schlüssel installieren und verwalten
zum Signieren von Inhabertokens, die von Clients verwendet werden, um sichere Aufrufe über Edge zu tätigen
Microgateway. Die Schlüssel werden in Apigee Edge in einer verschlüsselten Key Value Map (KVM) gespeichert. Edge Microgateway verwendet
öffentlichen Schlüssel zum Validieren signierter Inhabertokens. Diese Schlüssel werden generiert, wenn Sie den Edgemicro-Client ausführen
konfigurieren, wie unter Einrichtung und Konfiguration
Konfigurieren von Edge Microgateway Sie können die hier beschriebenen cert-Befehle verwenden.
um diese Schlüssel bei Bedarf neu zu generieren und zu verwalten.
Ein Zertifikat installieren
Installiert die Schlüssel in einer verschlüsselten Key Value Map (KVM) und gibt den öffentlichen Schlüssel als Ausgabe festlegen. 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 Organisationsadministrator für das angegebene Unternehmen. |
-p, --password |
Optional: Ihr Passwort. Sie werden aufgefordert, diesen Parameter bei in die Befehlszeile ein. |
-f, --force |
(Optional) Erzwingen Sie dessen Ersetzen, wenn ein Schlüssel bereits in der verschlüsselten KVM gespeichert ist. |
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro cert install -o docs -e test -u jdoe@example.com -f
Ausgabe
current nodejs version is v6.9.1 current edgemicro version is 2.5.4 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 Organisationsadministrator für das angegebene Unternehmen. |
-p, --password |
Optional: Ihr Passwort. Sie werden aufgefordert, diesen Parameter bei in die Befehlszeile ein. |
-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 Organisationsadministrator für das angegebene Unternehmen. |
-p, --password |
Optional: Ihr Passwort. Sie werden aufgefordert, diesen Parameter bei in die Befehlszeile ein. |
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro cert check -o docs -e test -u jdoe@example.com
Ausgabe (erfolgreich)
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. Erfordert keine Authentifizierung.
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)
-----BEGIN CERTIFICATE----- MIICpDCCAYwCCQCKpXWGum9uTjANBgkq9w0BAQsFADAUMRIwEAYDVQQDEwls b2NhbGhvc3cNMTYxMTAyMjAxNTA2WhcNMTYxMTAzMjAxNTA2WjAUMRIwEAYD VQQDEwlsb2Nvc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDD ETr/ne/gP47+9LgjLvBJjpbFVdaeUabZZ3wbA7sSIVnnNXWt3yPklrWSfIh+ L2+dq4k+YunsQE2+dwPdXA2x8DPGvqGcCdWPxnpZ7ix5Akbs8i/J+Ue0pXT4 jkpWbaDDftGL2tcxwP45yI+slpDYvmWRps07TFXkAPjGEHYPvCT9/v/35GkL 0h4v0S+XfpcjS5c47o7CIWlkgEM5GBosQUb17kuVR48392vGFPsnCP34iNe7 zguhiCXYg2zkOcj/N3AE4xKIhCz0QcewULy08GltWMmyjJ/30zs8P41JqoA4 RwfeEZ8RenN3rJQim1ppAAEwDQYJKoZIhvcNAQELBQADggEBAHcORIfc+ySe 2FMmqicNe6Wt5V/5zOaBMLsGQdqGOHB5cQc79sMBrk680KVhrwHXZ2nBIkVe UEL+2qLY1VLfswBNAvcNwV9U4TwHq4eIANiD751oJK1tHmM/ujThQkwNf96o 6I7Ws+wfpGO3ppJCttRbtnATIxrwsCHN4i5lbW/tJSL7t/Zf6T1B+YSJU9AF xuvLq22cCqyYJQdmKq2vVS55WRZdllm+mRtJrv7MLM9gfDPRxVlwrBz/eQHy Fv+dwzxcvQjkz03RNhZUodzuD34DPJoYeK++rItsddwQ26KTahH80yYTAFzY x9gfPf1/+qo=? -----END CERTIFICATE-----
Edge Microgateway für Apigee Edge Cloud konfigurieren
Ermöglicht es Edge Microgateway, mit einer Apigee Edge Cloud-Instanz zu arbeiten. Sie führt eine eine Befehlsfolge zum Bereitstellen eines erforderlichen Authentifizierungsproxys in Edge, zum Generieren einer Authentifizierung und aktualisieren Sie Konfigurationsdateien. Ein Praxisbeispiel finden Sie unter Einrichten und Konfigurieren von Edge Microgateway
<ph type="x-smartling-placeholder">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 Organisationsadministrator für das angegebene Unternehmen. |
-p, --password |
Optional: Ihr Passwort. Sie werden aufgefordert, diesen Parameter bei in die Befehlszeile ein. |
-r, --url |
(Optional) Gibt den Alias des virtuellen Hosts für Ihre Organisationsumgebung an. Weitere Informationen finden Sie in der
Edge-Dokumentation mit Informationen zu virtuellen Hosts Standard:
org-env.apigee.net |
-c, --configDir |
(Optional) Gibt den Pfad zur Edge Microgateway-Konfigurationsdatei an. Standardmäßig Die Konfigurationsdatei befindet sich in ./config/config.yaml. (Version 2.4.x hinzugefügt) |
-x, --proxyName |
(Optional) Legt den Basispfad für den Proxy edgemicro-auth fest. Wenn die edgemicro-auth-Proxy unter einem anderen Pfad als dem Standardpfad bereitgestellt, /edgemicro-auth: Mit dieser Funktion können Sie den neuen Pfad in Edge festlegen. Microgateway. Der Basispfad ist standardmäßig /edgemicro-auth. (Hinzugefügt v2.4.x) |
-t, --token |
Optional: Hiermit können Sie anstelle von Nutzername/Passwort ein OAuth-Token zur Authentifizierung verwenden.
Siehe auch Sichere API-Aufrufe mit einem OAuth2-Zugriffstoken.
Beispiel:edgemicro configure -o docs -e test -t <your token> |
-v, --virtualHosts |
(Optional) Überschreibt die standardmäßigen virtuellen Hosts, die
„default,secure “. Verwenden Sie diese Option, wenn Sie virtuelle Hosts für Ihre
Edge-Organisation:Umgebung, die nicht diesen Standardeinstellungen entspricht. In der Edge-Dokumentation finden Sie
mehr über virtuelle Hosts erfahren. |
-d, --debug |
(Optional) Stellt Informationen zur Fehlerbehebung bereit. |
-h, --help |
Nutzungsinformationen ausgeben. |
Verwendungshinweise
Dieser Befehl speichert Konfigurationsinformationen in
~ /.edgemicro/org-env-config.yaml
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 verwenden müssen Microgateway.
... The following credentials are required to start edge micro key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372 edgemicro configuration complete!
Schlüssel generieren
Der Befehl genkeys
generiert ein Schlüssel-Secret-Paar, das von Edge Microgateway verwendet wird, um
authentifizieren sich beim asynchronen Posten von Analysedaten in Apigee Edge.
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 Organisationsadministrator für das angegebene Unternehmen. |
-p, --password |
Optional: Ihr Passwort. Sie werden aufgefordert, diesen Parameter bei in die Befehlszeile ein. |
-h, --help |
Nutzungsinformationen ausgeben. |
Verwendungshinweise
Bei Erfolg gibt der Befehl drei Elemente zurück. Die erste ist eine URL, die Sie in der Konfigurationsdatei. Die anderen beiden sind ein Schlüsselpaar, das beim Starten eines Edge-Geräts erforderlich ist. Microgateway-Instanz.
- Bootstrap-URL: Diese URL verweist auf einen Apigee Edge-Dienst, der ein
Edge Microgateway-Instanz zum Senden von Analysedaten an Apigee Edge. Sie müssen diese URL kopieren
in die Edge Microgateway-Konfigurationsdatei einfügen: ~
/.edgemicro/org-env-config.yaml
. - key: Der Schlüssel. Dieser Schlüssel und das Secret sind als Eingabe in die Befehlszeile erforderlich zum Starten einer Instanz von Edge Microgateway.
- 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 verwenden müssen Microgateway.
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 Organisationsadministrator für das angegebene Unternehmen. |
-p, --password |
Optional: Ihr Passwort. Sie werden aufgefordert, diesen Parameter bei in die Befehlszeile ein. |
-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. Standardeinstellung
„default,secure “. |
-c, --configDir |
(Optional) Gibt den Pfad zur Edge Microgateway-Konfigurationsdatei an. Standardmäßig Die Konfigurationsdatei befindet sich in ./config/config.yaml. (Version 2.4.x hinzugefügt) |
-t, --token |
Optional: Hiermit können Sie anstelle von Nutzername/Passwort ein OAuth-Token zur Authentifizierung verwenden.
Siehe auch Sichere API-Aufrufe mit einem OAuth2-Zugriffstoken.
Beispiel:edgemicro configure -o docs -e test -t <your token> |
-d, --debug |
(Optional) Stellt Informationen zur Fehlerbehebung bereit. |
-h, --help |
Nutzungsinformationen ausgeben. |
Verwendungshinweise
Dieser Befehl speichert Konfigurationsinformationen in
~ /.edgemicro/org-env-config.yaml
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 verwenden müssen Microgateway.
... The following credentials are required to start edge micro key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372 edgemicro configuration complete!
Edge Microgateway wird gestartet
Bevor Sie Edge Microgateway starten, müssen Sie zuerst den Befehl edgemicroconfigure ausführen. (Public Cloud) oder edgemicro privateconfigure (Private Cloud) festlegen. Die Konfiguration -Befehl 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 „edgemicro
configure “ ausführen . |
-s, --secret |
Der geheime Wert, der zurückgegeben wird, wenn Sie „edgemicro
configure “ ausführen . |
-p, --processes |
(Optional) Die Anzahl der zu startenden Prozesse. Standardeinstellung: Die Anzahl der Kerne auf Ihrem System. |
-d, --pluginDir |
(Optional) Absoluter Pfad zum Plug-in-Verzeichnis. |
-r, --port |
Optional: Überschreibt die Portnummer, die im
~/.edgemicro/org-env-config.yaml Datei. Standardeinstellung: 8.000 |
-c, --cluster |
(Optional) Startet Edge Microgateway im Clustermodus. Hinweis: In Version 2.3.1 ist diese Option nicht mehr verfügbar. In Version 2.3.1 und neueren Versionen startet Edge Micro immer im Clustermodus. |
-c, --configDir |
(Optional) Gibt den Pfad zur Edge Microgateway-Konfigurationsdatei an. Standardmäßig Die Konfigurationsdatei befindet sich in ./config/config.yaml. (Version 2.4.x hinzugefügt) |
-u, --configUrl |
(Optional) Gibt einen Endpunkt an, von dem Edge Microgateway seine Konfiguration herunterlädt -Datei. (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 angegebenen Port zu überschreiben
in der Konfigurationsdatei. Sie können auch mithilfe der PORT
eine Portnummer angeben.
Umgebungsvariable ein. 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 das Clustering zu aktivieren. Clustering ermöglicht es Edge Microgateway, die Vorteile von Mehrkernsystemen. Weitere Informationen finden Sie in dieser Node.js-Dokumentation.
<ph type="x-smartling-placeholder">Beispiel
edgemicro start -o docs -e test -k abc123 -s xyz456
Beispielausgabe:
... current nodejs version is v6.9.1 current edgemicro version is 2.5.4 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 signierten OAuth2-Zugriff abrufen, decodieren und prüfen
Tokens. Siehe auch
Sichere API-Aufrufe mit einem OAuth2-Zugriffstoken.
Token decodieren
Decodiert ein signiertes, codiertes Inhabertoken in sein JSON-JWT (Java Web Token) im Nur-Text-Format Darstellung. Ein Token vermittelt Informationen über die Apigee Edge-Entwickler-App, die die Schlüssel, die zum Erstellen des Tokens verwendet werden, einschließlich Anwendungsname, Client-ID, Produktliste usw.
Nutzung
edgemicro token decode -f [filename]
Parameter
Parameter | Beschreibung |
---|---|
-f, --file |
Der Name einer Datei mit dem zu decodierenden JWT-Token. |
-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 Inhabertoken. Mit dem Token können Client-Apps authentifizierte API-Aufrufe ausführen an Edge Microgateway. Das Token ist ein OAuth 2.0-kompatibles JSON-Web-Token (JWT). Es erfordert Geben Sie die Werte für den Consumer-Key (Client-ID) und den Consumer-Secret (Client-Secret) aus einer registrierten Entwickler-App auf Apigee Edge. Siehe auch Sichere API-Aufrufe mit einem OAuth2-Zugriffstoken.
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-Aware verknüpft ist Proxy. |
-s, --secret |
Der Clientschlüssel der Entwickler-App, der mit Ihrem Microgateway-aware verknüpft ist Proxy. |
-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' }
HTTP-Anfrage zum Abrufen eines Tokens stellen
Sie können auch eine HTTP-Rohanfrage senden, um das Token abzurufen. Weitere Informationen finden Sie unter Inhabertokens direkt abrufen.
Token bestätigen
Verifiziert ein signiertes Inhabertoken mit dem öffentlichen Schlüssel, der in Apigee Edge für das angegebene Organisation und Umgebung.
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 mit dem zu prüfenden JWT. |
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro token get -o docs -e test -f token.jwt
Beispielausgabe für 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 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 installiert haben. Erstellt einen neuen Standardwert
Konfigurationsdatei: ~/.edgemicro/default.yaml
.
Nutzung
edgemicro init
Parameter
Parameter | Beschreibung |
---|---|
-c, --configDir |
(Optional) Gibt den Pfad zur Edge Microgateway-Konfigurationsdatei an. Standardmäßig Die Konfigurationsdatei befindet sich in ./config/config.yaml. (Version 2.4.x hinzugefügt) |
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro init
Ausgabe (erfolgreich)
config initialized to /MyHome/.edgemicro/default.yaml
Edge Microgateway-Konfiguration prüfen
Überprü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 (erfolgreich)
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
Standardmäßig startet Edge Microgateway im Clustermodus. Mit diesem Befehl können Sie prüfen, Status des Clusters.
<ph type="x-smartling-placeholder">Nutzung
edgemicro status
Parameter
Parameter | Beschreibung |
---|---|
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro status
Ausgabe (erfolgreich)
current nodejs version is v6.9.1 current edgemicro version is 2.5.4 edgemicro is running with 8 workers
Microgateway-Cluster beenden
Beendet den Edge Microgateway-Cluster.
<ph type="x-smartling-placeholder">Nutzung
edgemicro stop
Parameter
Parameter | Beschreibung |
---|---|
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro stop
Ausgabe (erfolgreich)
current nodejs version is v6.9.1 current edgemicro version is 2.5.4 Stop Completed Successfully
Microgateway-Cluster aktualisieren
Bietet einen Neustart ohne Ausfallzeiten nach einer Konfigurationsänderung. Lädt das Edge Microgateway um neue Konfiguration abzurufen.
<ph type="x-smartling-placeholder">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 „edgemicro
configure “ ausführen . |
-s, --secret |
Der geheime Wert, der zurückgegeben wird, wenn Sie „edgemicro
configure “ ausführen . |
-h, --help |
Nutzungsinformationen ausgeben. |
Beispiel
edgemicro reload -o docs -e test -k abc123 -s xyz456
Ausgabe (erfolgreich)
... Reload Completed Successfully
Upgrade der KVM durchführen
Wenn Sie die Schlüsselrotation verwenden möchten, benötigen Sie ein aktualisiertes Schlüssel/Wert-Paar Karte in Ihrer Apigee Edge-Organisation installiert. (Version 2.5.x hinzugefügt)
Hinweis:Wenn Wenn Sie Ihre aktuelle Edge Micro-Instanz vor Version 2.5.2 konfiguriert haben, müssen Sie Ihre KVM aktualisieren Schlüsselrotation verwenden. Diese Umstellung 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 Organisationsadministrator für das angegebene Unternehmen. |
-p, --password |
Optional: Ihr Passwort. Sie werden aufgefordert, diesen Parameter bei in die Befehlszeile ein. |
-v, --virtualhost |
(Optional) Der virtuelle Host des Proxys. |
-t, --token |
(Optional) Ermöglicht die Verwendung eines OAuth-Tokens zur Authentifizierung anstelle von Nutzername/Passwort.
Siehe auch Sichere API-Aufrufe mit einem OAuth2-Zugriffstoken.
Beispiel:edgemicro upgradekvm -o docs -e test -t <your token> |
-b, --baseuri |
(Optional) Der Basis-URI für Ihre Organisation in Apigee Edge. Standard ist die Basis- URI für Apigee-Cloud-Bereitstellungen lautet api.enterprise.apigee.com. Bei lokalen Bereitstellungen kann die Basis-URL abweichen. |
Beispiel
edgemicro upgradekvm -o docs -e test -u jdoe@example.com
Ausgabe (erfolgreich)
Bei Erfolg gibt der Befehl in etwa folgende Ausgabe zurück:
current nodejs version is v6.9.1 current edgemicro version is 2.5.4 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
Upgrade des Edgemicro-auth-Proxys ausführen
Wenn Sie die Schlüsselrotation verwenden möchten, benötigen Sie ein aktualisiertes Edgemicro-auth-Proxy, der in Ihrer Apigee Edge-Organisation bereitgestellt ist. (Version 2.5.x hinzugefügt)
Hinweis:Wenn Sie Ihre aktuelle Edge Micro-Instanz vor dem Version 2.5.2 müssen Sie diesen Proxy aktualisieren, wenn Sie die Schlüsselrotation verwenden möchten. Sie müssen nur führen Sie diese Umstellung einmal durch.
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 Organisationsadministrator für das angegebene Unternehmen. |
-p, --password |
Optional: Ihr Passwort. Sie werden aufgefordert, diesen Parameter bei in die Befehlszeile ein. |
-v, --virtualhost |
(Optional) Der virtuelle Host des Proxys. |
-b, --baseuri |
(Optional) Der Basis-URI für Ihre Organisation in Apigee Edge. Standard ist die Basis- URI für Apigee-Cloud-Bereitstellungen lautet api.enterprise.apigee.com. Bei lokalen Bereitstellungen kann die Basis-URL abweichen. |
Beispiel
edgemicro upgradeauth -o docs -e test -u jdoe@example.com
Ausgabe (erfolgreich)
Bei Erfolg gibt der Befehl in etwa folgende Ausgabe 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 drehen
Verwenden Sie den Befehl edgemicro rotatekey
, um die öffentlichen/privaten Schlüsselpaare zu rotieren.
die zum Generieren der JWT-Tokens für die OAuth-Sicherheit auf Edge Microgateway verwendet wurden.
Weitere Informationen finden Sie unter . Rotierende JWT-Schlüssel.
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, --Nutzername | (Erforderlich) Ihr Apigee-Nutzername. Sie müssen Organisationsadministrator für das angegebene Unternehmen. |
-p, --password |
Optional: Ihr Passwort. Sie werden aufgefordert, diesen Parameter bei in die Befehlszeile ein. |
-k, --kid |
(Erforderlich) Eine ID, die einem bestimmten Schlüssel zugeordnet wird. Edge Microgateway verwendet diesen Wert, um während der Schlüsselrotation einen Schlüssel auswählen. Weitere Informationen finden Sie in Abschnitt 4.5 der der JSON Web Key-Spezifikation. |
-b, --baseuri |
(Optional) Der Basis-URI für Ihre Organisation in Apigee Edge. Standard ist die Basis- URI für Apigee-Cloud-Bereitstellungen lautet api.enterprise.apigee.com. Bei lokalen Bereitstellungen kann die Basis-URL abweichen. |
Beispiel
edgemicro rotatekey -o jdoe -e test -u jdoe@google.com -k 2
Ausgabe (erfolgreich)
Bei Erfolg gibt der Befehl in etwa folgende Ausgabe zurück:
current nodejs version is v6.9.1 current edgemicro version is 2.5.7 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 neue Schlüssel hinzugefügt wurden KVM.
Permanente Überwachung
Verwenden Sie den Befehl edgemicro forever
, um Forever zu verwalten.
ein Node.js-Tool, das eine Node.js-Anwendung automatisch neu startet, wenn die Anwendung ausfällt oder ein Fehler auftritt.
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 zurückgegebene Schlüsselwert, der beim Ausführen von "edgemicroconfigure" zurückgegeben wurde .EDGEMICRO_SECRET
: der zurückgegebene Secret-Wert, als Sie „edgemicro config“ ausgeführt haben. .
edgemicro forever -f [forever_file] -a [start|stop]
Parameter
Parameter | Beschreibung |
---|---|
-f, --file | Gibt den Speicherort der Datei forever.json an. |
-a, --action | start oder stop . Die Standardeinstellung ist „Start“. |
Beispiele:
So starten Sie die Option „endgültig“:
edgemicro forever -f ~/mydir/forever.json -a start
So beenden Sie die Funktion „Endgültig“:
edgemicro forever -a stop
Schlüssel widerrufen
Verwenden Sie den Befehl edgemicro revokekeys
, um den Schlüssel und die geheimen Anmeldedaten für eine
Edge Microgateway-Konfiguration
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 Organisationsadministrator für das angegebene Unternehmen. |
-p, --password |
Optional: Ihr Passwort. Sie werden aufgefordert, diesen Parameter bei in die Befehlszeile ein. |
-k, --key |
(Erforderlich) Der Schlüssel, der widerrufen werden soll. |
-s, --secret |
(Erforderlich) Das zu widerrufende Secret. |
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