Edge Mikro Ağ Geçidi için CLI referansı

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri. bilgi

Edge Microgateway v. 3.2.x

Genel Bakış

Edge Microgateway CLI, bir Edge Mikro Ağ Geçidi'nin tüm özelliklerini kontrol etmenizi ve yönetmenizi sağlar kullanır.

Sertifikaları yönetme

cert komutları, ortak/özel anahtar çiftini yükleyip yönetmenize olanak tanır Edge üzerinden güvenli çağrılar yapmak için istemciler tarafından kullanılan hamiline ait jetonları imzalamak için kullanılan Mikro ağ geçidi. Anahtarlar, Apigee Edge'de şifrelenmiş bir Anahtar/Değer Eşlemesi (KVM) içinde depolanır. Edge Microgateway, ortak anahtarı kullanın. Bu anahtarlar, Edgemicro'yu çalıştırdığınızda oluşturulur Kurulum ve Kullanıcı Rızası Yönetim Platformu'nu kurma Edge Microgateway'i yapılandırma başlıklı makaleyi inceleyin. Burada açıklanan cert komutlarını kullanabilirsiniz gerektiğinde bu anahtarları yeniden üretip yönetebilirsiniz.

Sertifika yükle

Anahtarları, şifrelenmiş bir Anahtar/Değer Eşleme (KVM) içine yükler ve ortak anahtarı çıkış olarak kullanın. Anahtar çiftleri, belirtilen bir kuruluşa göre belirlenir.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Microgateway'i yapılandırdığınız bir ortam.
-u, --username Apigee kullanıcı adınız. Belirtilen kurum içinde tutmaktır.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırını kullanın.
-f, --force (İsteğe bağlı) Şifrelenmiş KVM'de zaten depolanan bir anahtarın değiştirilmesini zorunlu kılın.
-h, --help Çıkış kullanım bilgileri.

Örnek

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

Çıkış

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

Sertifika silme

Kuruluşun anahtar çiftini siler.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Microgateway'i yapılandırdığınız bir ortam.
-u, --username Apigee kullanıcı adınız. Belirtilen kurum içinde tutmaktır.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırını kullanın.
-h, --help Çıkış kullanım bilgileri.

Örnek

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

Çıkış

deleting vault
Vault deleted!

Sertifikaları kontrol etme

Kuruluşunuzda bir sertifikanın yüklü olup olmadığını kontrol eder.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Microgateway'i yapılandırdığınız bir ortam.
-u, --username Apigee kullanıcı adınız. Belirtilen kurum içinde tutmaktır.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırını kullanın.
-h, --help Çıkış kullanım bilgileri.

Örnek

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

Çıkış (Başarılı)

checked cert successfully

Çıkış (Hata)

Sertifika mevcut değilse bir hata döndürülür.

Ortak anahtarı alma

Belirtilen kuruluşun ortak anahtarını döndürür. Kimlik doğrulama gerektirmez.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Microgateway'i yapılandırdığınız bir ortam.
-h, --help Çıkış kullanım bilgileri.

Örnek

edgemicro cert public-key -o docs -e test

Çıkış (Örnek)

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

Apigee Edge Cloud için Edge Mikro Ağ Geçidi'ni Yapılandırma

