apigee-adminapi.sh के यूटिलिटी टूल का इस्तेमाल करना

रखरखाव से जुड़े कई काम करने के लिए, apigee-adminapi.sh Edge मैनेजमेंट एपीआई को कॉल करता है.

apigee-adminapi.sh के बारे में जानकारी

apigee-adminapi.sh को शुरू करें

आपने मैनेजमेंट सर्वर नोड से apigee-adminapi.sh का अनुरोध किया है. यूटिलिटी को शुरू करते समय, आपको इन्हें एनवायरमेंट वैरिएबल या कमांड लाइन के विकल्पों के तौर पर तय करना होगा:

  • ADMIN_EMAIL (admin कमांड लाइन विकल्प के हिसाब से)
  • ADMIN_PASSWORD (pwd)
  • EDGE_SERVER (host)

नीचे दिए गए उदाहरण में, apigee-adminapi.sh को शुरू किया गया है और ज़रूरी वैल्यू को कमांड लाइन के विकल्पों के तौर पर पास किया गया है:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh buildinfo list --admin user@example.com --pwd abcd1234 --host localhost

इस उदाहरण में, ज़रूरी विकल्पों को अस्थायी एनवायरमेंट वैरिएबल के तौर पर बताया गया है. इसके बाद, apigee-adminapi.sh यूटिलिटी को शुरू किया गया है:

export ADMIN_EMAIL=user@example.com
export ADMIN_PASSWORD=abcd1234
export EDGE_SERVER=192.168.56.101
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh servers list

अगर पासवर्ड को विकल्प के तौर पर पास नहीं किया जाता है या उसे एनवायरमेंट वैरिएबल के तौर पर तय नहीं किया जाता है, तो apigee-adminapi.sh आपको उसे डालने के लिए कहेगा.

apigee-adminapi.sh पैरामीटर सेट करें

आपको किसी कमांड में सभी पैरामीटर डालने होंगे. इसके लिए, कमांड-लाइन स्विच का इस्तेमाल करें या एनवायरमेंट वैरिएबल का इस्तेमाल करें. कमांड लाइन स्विच के आगे, ज़रूरत के हिसाब से एक डैश (-) या दो डैश (--) लगाएं.

उदाहरण के लिए, इनमें से किसी एक तरीके से संगठन का नाम दिया जा सकता है:

  • -o कमांड लाइन स्विच का इस्तेमाल करके: 
    /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -o testOrg
  • ORG नाम का एनवायरमेंट वैरिएबल सेट करना: 
    export ORG=testOrg
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs

अगर निर्देश में किसी भी ज़रूरी पैरामीटर को छोड़ दिया जाता है, तो यूटिलिटी टूल एक गड़बड़ी का मैसेज दिखाता है. इसमें उन पैरामीटर के बारे में जानकारी होती है जो मौजूद नहीं हैं. उदाहरण के लिए, अगर --host विकल्प (जो EDGE_SERVER एनवायरमेंट वैरिएबल से जुड़ा है) को छोड़ा जाता है, तो apigee-adminapi.sh इस गड़बड़ी के साथ जवाब देता है:

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

अगर आपको HTTP STATUS CODE: 401 से जुड़ी गड़बड़ी मिलती है, तो इसका मतलब है कि आपने गलत पासवर्ड डाला है.

apigee-adminapi.sh के लिए सहायता पाएं

किसी भी समय, Tab का इस्तेमाल करके एक प्रॉम्प्ट दिखाएं. इसमें, उपलब्ध कमांड के विकल्पों की सूची होगी.

सभी संभावित निर्देश देखने के लिए, बिना किसी विकल्प के यूटिलिटी शुरू करें:

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

apigee-adminapi.sh टाइप करने के बाद, Tab दबाकर रखने पर, आपको संभावित विकल्पों की सूची दिखेगी:

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

Tab बटन, निर्देश के संदर्भ के आधार पर विकल्प दिखाती है. अगर टाइप करने के बाद Tab बटन डाला जाता है, तो:

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

आपको orgs निर्देश को पूरा करने के लिए संभावित विकल्प दिखेंगे:

add  apis  apps  delete  envs  list  pods  userroles

किसी भी निर्देश के लिए सहायता दिखाने के लिए, -h विकल्प का इस्तेमाल करें. उदाहरण के लिए, अगर आप नीचे दिए गए -h विकल्प का इस्तेमाल करते हैं:

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

यूटिलिटी, orgs कमांड के सभी संभावित विकल्पों के बारे में पूरी सहायता जानकारी दिखाती है. आउटपुट का पहला आइटम 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

apigee-adminapi.sh को कोई फ़ाइल पास करें

apigee-adminapi.sh यूटिलिटी, curl के आस-पास एक रैपर है. इस वजह से, कुछ निर्देश PUT और POST एपीआई कॉल के मुताबिक होते हैं, जो अनुरोध का मुख्य हिस्सा होते हैं. उदाहरण के लिए, वर्चुअल होस्ट बनाने का मतलब है POST एपीआई कॉल. इसके लिए, अनुरोध के मुख्य हिस्से में वर्चुअल होस्ट के बारे में जानकारी की ज़रूरत होती है.

वर्चुअल होस्ट बनाने के लिए apigee-adminapi.sh यूटिलिटी का इस्तेमाल करते समय या अनुरोध का मुख्य हिस्सा लेने वाला कोई भी कमांड, कमांड लाइन पर दी जा सकती है. इसकी जानकारी नीचे दी गई है:

/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

इसके अलावा, आपके पास ऐसी फ़ाइल को पास करने का विकल्प होता है जिसमें वही जानकारी हो जो POST के अनुरोध के मुख्य हिस्से में शामिल हो. उदाहरण के लिए, नीचे दिया गया निर्देश वर्चुअल होस्ट की पहचान करने वाली फ़ाइल लेता है:

/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

जहां vhostcreate फ़ाइल में कॉल का मुख्य हिस्सा POST होता है. इस उदाहरण में, यह एक्सएमएल के फ़ॉर्मैट में अनुरोध का मुख्य हिस्सा है:

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

डीबग और एपीआई की जानकारी दिखाएं

निर्देश के बारे में पूरी जानकारी दिखाने के लिए, apigee-adminapi.sh यूटिलिटी में --debug विकल्प का इस्तेमाल करें. इस जानकारी में curl कमांड शामिल है. यह निर्देश, कार्रवाई करने के लिए, apigee-adminapi.sh यूटिलिटी से जनरेट होता है.

उदाहरण के लिए, नीचे दिए गए निर्देश में --debug विकल्प का इस्तेमाल किया गया है. नतीजों में, curl निर्देश के आउटपुट को वर्बोस मोड में दिखाया जाता है:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
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