Edge สำหรับ Private Cloud เวอร์ชัน 4.18.05
ใช้ยูทิลิตี 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-validate
ระบบจะติดตั้งเครื่องมือในตำแหน่งต่อไปนี้
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
ไวยากรณ์ /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
ยูทิลิตี 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 หลังจากที่พิมพ์ ให้ทำดังนี้
/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
การตั้งค่าพารามิเตอร์โดยใช้สวิตช์บรรทัดคำสั่งและตัวแปรสภาพแวดล้อม
คุณต้องป้อนพารามิเตอร์ทั้งหมดลงในคำสั่งโดยใช้การเปลี่ยนบรรทัดคำสั่งหรือโดยใช้ตัวแปรสภาพแวดล้อม ใส่เครื่องหมายขีดคั่นเดี่ยว (-) หรือเครื่องหมายขีดคู่ (--) ไว้ด้านหน้าสวิตช์บรรทัดคำสั่ง
เช่น จากรายการช่วยเหลือที่แสดงด้านบนสำหรับคำสั่ง "เพิ่มองค์กร" คุณจะระบุชื่อองค์กรได้โดยใช้วิธีใดวิธีหนึ่งต่อไปนี้
- การใช้สวิตช์บรรทัดคำสั่ง
-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
ที่ระบุ 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
เพื่อสร้างโฮสต์เสมือนหรือคำสั่งใดๆ ที่มีเนื้อหาของคำขอ คุณจะส่งข้อมูลที่จำเป็นทั้งหมดในบรรทัดคำสั่งได้ดังที่แสดงด้านล่าง
/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
/opt/apigee/apigee-adminapi/bin/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