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

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Edge Microgateway v. 3.2.x

Genel Bakış

Edge Microgateway CLI, bir Edge Microgateway örneğinin tüm yönlerini kontrol etmenize ve yönetmenize olanak tanır.

Sertifikaları yönetme

cert komutları, Edge Microgateway üzerinden güvenli aramalar yapmak için istemciler tarafından kullanılan taşıyıcı jetonları imzalamak üzere kullanılan herkese açık/özel anahtar çiftini yüklemenize ve yönetmenize olanak tanır. Anahtarlar, Apigee Edge'de şifrelenmiş bir anahtar/değer eşlemesinde (KVM) depolanır. Edge Microgateway, imzalı taşıyıcı jetonları doğrulamak için ortak anahtarı kullanır. Bu anahtarlar, Edge Microgateway'i ayarlama ve yapılandırma bölümünde açıklandığı gibi edgemicro configure komutunu çalıştırdığınızda oluşturulur. Gerekirse bu anahtarları yeniden oluşturmak ve yönetmek için burada açıklanan cert komutlarını kullanabilirsiniz.

Sertifika yükle

Anahtarları şifrelenmiş bir Anahtar/Değer Eşlemesi'ne (KVM) yükler ve ortak anahtarı çıkış olarak döndürür. Anahtar çiftleri, belirtilen bir kuruluşla sınırlıdır.

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 kuruluşun kuruluş yöneticisi olmanız gerekir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında sağlamazsanız sizden istenir.
-f, --force (İsteğe bağlı) Şifrelenmiş KVM'de zaten bir anahtar depolanıyorsa anahtarın değiştirilmesini zorlayı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

Bir 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 kuruluşun kuruluş yöneticisi olmanız gerekir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında sağlamazsanız sizden istenir.
-h, --help Çıkış kullanım bilgileri.

Örnek

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

Çıkış

deleting vault
Vault deleted!

Sertifikayı kontrol etme

Kuruluşunuzda bir sertifika 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 kuruluşun kuruluş yöneticisi olmanız gerekir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında sağlamazsanız sizden istenir.
-h, --help Çıkış kullanım bilgileri.

Örnek

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

Çıkış (Başarı)

checked cert successfully

Çıkış (Başarısız)

Sertifika yoksa 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 Microgateway'i yapılandırma