Edge Microgateway'in bir Apigee Edge Cloud örneğiyle çalışmasını sağlar. Kendinizi sarmalar ve yüksek performans Edge'e gerekli kimlik doğrulama proxy'sini dağıtmak, kimlik doğrulama oluşturmak için jeton ve yapılandırma dosyalarını güncelleyin. Tam bir çalışan örnek için bkz. Kurulum ve Edge Microgateway'i yapılandırma başlıklı makaleyi inceleyin.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Microgateway'i yapılandırdığınız bir ortam.
-u, --username Apigee kullanıcı adınız. Belirtilen kurum içinde tutmaktır.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırını kullanın.
-r, --url (İsteğe bağlı) Kuruluşunuz için ortam için sanal ana makine takma adını belirtir. Bkz. Sanal ana makineler hakkında bilgi edinebileceğiniz Edge belgeleri. Varsayılan: org-env.apigee.net.
-c, --configDir (İsteğe bağlı) Edge Microgateway yapılandırma dosyasının yolunu belirtir. Varsayılan olarak yapılandırma dosyası ./config/config.yaml konumundadır. (2.4.x sürümü eklendi)
-x, --proxyName (İsteğe bağlı) edgemicro-auth proxy'si için temel yolu ayarlar. Öğe edgemicro-auth proxy'si, varsayılandan farklı bir yol altında dağıtılır. /edgemicro-auth bulabilirsin, bu özellik Edge'de yeni yolu ayarlamanıza olanak tanır Mikro ağ geçidi. Varsayılan olarak temel yol /edgemicro-auth şeklindedir. (Eklendi v2.4.x)
-t, --token (İsteğe bağlı) Kimlik doğrulama için kullanıcı adı/şifre yerine OAuth jetonu kullanmanıza olanak tanır. Ayrıca OAuth2 erişim jetonuyla güvenli API çağrıları başlıklı makaleyi de inceleyin. Örneğin:

. edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts (İsteğe bağlı) Şu varsayılan sanal ana makineleri geçersiz kılar: "default,secure". Uç düzenleme:Bu varsayılanlar dışındaki ortam. Şu işlemler için Edge dokümanlarına bakın: sanal ana makineler hakkında bilgi edinin.
-d, --debug (İsteğe bağlı) Hata ayıklama bilgileri sağlar.
-h, --help Çıkış kullanım bilgileri.

Kullanım notları

Bu komut, yapılandırma bilgilerini Yaklaşık /.edgemicro/org-env-config.yaml.

Örnek

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

Çıkış

İşlem başarılı olursa komut, Edge'i başlattığınızda kullanmanız gereken bir dizi anahtar döndürür Mikro ağ geçidi.

...

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

edgemicro configuration complete!

Anahtarlar oluşturuluyor

genkeys komutu, şu işlemler için Edge Microgateway tarafından kullanılan bir anahtar ve gizli bilgi çifti oluşturur: Apigee Edge'e eşzamansız olarak analiz verileri gönderirken kendi kimliğini doğrulaması gerekir.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Microgateway'i yapılandırdığınız bir ortam.
-u, --username Apigee kullanıcı adınız. Belirtilen kurum içinde tutmaktır.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırını kullanın.
-t, --token (İsteğe bağlı) Kimlik doğrulama için kullanıcı adı/şifre yerine OAuth jetonu kullanmanıza olanak tanır. Ayrıca OAuth2 erişim jetonuyla güvenli API çağrıları başlıklı makaleyi de inceleyin. Örneğin:

. edgemicro genkeys -o docs -e test -t <your token>
-h, --help Çıkış kullanım bilgileri.

Kullanım notları

İşlem başarılı olduğunda komut üç öğe döndürür. İlki, buraya yerleştirmeniz gereken bir URL. yapılandırma dosyası. Diğer ikisi, Edge'i başlattığınızda gerekli olan bir anahtar çiftidir Mikro ağ geçidi örneği.

  • bootstrap URL: Bu URL, bir Apigee Edge hizmetine yönlendirme yapan ve Analiz verilerini Apigee Edge'e göndermek için Edge Microgateway örneği. Bu URL'yi kopyalamanız gerekiyor Edge Microgateway yapılandırma dosyasına yapıştırın: ~/.edgemicro/org-env-config.yaml.
  • key: Anahtar. Bu anahtar ve gizli anahtar, KSA girişi olarak gereklidir komutu tarafından kullanılır.
  • secret: Gizli anahtar.

Örnek

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

Çıkış (Örnek)

İşlem başarılı olursa komut, Edge'i başlattığınızda kullanmanız gereken bir dizi anahtar döndürür Mikro ağ geçidi.

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

