Edge for Private Cloud s. 4.16.05
apigee-adminapi.sh dosyasını kullanma yardımcı programını kullanarak Edge yapılandırma görevlerini yönetim API'si. apigee-adminapi.sh yardımcı programının avantajı, şunları sağlar:
- Basit bir komut satırı arayüzü kullanın
- Sekme tabanlı komut tamamlamayı uygular
- Yardım ve kullanım bilgileri sağlar
- API'yi denemeye karar verirseniz ilgili API çağrısını gösterebilir.
apigee-adminapi.sh yardımcı programı apigee-provision yardımcı programının yerine geçecek. apigee-provision yardımcı programı, apigee-adminapi.sh yardımcı programını yerine getirmesi gerektiği anlamına gelir.
Bu ikisi arasındaki temel farklar şunlardır:
- apigee-adminapi.sh yardımcı programı bağımsız Edge API çağrılarının yerine geçen atomik işlevler gerçekleştirir. Örneğin, kuruluş, ortam ve sanal ana makine için üç ayrı apigee-adminapi.sh komutu gerekir. üç API çağrısına karşılık gelir.
- apigee-provision yardımcı program, tek bir komutla üst düzey işlemi gerçekleştirmek üzere tasarlanmıştır. Örneğin, Örneğin, tek bir kullanıcıyla bir kuruluş, ortam ve sanal ana makine apigee-provision komutunu gerekli tüm bilgileri içeren bir yapılandırma dosyasını iletmek.
Edge belgeleri, uygun olduğunda her iki yardımcı programı da kullanır.
Apigee-adminapi.sh dosyasını yükleme
apigee-adminapi.sh yardımcı programı apigee-provision veya apigee-provision yardımcı programını yüklediğinizde otomatik olarak yüklenir.
Yardımcı program şu konuma yüklenir:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
Apigee-adminapi.sh söz dizimi
apigee-adminapi.sh yardımcı programı basit bir komut satırı söz dizimi kullanır. İstediğiniz zaman sekme tuşunu kullanarak komut seçeneklerini kullanabilirsiniz.
Olası tüm komutları görmek için yardımcı programı hiçbir seçenek olmadan çağırın:
> apigee-adminapi.sh
Apigee-adminapi.sh yazdıktan sonra sekme tuşuna basarsanız, çalıştırabileceğiniz seçenekler:
analytics classification logsessions regions securityprofile userroles buildinfo GET orgs runtime servers users
Sekme tuşu, komutun bağlamına göre seçenekleri görüntüler. Sekme tuşunu girerseniz yazdıktan sonra:
> apigee-adminapi.sh orgs
orgs komutunu tamamlamak için kullanılabilecek seçenekleri görürsünüz:
add apis apps delete envs list pods userroles
Şu bilgileri görüntülemek için -h seçeneğini kullanın: yardımcı olabilir. Örneğin, aşağıda gösterildiği gibi -h seçeneğini kullanırsanız:
> apigee-adminapi.sh orgs -h
Yardımcı program, orgs komutuna ilişkin olası tüm seçenekler için eksiksiz yardım bilgilerini görüntüler. Çıkıştaki ilk öğe "orgs add" ile ilgili yardımı gösterir. komut:
+++++++++++++++++++++++++++++++++++++++++++ orgs add Required: -o ORG Organization name Optional: -H HEADER add http header in request --admin ADMIN_EMAIL admin email address --pwd ADMIN_PASSWORD admin password --host EDGE_SERVER edge server to make request to --port EDGE_PORT port to use for the http request --ssl set EDGE_PROTO to https, defaults to http --debug ( set in debug mode, turns on verbose in curl ) -h Displays Help
Parametreleri ayarlama (komut satırı anahtarlarını ve ortam değişkenlerini kullanarak)
Tüm parametreleri, komut satırı anahtarlarını veya değişkenlerine odaklanmalıdır. Komut satırı anahtarlarının önüne tek kısa çizgi (-) veya çift tire ile başlayın (--) işaretini kaldırın.
Örneğin, yukarıdaki yardım bölümünde gösterilen "kuruluş ekleme" komutunun kullanılması durumunda, kuruluş adını girin:
- -o komut satırını kullanma
anahtar:
> Apigee-adminapi.sh orgs -o testOrg - ORG:
adlı bir ortam değişkeni ayarlanıyor > ORG=testOrg
'u dışa aktar > Apigee-adminapi.sh orgs
Gerekli parametreleri komuta atlarsanız yardımcı program bir hata mesajı gösterir eksik parametreleri açıklayacağım. Örneğin, --host veya EDGE_SERVER ortam değişkenini belirterek Uç Yönetim Sunucusu'nu devre dışı bırakırsanız şu hata mesajını görürsünüz:
Error with required variable or parameter ADMIN_PASSWORD....OK ADMIN_EMAIL....OK EDGE_SERVER....null
Genellikle ortam değişkeni olarak ayarladığınız iki yaygın parametre, sys yönetici e-postasıdır Yönetim Sunucusu'nun adresi ve IP adresi:
> export ADMIN_EMAIL=foo@bar.com > export EDGE_SERVER=192.168.56.101
Apigee-adminapi.sh öğesine dosya iletme elektrik, su veya doğalgaz
Bazı apigee-adminapi.sh yardımcı programı komutları istek gövdesini alan PUT ve POST API çağrılarına karşılık gelir. Örneğin, sanal bir web sitesi ana makine, postadaki sanal ana makine hakkında bilgi gerektiren bir POST API çağrısına karşılık gelir: istek gövdesi.
apigee-adminapi.sh yardımcı programını bir sanal ana makine veya istek gövdesi alan herhangi bir komut oluşturduğunuzda, komut satırındaki gerekli bilgileri aşağıda gösterildiği gibi bulabilirsiniz:
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -v myVHostUtil -p 9005 -a 192.168.56.101:9005
Alternatif olarak, istekte yer alan bilgilerle aynı bilgileri içeren bir dosyayı iletebilirsiniz. POST gövdesidir. Örneğin, aşağıdaki komut, sanal ana makineyi tanımlayan bir dosyayı alır:
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate
vhostcreate , çağrının POST gövdesini içerir. Bu örnekte, XML biçimli bir istek gövdesidir:
<VirtualHost name="myVHostUtil">
<HostAliases>
<HostAlias>192.168.56.101:9005</HostAlias>
</HostAliases>
<Interfaces/>
<Port>9005</Port>
</VirtualHost>
Hata ayıklama ve API bilgilerini görüntüleme
--debug seçeneğini kullanarak apigee-adminapi.sh yardımcı programını komut hakkında ayrıntılı bilgi görüntüler. Bu bilgiler, cURL komutunu içerir. apigee-adminapi.sh yardımcı programı tarafından oluşturulan işlemi gerçekleştirin.
Örneğin, aşağıdaki komut --debug seçeneğini kullanır:
> apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
Oluşturulan cURL komutuyla birlikte aşağıdaki çıkışı gösterir:
curl -H Content-Type: application/xml -v -X POST -s -k -w \n==> %{http_code} -u ***oo@bar.com:***** http://localhost:8080/v1/o -d <Organization name="testOrg2" type="paid"/> * About to connect() to localhost port 8080 (#0) * Trying ::1... connected * Connected to localhost (::1) port 8080 (#0) * Server auth using Basic with user 'foo@bar.com' > POST /v1/o HTTP/1.1 > Authorization: Basic c2dp234234NvbkBhcGlnZ2342342342342341Q5 > User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.19.1 Basic ECC zlib/1.2.3 libidn/1.18 libssh2/1.4.2 > Host: localhost:8080 > Accept: */* > Content-Type: application/xml > Content-Length: 43 > } [data not shown] < HTTP/1.1 201 Created < Content-Type: application/json < Date: Tue, 03 May 2016 02:08:32 GMT < Content-Length: 291 < { [data not shown] * Connection #0 to host localhost left intact * Closing connection #0