Edge Microgateway'in bir Apigee Edge Cloud örneğiyle çalışmasını sağlar. Gerekli kimlik doğrulama proxy'sini Edge'e dağıtmak, kimlik doğrulama jetonları oluşturmak ve yapılandırma dosyalarını güncellemek için bir komut dizisini sarmalar ve yürütür. Çalışan bir örneğin tamamı için Edge Microgateway'i kurma ve 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 kuruluşun kuruluş yöneticisi olmanız gerekir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında sağlamazsanız sizden istenir.
-r, --url (İsteğe bağlı) Kuruluşunuz:ortam için sanal ana makine diğer adını belirtir. Sanal ana makineler hakkında bilgi edinmek için Edge belgelerine bakın. 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. (v2.4.x sürümünde eklendi)
-x, --proxyName (İsteğe bağlı) edgemicro-auth proxy'si için temel yolu ayarlar. edgemicro-auth proxy'si varsayılandan farklı bir yol altında dağıtılırsa, bu özellik Edge Microgateway'de yeni yolu ayarlamanıza olanak tanır. Varsayılan olarak temel yol /edgemicro-auth'dur. (2.4.x sürümünde 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 API çağrılarını güvenli hale getirme başlıklı makaleyi de inceleyin. Örneğin:

edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts (İsteğe bağlı) "default,secure" olan varsayılan sanal ana makineleri geçersiz kılar. Edge kuruluşunuz:ortamınız için bu varsayılanlar dışında sanal ana makineleriniz varsa bu seçeneği kullanın. Sanal ana makineler hakkında bilgi edinmek için Edge belgelerine bakın.
-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 ~/.edgemicro/org-env-config.yaml konumunda depolar.

Örnek

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

Çıkış

Başarılı olursa komut, Edge Microgateway'i başlattığınızda kullanmanız gereken bir dizi anahtar döndürür.

...

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

edgemicro configuration complete!

Anahtar oluşturma

genkeys komutu, Edge Microgateway'in analiz verilerini Apigee Edge'e eşzamansız olarak yayınlarken kimliğini doğrulamak için kullandığı bir anahtar ve gizli dizi çifti oluşturur.

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 kuruluşun kuruluş yöneticisi olmanız gerekir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında sağlamazsanız sizden istenir.
-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 API çağrılarını güvenli hale getirme 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ı

Başarılı olursa komut üç öğe döndürür. Birincisi, yapılandırma dosyasına yerleştirmeniz gereken bir URL'dir. Diğer ikisi ise bir Edge Microgateway örneğini başlattığınızda gerekli olan bir anahtar çiftidir.

  • bootstrap URL: Bu URL, bir Edge Microgateway örneğinin Apigee Edge'e analiz verileri göndermesini sağlayan bir Apigee Edge hizmetini işaret eder. Bu URL'yi Edge Microgateway yapılandırma dosyasına (~/.edgemicro/org-env-config.yaml) kopyalamanız gerekir.
  • key: Anahtar. Bu anahtar ve gizli anahtar, Edge Microgateway örneğini başlatmak için kullanılan CLI komutuna giriş olarak gereklidir.
  • secret: Gizli bilgi.

Örnek

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

Çıkış (Örnek)

Başarılı olursa komut, Edge Microgateway'i başlattığınızda kullanmanız gereken bir dizi anahtar döndürür.

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 Microgateway'i yapılandırma

Edge Microgateway'i bir 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 kuruluşun kuruluş yöneticisi olmanız gerekir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında sağlamazsanız sizden istenir.
-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:ortam için sanal ana makinelerin virgülle ayrılmış listesi. 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. (v2.4.x sürümünde 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 API çağrılarını güvenli hale getirme 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 ~/.edgemicro/org-env-config.yaml konumunda depolar.

Ö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ış

Başarılı olursa komut, Edge Microgateway'i başlattığınızda kullanmanız gereken bir dizi anahtar döndürür.

...

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

edgemicro configuration complete!

Edge Microgateway'i başlatma

Edge Microgateway'i başlatmadan önce edgemicro configure (Public Cloud) veya edgemicro private configure (Private Cloud) komutunu çalıştırmanız gerekir. configure komutu, Edge Microgateway'i başlatmak için gereken anahtar ve gizli değerleri 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.
-s, --secret "edgemicro configure" komutunu çalıştırdığınızda döndürülen gizli anahtar değeri.
-p, --processes (İsteğe bağlı) Başlatılacak işlem sayısı. Varsayılan: Sisteminizdeki çekirdek sayısı.
-d, --pluginDir (İsteğe bağlı) Eklenti dizininin mutlak yolu.
-r, --port (İsteğe bağlı) ~/.edgemicro/org-env-config.yaml dosyasında belirtilen bağlantı noktası numarasını geçersiz kılar. Varsayılan: 8000
-c, --cluster

(İsteğe bağlı) Edge Microgateway'i küme modunda başlatır.

Not: Bu seçenek, v2.3.1 itibarıyla kaldırılmıştır. v2.3.1 ve sonraki sürümlerde Edge Micro her zaman küme modunda başlar.
-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. (v2.4.x sürümünde eklendi)
-u, --configUrl (İsteğe bağlı) Edge Microgateway'in yapılandırma dosyasını indireceği bir uç nokta belirtir. (v2.5.x sürümünde 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, yapılandırma dosyasında belirtilen bağlantı noktasını geçersiz kılacak bir bağlantı noktası numarası belirtmenize olanak tanır. PORT ortam değişkenini kullanarak da bir bağlantı noktası numarası belirtebilirsiniz. Ö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 döndürür.

Kümeleme hakkında

Edge Microgateway, kümelemeyi etkinleştirmek için Node.js küme modülünü kullanır. Kümeleme, Edge Microgateway'in çok çekirdekli sistemlerden yararlanmasına olanak tanır. Ayrıntılar için bu Node.js belgesine bakın.

Örnek

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

Örnek çıkış:

...

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şim jetonlarını almanıza, kodunu çözmenize ve doğrulamanıza olanak tanır. Ayrıca OAuth2 erişim jetonuyla API çağrılarını güvenli hale getirme başlıklı makaleyi de inceleyin.

Jetonun kodunu çözme

İmzalı ve kodlanmış bir taşıyıcı jetonun kodunu, düz metin JSON JWT (Java Web Token) gösterimine dönüştürür. Jeton, jetonu oluşturmak için kullanılan anahtarları sağlayan Apigee Edge geliştirici uygulamasıyla ilgili bilgileri (ör. uygulama adı, client_id, ürün listesi) aktarır.

Kullanım

edgemicro token decode -f [filename]

Parametreler

Parametreler Açıklama
-f, --file Kod çö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şturma

İmzalı bir taşıyıcı jeton oluşturur. Jeton, istemci uygulamalarının Edge Microgateway'e kimliği doğrulanmış API çağrıları yapmasına olanak tanır. Jeton, OAuth 2.0 uyumlu bir JSON Web Token'dır (JWT). Apigee Edge'de kayıtlı bir geliştirici uygulamasından alınan tüketici anahtarı (istemci kimliği) ve tüketici gizli anahtarı (istemci gizli anahtarı) değerlerinin giriş olarak sağlanması gerekir. Ayrıca OAuth2 erişim jetonuyla API çağrılarını güvenli hale getirme başlıklı makaleyi de inceleyin.

başlıklı makaleyi inceleyin.

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 Mikro ağ geçidi uyumlu vekilinizle ilişkili geliştirici uygulamasının istemci kimliği.
-s, --secret Microgateway'e duyarlı proxy'nizle ilişkili Developer uygulamasından alınan istemci gizli anahtarı.
-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' }

Yönetim API'sini 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şunuzun adıdır (kuruluş yöneticisi olmanız gerekir).
  • $ENV, kuruluşunuzdaki bir ortamdır (ör. "test" veya "prod").
  • $CLIENT_ID, daha önce oluşturduğunuz geliştirici uygulamasındaki tüketici kimliğidir.
  • $CLIENT_SECRET, daha önce oluşturduğunuz geliştirici uygulamasındaki Consumer Secret'tır.

Jeton doğrulama

Belirtilen kuruluş ve ortam için Apigee Edge'de depolanan ortak anahtara karşı imzalı bir taşıyıcı jetonunu doğrular.

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 bir 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 dolmuş 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ını başlatma

Bu komutu Edge Microgateway'i ilk yükledikten sonra bir kez çalıştırın. Yeni bir varsayılan yapılandırma dosyası oluşturur: ~/.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. (v2.4.x sürümünde eklendi)
-h, --help Çıkış kullanım bilgileri.

Örnek

edgemicro init

Çıkış (Başarı)

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

Edge Microgateway 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ı)

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ümesinin durumunu kontrol etme

Edge Microgateway varsayılan olarak küme modunda başlatılır. Kümenin durumunu kontrol etmek için bu komutu kullanabilirsiniz.

Kullanım

edgemicro status

Parametreler

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

Örnek

edgemicro status

Çıkış (Başarı)

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 Microgateway kümesini durdurur.

Kullanım

edgemicro stop

Parametreler

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

Örnek

edgemicro stop

Çıkış (Başarı)

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

Yapılandırma değişikliğinden sonra sıfır kapalı kalma süresiyle yeniden başlatma sağlar. Yeni bir yapılandırma çekerek Edge Microgateway'i yeniden yükler.

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.
-s, --secret "edgemicro configure" komutunu çalıştırdığınızda döndürülen gizli anahtar değeri.
-h, --help Çıkış kullanım bilgileri.

Örnek

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

Çıkış (Başarı)

...

Reload Completed Successfully

edgemicro-auth proxy'sini yükseltme

Anahtar rotasyonunu kullanmak için Apigee Edge kuruluşunuzda yükseltilmiş bir edgemicro-auth proxy'si dağıtılmış olmalıdır. (v2.5.x sürümünde eklendi)

Not: Mevcut Edge Micro örneğinizi 2.5.2 sürümünden önce yapılandırdıysanız anahtar rotasyonunu kullanmak için bu proxy'yi yükseltmeniz gerekir. Bu yükseltmeyi yalnızca bir kez yapmanız gerekir.

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 kuruluşun kuruluş yöneticisi olmanız gerekir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında sağlamazsanız sizden istenir.
-v, --virtualhost (İsteğe bağlı) Proxy'nin sanal ana makinesi.
-b, --baseuri (İsteğe bağlı) Apigee Edge'de kuruluşunuzun temel URI'si. Varsayılan olarak, Apigee bulut dağıtımları için temel URI api.enterprise.apigee.com'dur. Şirket içi dağıtımlar için temel URL farklı olabilir.

Örnek

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

Çıkış (Başarı)

İşlem başarılı olduğunda 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 kuruluşunuzdaki KVM'yi yükseltmek için edgemicro upgradekvm komutunu kullanın. Anahtar rotasyonu özelliğini kullanmak istiyorsanız KVM'yi yükseltmeniz gerekir.

Kullanım

Edge for Public Cloud: 

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

Edge for Private Cloud: 

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.
-s, --secret "edgemicro configure" komutunu çalıştırdığınızda döndürülen gizli anahtar değeri.
-p, --proxyuri edgemicro_auth proxy için URI

Edge Public Cloud: İsteğe bağlıdır.
Edge Private Cloud: Gerekli.

Edge Public Cloud ö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ı)