Apigee Edge Private Cloud için Edge Mikro Ağ Geçidi'ni Yapılandırma

Edge Microgateway'i Apigee Edge Private Cloud kurulumuyla çalışacak şekilde yapılandırır.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Microgateway'i yapılandırdığınız bir ortam.
-u, --username Apigee kullanıcı adınız. Belirtilen kurum içinde tutmaktır.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırını kullanın.
-r, --runtime-url Özel bulut örneğinizin çalışma zamanı URL'sini belirtir.
-m, --mgmt-url Özel bulut örneğinizin yönetim sunucusunun URL'si.
-v, --virtualHosts Kuruluşunuz için sanal ana makinelerin virgülle ayrılmış listesi:environment. Varsayılan "default,secure".
-c, --configDir (İsteğe bağlı) Edge Microgateway yapılandırma dosyasının yolunu belirtir. Varsayılan olarak yapılandırma dosyası ./config/config.yaml konumundadır. (2.4.x sürümü eklendi)
-t, --token (İsteğe bağlı) Kimlik doğrulama için kullanıcı adı/şifre yerine OAuth jetonu kullanmanıza olanak tanır. Ayrıca OAuth2 erişim jetonuyla güvenli API çağrıları başlıklı makaleyi de inceleyin. Örneğin:

. edgemicro configure -o docs -e test -t <your token>
-d, --debug (İsteğe bağlı) Hata ayıklama bilgileri sağlar.
-h, --help Çıkış kullanım bilgileri.

Kullanım notları

Bu komut, yapılandırma bilgilerini Yaklaşık /.edgemicro/org-env-config.yaml.

Örnek

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

Çıkış

İşlem başarılı olursa komut, Edge'i başlattığınızda kullanmanız gereken bir dizi anahtar döndürür Mikro ağ geçidi.

...

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

edgemicro configuration complete!

Başlangıç Kenarı Mikro Ağ Geçidi

Edge Microgateway'i başlatmadan önce edgemicro config'i çalıştırmanız gerekir. (Herkese Açık Bulut) veya edgemicro gizli yapılandırması (Private Cloud). Yapılandırma komutu, Edge Mikro Ağ Geçidi'ni başlatmak için gereken anahtar ve gizli anahtar değerlerini döndürür.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Microgateway'i yapılandırdığınız bir ortam.
-k, --key "edgemicro configure" komutunu çalıştırdığınızda döndürülen anahtar değeri komutuna ekleyin.
-s, --secret "edgemicro configure" komutunu çalıştırdığınızda döndürülen gizli anahtar değeri komutuna ekleyin.
-p, --processes (İsteğe bağlı) Başlatılacak işlemlerin sayısı. Varsayılan: Cihazınızdaki çekirdek sayısı bahsedeceğim.
-d, --pluginDir (İsteğe bağlı) Eklenti dizininin mutlak yolu.
-r, --port (İsteğe bağlı) ~/.edgemicro/org-env-config.yaml dosya. Varsayılan: 8.000
-c, --cluster

(İsteğe bağlı) Küme modunda Edge Mikro Ağ Geçidi'ni başlatır.

Not: Bu seçenek 2.3.1 sürümü itibarıyla kaldırılmıştır. 2.3.1 sürümünde ve sonraki sürümlerde ise Edge Micro her zaman küme modunda çalışır.
-c, --configDir (İsteğe bağlı) Edge Microgateway yapılandırma dosyasının yolunu belirtir. Varsayılan olarak yapılandırma dosyası ./config/config.yaml konumundadır. (2.4.x sürümü eklendi)
-u, --configUrl (İsteğe bağlı) Edge Microgateway'in yapılandırmasını indireceği bir uç nokta belirtir dosyası olarak kaydedebilirsiniz. (2.5.x sürümü eklendi)
-d, --debug (İsteğe bağlı) Hata ayıklama bilgileri sağlar.
-h, --help Çıkış kullanım bilgileri.

