Befehlszeilenreferenz für Edge Microgateway

<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.4.x

Übersicht

Mit der Edge Microgateway-Befehlszeile können Sie alle Aspekte eines Edge Microgateways steuern und verwalten Instanz.

Zertifikate verwalten

Mit den cert-Befehlen kannst du den öffentlichen/privaten Schlüssel installieren und verwalten Paar 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 Einstellungen Edge Microgateway konfigurieren Sie können die hier beschriebenen cert-Befehle, um diese Schlüssel neu zu generieren und zu verwalten wenn nötig.

Ein Zertifikat installieren

Installiert die Schlüssel in einer verschlüsselten Schlüsselwertzuordnung (KVM) mithilfe des sicheren Speicherdienstes von Apigee Edge 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

Beispiel

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

Ausgabe

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
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

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

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

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 konfigurieren Edge-Cloud

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 vollständiges Praxisbeispiel finden Sie unter Einstellung Edge Microgateway konfigurieren

Nutzung

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

Parameter

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 verwendet wird Microgateway zur Authentifizierung beim asynchronen Posten von Analysedaten an Apigee Edge

Nutzung

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

Parameter

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 konfigurieren für Apigee Edge Private Cloud

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

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 edgemicro ausführen. konfigurieren (Öffentliche Cloud) oder Edgemicro privat konfigurieren konfigurieren (Private Cloud). 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

Port festlegen

Mit dem Befehl start können Sie eine Portnummer angeben, um den Port zu überschreiben die in der Konfigurationsdatei angegeben sind. Sie können auch eine Portnummer angeben mit Die Umgebungsvariable PORT 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.

Beispiel

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

Beispielausgabe:

...

PROCESS PID : 54709
installed plugin from analytics
installed plugin from analytics
installed plugin from oauth
installed plugin from oauth
installed plugin from analytics
installed plugin from oauth
5a86b570-a142-11e6-aa1f-6730e9065d6c edge micro listening on port 8000
5a86dc80-a142-11e6-962c-43d9cc723190 edge micro listening on port 8000
5a8751b0-a142-11e6-8241-cf1c517c91eb edge micro listening on port 8000
installed plugin from analytics
installed plugin from oauth
5a924e30-a142-11e6-8740-2944162ce275 edge micro listening on port 8000

Tokens verwalten

Mit den token-Befehlen kannst du signiertes OAuth2 abrufen, decodieren und prüfen Zugriffstokens. 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

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

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. Hier ist ein curl-Beispiel. Nur ersetzen Ihre Organisations- und Umgebungsnamen in der URL und ersetzen Sie die Consumer-ID und das Consumer-Secret für die Parameter client_id und client_secret:

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

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

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) }

Inhabertokens direkt abrufen

Sie können Inhabertokens direkt abrufen, indem Sie eine HTTP-Anfrage an das Token senden. Endpunkt auf Apigee Edge. Der tatsächliche Token-Endpunkt wird in dem Proxy implementiert, der bereitgestellt wird. mit dem CLI-Befehl deploy-edge-service.

Hier ist ein curl-Beispiel. Ersetzen Sie in der URL einfach die Namen Ihrer Organisation und Umgebung. Sie ersetzen die Werte der Nutzer-ID und des Consumer-Secrets, die aus einer Entwickler-App auf Apigee abgerufen wurden. Edge für die Parameter client_id und client_secret:

curl -i -X POST "http://<org>-<test>.apigee.net/edgemicro-auth/token" -d '{"grant_type": "client_credentials", "client_id": "4t8X137pOUUtMR7wag3M1yZTcRxeK", "client_secret": "RAcOFVOvO0jns"}' -H "Content-Type: application/json"

Beispielausgabe:

HTTP/1.1 200 OK

X-Powered-By: Express

Cache-Control: no-store

Pragma: no-cache

Content-Type: application/json; charset=utf-8

Content-Length: 640

ETag: W/"280-ze/g/k+c9taqp110vjYQ"

Date: Fri, 17 07 2015 15:49:24 GMT

Connection: keep-alive

"<long string of numbers and letters>"

Neues Edge Microgateway initialisieren Konfiguration

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

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

Hinzugefügt: v2.2.4-beta

Standardmäßig startet Edge Microgateway im Clustermodus. Mit diesem Befehl können Sie prüfen, Status des Clusters.

Nutzung

edgemicro status

Parameter

Beispiel

edgemicro status

Ausgabe (erfolgreich)

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
edgemicro is running with 4 workers

Microgateway-Cluster beenden

Hinzugefügt: v2.2.4-beta

Beendet den Edge Microgateway-Cluster.

Nutzung

edgemicro stop

Parameter

Beispiel

edgemicro stop

Ausgabe (erfolgreich)

current nodejs version is v6.1.0
current edgemicro version is 2.2.4-beta
Stop Completed Successfully

Microgateway-Cluster aktualisieren

Hinzugefügt: v2.2.4-beta

Bietet einen Neustart ohne Ausfallzeiten nach einer Konfigurationsänderung. Lädt das Edge Microgateway um neue Konfiguration abzurufen.

Nutzung

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

Parameter

Beispiel

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

Ausgabe (erfolgreich)

...

Reload Completed Successfully