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

Edge for Private Cloud v4.19.01

कई रखरखाव के लिए, apigee-adminapi.sh, Edge management API का इस्तेमाल करता है टास्क.

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 के लिए सहायता पाएं

किसी भी समय टैब बटन का इस्तेमाल करके, ऐसा प्रॉम्प्ट दिखाएं जिसमें उपलब्ध निर्देशों की सूची दी गई हो.

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

/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

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

/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