Bağlantı noktasını ayarlama

start komutu, belirtilen bağlantı noktasını geçersiz kılmak için bir bağlantı noktası numarası belirtmenizi sağlar değerine ayarlayın. Ayrıca, PORT kullanarak bir bağlantı noktası numarası da belirtebilirsiniz ortam değişkeni Örneğin:

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

veya

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

Bağlantı noktası kullanılıyorsa Edge Microgateway hata verir.

Kümeleme hakkında

Edge Microgateway, Node.js'yi küme modülünü kullanarak kümelemeyi etkinleştirin. Kümeleme, Edge Mikro Ağ Geçidi'nin avantajına sahip olacak. Ayrıntılar için bu Node.js dokümanlarına bakın.

Örnek

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

Örnek çıktı:

...

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

Jetonları yönetme

token komutları, imzalı OAuth2 erişimini edinmenizi, kodunu çözmenizi ve doğrulamanızı sağlar jeton. Şu kaynakları da inceleyin: OAuth2 erişim jetonuyla güvenli API çağrıları.

Jetonun kodunu çözün

İmzalanmış ve kodlanmış bir hamiline ait jetonu düz metin JSON JWT'sine (Java Web Token) çözer temsil eder. Jeton, verileri sağlayan Apigee Edge geliştirici uygulaması hakkında bilgi uygulama adı, client_id, ürün listesi ve daha fazlası dahil olmak üzere jetonu oluşturmak için kullanılan anahtarlar.

Kullanım

edgemicro token decode -f [filename]

Parametreler

Parametreler Açıklama
-f, --file Kodu çözülecek JWT jetonunu içeren bir dosyanın adı.
-h, --help Çıkış kullanım bilgileri.

Örnek

edgemicro token decode -f token.jwt

Çıkış (Örnek)

{ 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: '' }

Jeton oluştur

İmzalı hamiline ait jeton oluşturur. Bu jeton, istemci uygulamalarının kimliği doğrulanmış API çağrıları yapmasına olanak tanır Edge Mikro Ağ Geçidi'ne bağlanır. Jeton, OAuth 2.0 uyumlu bir JSON Web Jetonu'dur (JWT). Proje yöneticisinin kayıtlı bir kullanıcıdan Tüketici Anahtarı (istemci kimliği) ve Tüketici Sırrı (istemci gizli anahtarı) değerlerini girin Apigee Edge'deki geliştirici uygulaması. Şu kaynakları da inceleyin: OAuth2 erişim jetonuyla güvenli API çağrıları.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Microgateway'i yapılandırdığınız bir ortam.
-1, --key Microgateway-Aware cihazınızla ilişkilendirilmiş geliştirici uygulamasındaki istemci kimliği temsil eder.
-s, --secret Microgateway-Aware cihazınızla ilişkili geliştirici uygulamasındaki İstemci Sırrı temsil eder.
-h, --help Çıkış kullanım bilgileri.

Örnek

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

Çıkış (Örnek)

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

Management API'yi kullanarak da JWT oluşturabilirsiniz:

curl -i -X POST "http://$ORG-$ENV.apigee.net/edgemicro-auth/token" \
  -H "Content-Type: application/json" \
  -d '{
    "$CLIENT_ID": "your consumer key",
    "$CLIENT_SECRET": "your consumer secret",
    "grant_type": "client_credentials"
  }'

Burada:

  • $ORG, Edge kuruluş adınızdır (kuruluş yöneticisi olmanız gerekir).
  • $ENV, kuruluşunuzda bulunan bir ortamdır (ör. "test" veya "prod").
  • $CLIENT_ID, daha önce oluşturduğunuz geliştirici uygulamasındaki tüketici kimliğidir.
  • $CLIENT_SECRET, oluşturduğunuz Geliştirici Uygulamasındaki Tüketici Sırrıdır öğrendi.

Jetonu doğrulama

