การใช้ยูทิลิตี apigee-adminapi.sh

The 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

ใช้แป้น Tab เพื่อแสดงข้อความแจ้งที่แสดงตัวเลือกคำสั่งที่มีได้ทุกเมื่อ

หากต้องการดูคำสั่งที่เป็นไปได้ทั้งหมด ให้เรียกใช้ยูทิลิตีโดยไม่มีตัวเลือก

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

หากคุณกดแป้น Tab หลังจากพิมพ์ apigee-adminapi.sh คุณจะเห็นรายการตัวเลือกที่เป็นไปได้ ดังนี้

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 เป็น Wrapper ของ curl ดังนั้น คำสั่งบางรายการจึงสอดคล้องกับการเรียก API PUT และ POST ที่ใช้เนื้อหาคำขอ เช่น การสร้างโฮสต์เสมือนสอดคล้องกับการเรียก API 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 ของการเรียก ใน ตัวอย่างนี้ เนื้อหาคำขอเป็นรูปแบบ XML

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

แสดงข้อมูลการแก้ไขข้อบกพร่องและข้อมูล API

ใช้ตัวเลือก --debug ของยูทิลิตี apigee-adminapi.sh เพื่อแสดง ข้อมูลโดยละเอียดเกี่ยวกับคำสั่ง ข้อมูลนี้รวมถึงคำสั่ง curl ที่สร้างโดยยูทิลิตี apigee-adminapi.sh เพื่อดำเนินการ

ตัวอย่างเช่น คำสั่งต่อไปนี้ใช้ตัวเลือก --debug ผลลัพธ์ จะแสดงเอาต์พุตของคำสั่ง curl พื้นฐานในโหมด Verbose

/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