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

Edge สำหรับ Private Cloud เวอร์ชัน 4.17.01

ใช้ยูทิลิตี apigee-adminapi.sh สำหรับงานการกำหนดค่า Edge เดียวกันกับที่ดำเนินการด้วยการเรียกใช้ Edge Management API ข้อดีของยูทิลิตี apigee-adminapi.sh คือ

  • ใช้อินเทอร์เฟซบรรทัดคำสั่งง่ายๆ
  • ใช้งานการดำเนินการตามคำสั่งแบบแท็บ
  • ให้ความช่วยเหลือและข้อมูลการใช้งาน
  • แสดงการเรียก API ที่เกี่ยวข้องได้หากคุณเลือกที่จะลองใช้ API

ยูทิลิตี apigee-adminapi.sh ไม่ได้เป็นการแทนที่ยูทิลิตี apigee-provision ยูทิลิตี apigee-provision จะใช้ยูทิลิตี apigee-adminapi.sh จริงๆ เพื่อทำงาน

ความแตกต่างสำคัญระหว่างข้อมูลทั้ง 2 ประเภท ได้แก่

  • ยูทิลิตี apigee-adminapi.sh จะทํางานแบบอะตอมแทนการเรียก Edge API แต่ละรายการ ตัวอย่างเช่น หากต้องการสร้างองค์กร สภาพแวดล้อม และโฮสต์เสมือน จะต้องใช้คำสั่ง apigee-adminapi.sh 3 คำสั่งแยกกันตามการเรียก API จำนวน 3 รายการ
  • ยูทิลิตี apigee-provision ออกแบบมาเพื่อดำเนินการระดับสูงโดยสมบูรณ์ด้วยคำสั่งเดียว ตัวอย่างเช่น คุณสร้างองค์กร สภาพแวดล้อม และโฮสต์เสมือนด้วยคำสั่ง apigee-provision รายการเดียวได้โดยการส่งไฟล์การกำหนดค่าที่มีข้อมูลที่จำเป็นทั้งหมด

เอกสาร Edge จะใช้ยูทิลิตีทั้ง 2 รายการตามความเหมาะสม

กำลังติดตั้ง apigee-adminapi.sh

ระบบจะติดตั้งยูทิลิตี apigee-adminapi.sh โดยอัตโนมัติเมื่อคุณติดตั้ง apigee-provision หรือยูทิลิตี apigee-ตรวจสอบ

ระบบจะติดตั้งเครื่องมือในตำแหน่งต่อไปนี้

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

ไวยากรณ์ apigee-adminapi.sh

ยูทิลิตี apigee-adminapi.sh ใช้ไวยากรณ์บรรทัดคำสั่งแบบง่าย ให้ใช้ปุ่ม Tab เพื่อแสดงพรอมต์ที่แสดงตัวเลือกคำสั่งที่ใช้ได้ได้ทุกเมื่อ

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

> apigee-adminapi.sh 

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

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

แป้นแท็บจะแสดงตัวเลือกตามบริบทของคำสั่ง หากคุณป้อนปุ่ม Tab หลังจากที่พิมพ์ ให้ทำดังนี้

> apigee-adminapi.sh orgs

คุณจะเห็นตัวเลือกที่เป็นไปได้ในการเรียกใช้คำสั่ง orgs ต่อไปนี้

add  apis  apps  delete  envs  list  pods  userroles

ใช้ตัวเลือก -h เพื่อแสดงความช่วยเหลือสำหรับคำสั่งใดก็ได้ ตัวอย่างเช่น หากคุณใช้ตัวเลือก -h ดังที่แสดงด้านล่าง

> 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

การตั้งค่าพารามิเตอร์โดยใช้สวิตช์บรรทัดคำสั่งและตัวแปรสภาพแวดล้อม

คุณต้องป้อนพารามิเตอร์ทั้งหมดลงในคำสั่งโดยใช้การเปลี่ยนบรรทัดคำสั่งหรือโดยใช้ตัวแปรสภาพแวดล้อม ใส่เครื่องหมายขีดคั่นเดี่ยว (-) หรือเครื่องหมายขีดคู่ (--) ไว้ด้านหน้าสวิตช์บรรทัดคำสั่ง

เช่น จากรายการช่วยเหลือที่แสดงด้านบนสำหรับคำสั่ง "เพิ่มองค์กร" คุณจะระบุชื่อองค์กรได้โดยใช้วิธีใดวิธีหนึ่งต่อไปนี้

  • การใช้บรรทัดคำสั่ง -o Switch:
    > apigee-adminapi.sh orgs -o testOrg
  • การตั้งค่าตัวแปรสภาพแวดล้อมชื่อ ORG:
    > ส่งออก ORG=testOrg
    > apigee-adminapi.sh orgs

ถ้าคุณละเว้นพารามิเตอร์ที่จำเป็นในคำสั่ง ยูทิลิตีจะแสดงข้อความแสดงข้อผิดพลาดที่อธิบายพารามิเตอร์ที่ขาดหายไป ตัวอย่างเช่น หากคุณไม่ใส่ตัวแปรสภาพแวดล้อม --host หรือ EDGE_SERVER ที่ระบุ Edge Management Server เมื่อสร้างองค์กร คุณจะเห็นข้อความแสดงข้อผิดพลาดต่อไปนี้

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

พารามิเตอร์ทั่วไป 2 ตัวที่คุณมักตั้งค่าเป็นตัวแปรสภาพแวดล้อม ได้แก่ อีเมลของผู้ดูแลระบบและที่อยู่ IP ของเซิร์ฟเวอร์การจัดการ

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

การส่งไฟล์ไปยังยูทิลิตี apigee-adminapi.sh

คำสั่งยูทิลิตี apigee-adminapi.sh บางคำสั่งจะสอดคล้องกับการเรียก PUT และ POST API ที่รับเนื้อหาของคำขอ เช่น การสร้างโฮสต์เสมือนจะสอดคล้องกับการเรียก POST API ที่ต้องใช้ข้อมูลเกี่ยวกับโฮสต์เสมือนในเนื้อหาคำขอ

เมื่อใช้ยูทิลิตี apigee-adminapi.sh เพื่อสร้างโฮสต์เสมือนหรือคำสั่งที่ใช้เนื้อหาของคำขอ คุณจะส่งผ่านข้อมูลที่จำเป็นทั้งหมดในบรรทัดคำสั่งได้ ดังที่แสดงด้านล่าง

> 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 ก็ได้ ตัวอย่างเช่น คำสั่งต่อไปนี้จะใช้ไฟล์ที่กำหนดโฮสต์เสมือน

> 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

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

และแสดงเอาต์พุตต่อไปนี้ รวมถึงคำสั่ง cURL ที่สร้างขึ้น:

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