Belirtilen tarih için Apigee Edge'de depolanan ortak anahtara karşı imzalı hamiline ait jetonu doğrular kurum ve ortam.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Microgateway'i yapılandırdığınız bir ortam.
-f, --file Doğrulanacak JWT'yi içeren dosyanın adı.
-h, --help Çıkış kullanım bilgileri.

Örnek

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

Geçerli jeton için örnek çıkış

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

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

Geçersiz jeton için örnek çıkış

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

Süresi dolan jeton için örnek çıkış

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

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

Yeni bir Edge Microgateway yapılandırması başlatılıyor

Edge Microgateway'i ilk yükledikten sonra bu komutu çalıştırın. Yeni bir varsayılan oluşturur yapılandırma dosyası: ~/.edgemicro/default.yaml.

Kullanım

edgemicro init

Parametreler

Parametreler Açıklama
-c, --configDir (İsteğe bağlı) Edge Microgateway yapılandırma dosyasının yolunu belirtir. Varsayılan olarak yapılandırma dosyası ./config/config.yaml konumundadır. (2.4.x sürümü eklendi)
-h, --help Çıkış kullanım bilgileri.

Örnek

edgemicro init

Çıkış (Başarılı)

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

Edge Mikro Ağ Geçidi yapılandırmasını doğrulama

Edge Microgateway'in doğru şekilde yapılandırıldığını doğrular.

Kullanım

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

Parametreler

Örnek

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

Çıkış (Başarılı)

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

Mikro ağ geçidi küme durumunu kontrol etme

Edge Mikro Ağ Geçidi varsayılan olarak küme modunda başlar. Kontrol etmek istediğiniz durumunu öğrenebilirsiniz.

Kullanım

edgemicro status

Parametreler

Parametreler Açıklama
-h, --help Çıkış kullanım bilgileri.

Örnek

edgemicro status

Çıkış (Başarılı)

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

Mikro ağ geçidi kümesini durdurma

Edge Mikro Ağ Geçidi kümesini durdurur.

Kullanım

edgemicro stop

Parametreler

Parametreler Açıklama
-h, --help Çıkış kullanım bilgileri.

Örnek

edgemicro stop

Çıkış (Başarılı)

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

Mikro ağ geçidi kümesini yeniden yükleme

Bir yapılandırma değişikliğinden sonra kapalı kalma süresiyle yeniden başlatma sağlar. Edge Mikro Ağ Geçidi'ni şu şekilde yeniden yükler: bunu göz önünde bulundurun.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Microgateway'i yapılandırdığınız bir ortam.
-k, --key "edgemicro configure" komutunu çalıştırdığınızda döndürülen anahtar değeri komutuna ekleyin.
-s, --secret "edgemicro configure" komutunu çalıştırdığınızda döndürülen gizli anahtar değeri komutuna ekleyin.
-h, --help Çıkış kullanım bilgileri.

Örnek

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

Çıkış (Başarılı)

...

Reload Completed Successfully

Edgemicro kimlik doğrulama proxy'sini yeni sürüme geçirme

Anahtar rotasyonunu kullanmak için yükseltilmiş bir Apigee Edge kuruluşunuzda dağıtılan Edgemicro kimlik doğrulama proxy'sidir. (2.5.x sürümü eklendi)

Not: Geçerli Edge Micro örneğinizi daha önce yapılandırdıysanız 2.5.2 sürümünü kullanıyorsanız anahtar rotasyonunu kullanmak istiyorsanız bu proxy'yi yükseltmeniz gerekir. Sadece bu yükseltmeyi bir kez yapın.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Microgateway'i yapılandırdığınız bir ortam.
-u, --username Apigee kullanıcı adınız. Belirtilen kurum içinde tutmaktır.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırını kullanın.
-v, --virtualhost (İsteğe bağlı) Proxy'nin sanal ana makinesi.
-b, --baseuri (İsteğe bağlı) Apigee Edge'deki kuruluşunuz için temel URI. Varsayılan, temel Apigee bulut dağıtımlarının URI'si api.enterprise.Apigee.com'dur. Şirket içi dağıtımlarda temel URL farklı olabilir.

