Menggunakan utilitas apigee-adminapi.sh

Edge for Private Cloud v4.18.05

Gunakan utilitas apigee-adminapi.sh untuk melakukan tugas konfigurasi Edge yang sama yang dilakukan dengan melakukan panggilan ke API pengelolaan Edge. Keuntungan dari Utilitas apigee-adminapi.sh adalah fungsi ini:

  • Menggunakan antarmuka command line sederhana
  • Mengimplementasikan penyelesaian perintah berbasis tab
  • Memberikan bantuan dan informasi penggunaan
  • Dapat menampilkan panggilan API yang sesuai jika Anda memutuskan untuk mencoba API

Utilitas apigee-adminapi.sh bukanlah pengganti Utilitas apigee-provision. Utilitas apigee-provision sebenarnya menggunakan Utilitas apigee-adminapi.sh untuk menjalankan tugasnya.

Perbedaan utama antara keduanya adalah:

  • Utilitas apigee-adminapi.sh menjalankan fungsi atomik yang menggantikan setiap panggilan Edge API. Misalnya, untuk membuat organisasi, lingkungan, dan virtual host memerlukan tiga perintah apigee-adminapi.sh terpisah yang sesuai dengan tiga Panggilan API.
  • Utilitas apigee-provision dirancang untuk menjalankan tingkat tinggi yang lengkap operasi dalam satu perintah. Misalnya, Anda dapat membuat organisasi, lingkungan, dan host virtual dengan satu perintah apigee-provision dengan meneruskan file konfigurasi menggunakan semua informasi yang diperlukan.

Dokumentasi Edge menggunakan kedua utilitas tersebut jika diperlukan.

Menginstal apigee-adminapi.sh

Utilitas apigee-adminapi.sh secara otomatis diinstal saat Anda menginstal apigee-provision atau utilitas apigee-validate.

Utilitas akan diinstal di lokasi berikut:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

Sintaksis /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

Utilitas apigee-adminapi.sh menggunakan sintaksis command line sederhana. Kapan saja, gunakan tombol tab untuk menampilkan {i>prompt<i} yang berisi daftar opsi perintah yang tersedia.

Untuk melihat semua kemungkinan perintah, panggil utilitas tanpa opsi:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

Jika menekan tombol tab setelah mengetik apigee-adminapi.sh, Anda akan melihat daftar kemungkinan opsi:

analytics  classification  logsessions  regions  securityprofile  userroles
buildinfo  GET             orgs         runtime  servers          users

Tombol tab menampilkan opsi berdasarkan konteks perintah. Jika Anda memasukkan tombol tab setelah mengetik:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs

Anda akan melihat kemungkinan opsi untuk menyelesaikan perintah orgs:

add  apis  apps  delete  envs  list  pods  userroles

Gunakan opsi -h untuk menampilkan bantuan untuk perintah apa pun. Misalnya, jika Anda menggunakan -h seperti yang ditunjukkan di bawah ini:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -h

Utilitas ini menampilkan informasi bantuan lengkap untuk semua opsi yang mungkin bagi Perintah orgs. Item pertama dalam output menunjukkan bantuan untuk Perintah orgs add:

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

Parameter setelan menggunakan tombol command line dan variabel lingkungan

Anda harus memasukkan semua parameter ke perintah dengan menggunakan tombol command line, atau menggunakan variabel lingkungan. Awali tombol command line dengan satu tanda hubung (-) atau tanda pisah ganda (--) sesuai kebutuhan.

Misalnya, dari bantuan yang ditampilkan di atas untuk "orgs add" , Anda dapat menentukan nama organisasi baik dengan:

  • Menggunakan tombol command line -o: 
    /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -o testOrg
  • Menyetel variabel lingkungan bernama ORG: 
    > export ORG=testOrg
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs

Jika Anda menghilangkan parameter yang diperlukan untuk perintah tersebut, utilitas akan menampilkan pesan error yang menjelaskan parameter yang hilang. Misalnya, jika Anda menghilangkan --host atau Variabel lingkungan EDGE_SERVER yang menentukan Server Pengelolaan Edge saat membuat organisasi, Anda akan melihat pesan error berikut:

Error with required variable or parameter
ADMIN_PASSWORD....OK
ADMIN_EMAIL....OK
EDGE_SERVER....null

Dua parameter umum yang sering Anda tetapkan sebagai variabel lingkungan adalah email admin sistem dan alamat IP Server Pengelolaan: 

export ADMIN_EMAIL=foo@bar.com
export EDGE_SERVER=192.168.56.101

Meneruskan file ke apigee-adminapi.sh utilitas

Beberapa perintah utilitas apigee-adminapi.sh sesuai dengan panggilan PUT dan POST API yang mengambil isi permintaan. Misalnya, membuat sesuai dengan panggilan POST API yang membutuhkan informasi tentang {i>host<i} virtual di isi permintaan.

Saat menggunakan utilitas apigee-adminapi.sh untuk membuat {i>host<i} virtual, atau perintah apa pun yang mengambil isi permintaan, Anda bisa meneruskan semua informasi yang diperlukan pada command line seperti yang ditunjukkan di bawah ini:

/opt/apigee/apigee-adminapi/bin/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

Atau, Anda dapat meneruskan file yang berisi informasi yang sama seperti yang akan terkandung dalam permintaan isi POST. Misalnya, perintah berikut mengambil file yang menentukan host virtual:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate

Dengan file vhostcreate berisi isi POST panggilan. Dalam contoh ini, adalah isi permintaan berformat XML:

<VirtualHost name="myVHostUtil">
   <HostAliases>
     <HostAlias>192.168.56.101:9005</HostAlias>
   </HostAliases>
   <Interfaces/>
   <Port>9005</Port>
</VirtualHost>

Menampilkan informasi API dan debug

Gunakan opsi --debug pada utilitas apigee-adminapi.sh untuk menampilkan informasi terperinci tentang perintah itu. Informasi ini mencakup perintah {i>curl<i} yang dihasilkan oleh utilitas apigee-adminapi.sh untuk menjalankan operasi.

Misalnya, perintah ini menggunakan opsi --debug:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug

Dan menampilkan output berikut, termasuk perintah curl yang dihasilkan:

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