İşlem başarılı olduğunda 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 rotasyonu

Edge Microgateway'de OAuth güvenliği için kullanılan JWT jetonlarını oluşturmak üzere kullanılan ortak/özel anahtar çiftlerini döndürmek için edgemicro rotatekey komutunu kullanın.

Daha fazla bilgi için JWT anahtarlarına rotasyon uygulama başlıklı makaleyi inceleyin.

Kullanım

Edge for Public Cloud: 

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

Edge for Private Cloud: 

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

Parametreler

Parametreler Açıklama
-o, --org (Zorunlu) Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env (Zorunlu) 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.
-s, --secret "edgemicro configure" komutunu çalıştırdığınızda döndürülen gizli anahtar değeri.
-p Apigee Edge tarafından kullanılacak özel anahtarın yolu. (3.1.6 sürümünde eklendi)
-c Apigee Edge tarafından kullanılacak özel sertifikanın yolu. (3.1.6 sürümünde eklendi)
-n, --nbf

Yeni bir özel anahtarın geçerli olması için gereken süreyi dakika cinsinden yapılandırın. Bu gecikme, mikro ağ geçidi örneklerinin yeni ortak anahtarla yenilenmesine olanak tanır. Gecikmeyi config_change_poll_internal yapılandırma ayarından daha uzun olacak şekilde ayarlamak iyi bir uygulamadır. Bu ayar varsayılan olarak 10 dakikadır. Daha fazla bilgi için "Not before" gecikmesi yapılandırma başlıklı makaleyi inceleyin. (3.1.6 sürümünde eklendi)

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

