Menggunakan utilitas apigee-adminapi.sh

Edge for Private Cloud v4.18.05

Gunakan utilitas apigee-adminapi.sh untuk melakukan tugas konfigurasi Edge yang sama dengan yang Anda lakukan dengan melakukan panggilan ke Edge Management API. Keuntungan utilitas apigee-adminapi.sh adalah:

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

Utilitas apigee-adminapi.sh bukan pengganti utilitas apigee-provision. Utilitas apigee-provision sebenarnya menggunakan utilitas apigee-adminapi.sh untuk melakukan tugasnya.

Perbedaan utama antara keduanya adalah:

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

Dokumentasi Edge menggunakan kedua utilitas jika sesuai.

Menginstal apigee-adminapi.sh

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

Utilitas 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 yang sederhana. Kapan saja, gunakan tombol tab untuk menampilkan perintah yang mencantumkan opsi perintah yang tersedia.

Untuk melihat semua kemungkinan perintah, panggil utilitas tanpa opsi:

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

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

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

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

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

Anda akan melihat opsi yang memungkinkan 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 opsi -h seperti yang ditunjukkan di bawah:

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

Utilitas ini menampilkan informasi bantuan lengkap untuk semua opsi yang memungkinkan pada perintah orgs. Item pertama dalam output menampilkan 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

Menetapkan parameter menggunakan tombol command line dan variabel lingkungan

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

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

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

Jika Anda menghilangkan parameter yang diperlukan untuk perintah, utilitas akan menampilkan pesan error yang menjelaskan parameter yang tidak ada. Misalnya, jika Anda menghilangkan variabel lingkungan --host atau EDGE_SERVER yang menentukan Server Pengelolaan Edge saat membuat org, 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 alamat email admin sistem dan alamat IP Server Pengelolaan: 

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

Meneruskan file ke utilitas apigee-adminapi.sh

Beberapa perintah utilitas apigee-adminapi.sh sesuai dengan panggilan API PUT dan POST yang menggunakan isi permintaan. Misalnya, membuat host virtual sesuai dengan panggilan API POST yang memerlukan informasi tentang host virtual dalam isi permintaan.

Saat menggunakan utilitas apigee-adminapi.sh untuk membuat host virtual, atau perintah apa pun yang menggunakan isi permintaan, Anda dapat meneruskan semua informasi yang diperlukan di command line seperti yang ditunjukkan di bawah:

/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 dimuat dalam isi permintaan 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 yang berisi isi POST panggilan. Dalam contoh ini, isi permintaan berformat XML:

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

Menampilkan informasi debug dan API

Gunakan opsi --debug ke utilitas apigee-adminapi.sh untuk menampilkan informasi mendetail tentang perintah. Informasi ini mencakup perintah curl yang dihasilkan oleh utilitas apigee-adminapi.sh untuk melakukan 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