Örnek

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

Çıkış (Başarılı)

İşlem başarılı olursa komut, aşağıdakine benzer bir çıkış döndürür:

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

Anahtar/Değer Eşlemesi (KVM) yükseltmesi

Apigee'nizdeki KVM'yi yükseltmek için edgemicro upgradekvm komutunu kullanın kurum içinde tutmaktır. Anahtar rotasyonu kullanmak istiyorsanız KVM'nin yeni sürüme geçirilmesi gerekir.

Kullanım

Herkese Açık Bulut İçin Uç: 

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

Private Cloud için Uç: 

edgemicro private upgradekvm -o [organization] -e [environment] -k [key] -s [secret] -p 'https://[hostname]/edgemicro-auth'

Parametreler

Parametreler Açıklama
-o, --org Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env Edge Microgateway'i yapılandırdığınız bir ortam.
-k, --key "edgemicro configure" komutunu çalıştırdığınızda döndürülen anahtar değeri komutuna ekleyin.
-s, --secret "edgemicro configure" komutunu çalıştırdığınızda döndürülen gizli anahtar değeri komutuna ekleyin.
-p, --proxyuri edgemicro_auth proxy'si

için URI Edge Herkese Açık Bulut: İsteğe bağlı.
Edge Private Cloud: Zorunlu.

Edge Genel Bulut örneği: 

 -p 'https://[org]-[env].apigee.net/edgemicro-auth'

Edge Private Cloud örneği: 

-p 'https://[hostname]/edgemicro-auth'

Örnek

edgemicro upgradekvm -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

Çıkış (Başarılı)

İşlem başarılı olursa komut, aşağıdakine benzer bir çıkış döndürür:

current nodejs version is v12.5.0
current edgemicro version is 3.1.5
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

Anahtar döndürme

Ortak/özel anahtar çiftlerini döndürmek için edgemicro rotatekey komutunu kullanın .

Daha fazla bilgi edinmek için bkz. JWT anahtarlarını döndürme.

Kullanım

Herkese Açık Bulut İçin Uç: 

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

Private Cloud için Uç: 

edgemicro private rotatekey -o [organization] -e [environment] -k [key] -s [secret] -r '[hostname]/edgemicro-auth/rotateKey'

Parametreler