-i, --kid (İsteğe bağlı) Belirli bir anahtarı eşleştirmek için kullanılan kimlik. Edge Microgateway, anahtar rotasyonu sırasında bir anahtar kümesi arasından seçim yapmak için bu değeri kullanır. Bu parametre atlanırsa (önerilir) Edge Microgateway, zaman damgası tabanlı bir anahtar oluşturur. Daha fazla bilgi için JSON Web Key spesifikasyonunun 4.5. bölümüne bakın.
-r, --rotatekeyuri Anahtar URI'sini döndürün.

Edge Public Cloud: İsteğe bağlıdır.
Edge Private Cloud: Gerekli.

Herkese açık bulut ö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ı)

İşlem başarılı olduğunda 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çidi KVM'ye yeni anahtarların eklendiğini görebilirsiniz.

Örnek

Bu örnekte, özel anahtar/sertifika çiftinin yolunu belirtmek için -p ve -c işaretleri kullanılmaktadır. Bu seçenekler, özel bir özel anahtar ve sertifika çifti iletmenize olanak tanır. 

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

Sürekli izleme

Uygulama çökerse veya hata oluşursa Node.js uygulamasını otomatik olarak yeniden başlatan bir Node.js aracı olan Forever sürecini yönetmek için edgemicro forever komutunu kullanın. Sürekli izleme başlıklı makaleyi de inceleyin.

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 bir ortam.
  • EDGEMICRO_KEY - "edgemicro configure" komutunu çalıştırdığınızda döndürülen anahtar değeri.
  • EDGEMICRO_SECRET: "edgemicro configure" komutunu çalıştırdığınızda döndürülen gizli değer.
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ıçtır.

Örnekler:

Sürekli modunu başlatmak için:

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

Sonsuza Kadar özelliğini durdurmak için:

edgemicro forever -a stop

Anahtarları iptal etme

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

Kullanım

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

Parametreler

Parametreler Açıklama
-o, --org (Zorunlu) Edge Microgateway'i yapılandırdığınız Apigee kuruluşu.
-e, --env (Zorunlu) Edge Microgateway'i yapılandırdığınız bir ortam.
-u, --username (Zorunlu) Apigee kullanıcı adınız. Belirtilen kuruluşun kuruluş yöneticisi olmanız gerekir.
-p, --password (İsteğe bağlı) Şifreniz. Bu parametreyi komut satırında sağlamazsanız sizden istenir.
-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