Parametreler Açıklama
-o, --org (Gerekli) Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env (Gerekli) Edge Microgateway'i yapılandırdığınız bir ortam.
-k, --key "edgemicro configure" komutunu çalıştırdığınızda döndürülen anahtar değeri komutuna ekleyin.
-s, --secret "edgemicro configure" komutunu çalıştırdığınızda döndürülen gizli anahtar değeri komutuna ekleyin.
-p Apigee Edge tarafından kullanılacak özel anahtara giden yol. (3.1.6'ya Eklendi)
-c Apigee Edge tarafından kullanılacak özel sertifikanın yolu. (3.1.6'ya Eklendi)
-n, --nbf

Yeni bir özel anahtarın geçerli hale gelmesi için gecikme süresini dakika cinsinden yapılandırın. Bu gecikme, mikro ağ geçidi örneklerinin yeni herkese açık kullanıcı tarafından yenilenmesi için zaman tanır tuşuna basın. Gecikmeyi config_change_poll_internal yapılandırma ayarından daha yüksek bir değere ayarlamak iyi bir uygulamadır. Bu değer varsayılan olarak 10 dakikadır. Daha fazla bilgi için "Daha önce değil" seçeneği yapılandırma gecikme. (3.1.6'ya Eklendi)

Not: Bu seçeneği şundan daha eski edgemicro-auth sürümleriyle kullanırsanız: Edge Microgateway 3.1.6 ile dağıtılan sürümse işaret yoksayılır.

-i, --kid (İsteğe bağlı) Belirli bir anahtarla eşleştirmek için kullanılan kimlik. Edge Mikro Ağ Geçidi, bu değeri aşağıdakileri yapmak için kullanır: anahtar rotasyonu sırasında bir dizi tuş arasından seçim yapın. Bu parametre eklenmezse (önerilir) Edge Microgateway, zaman damgası tabanlı bir anahtar oluşturur. Daha fazla bilgi için bkz. Bölüm 4.5 JSON Web Anahtarı spesifikasyonu.
-r, --rotatekeyuri Anahtar URI'sini döndürün.

Edge Herkese Açık Bulut: İsteğe bağlı.
Edge Private Cloud: Zorunlu.

Herkese açık Cloud örneği: 

-r 'https://[org]-[env].apigee.net/edgemicro-auth/rotateKey'

Edge Private Cloud örneği: 

-r '[hostname]/edgemicro-auth/rotateKey'

Örnek

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47

Çıkış (Başarılı)

İşlem başarılı olursa komut, aşağıdakine benzer bir çıkış döndürür:

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!

Döndürme işleminden sonra Edge kullanıcı arayüzünde mikro ağ geçidine yeni anahtarların eklendiğini görebilirsiniz KVM'ye gidin.

Örnek

Bu örnekte, yolu belirtmek için -p ve -c işaretleri kullanılmaktadır özel anahtar/sertifika çiftine bağlamanızı sağlar. Bu seçenekler özel bir özel anahtar ve sertifika iletmenize olanak tanır eşlemeye devam edin. 

edgemicro rotatekey -o docs -e test \
-k 27ee39567c75e4567a66236cbd4e86d1cc93df6481454301bd5fac4d3497fcbb \
-s 4618b0008a6185d7327ebf53bee3c50282ccf45a3cceb1ed9828bfbcf1148b47 \
-p /users/home/keys.pem -c /users/home/cert.cert

Sonsuza kadar izleme

Forever'ı yönetmek için edgemicro forever komutunu kullanın işlemi, uygulamanın çökmesi veya bir hata olması durumunda Node.js uygulamasını otomatik olarak yeniden başlatan bir Node.js aracıdır. Şu kaynakları da inceleyin: Sonsuza kadar izleme.

Kullanım

edgemicro forever komutunu yürütmeden önce aşağıdaki ortam değişkenlerini ayarlamanız gerekir:

  • EDGEMICRO_ORG - Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
  • EDGEMICRO_ENV - Edge Microgateway'i yapılandırdığınız ortam.
  • EDGEMICRO_KEY - "edgemicro yapılandırması"nı çalıştırdığınızda döndürülen anahtar değeri komutuna ekleyin.
  • EDGEMICRO_SECRET - "edgemicro yapılandırması"nı çalıştırdığınızda döndürülen gizli anahtar değeri komutuna ekleyin.
edgemicro forever -f [forever_file] -a [start|stop]

Parametreler

ParametreAçıklama
-f, --fileforever.json dosyasının konumunu belirtir.
-a, --actionstart veya stop. Varsayılan değer, başlangıç değeridir.

Örnekler:

Kalıcı bir şekilde başlamak için:

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

Kalıcı olarak durdurmak için:

edgemicro forever -a stop

Anahtarları iptal etme

Bir için anahtar ve gizli kimlik bilgilerini iptal etmek üzere edgemicro revokekeys komutunu kullanın Edge Mikro Ağ Geçidi yapılandırması.

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org (Gerekli) Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env (Gerekli) Edge Microgateway'i yapılandırdığınız bir ortam.
-u, --username (Gerekli) Apigee kullanıcı adınız. Belirtilen kurum içinde tutmaktır.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırını kullanın.
-k, --key (Zorunlu) İptal edilecek anahtar.
-s, --secret (Zorunlu) İptal edilecek gizli anahtar.

Örnekler

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

İşlem başarılı olduğunda aşağıdaki mesajı görürsünüz:

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully