Edge for Private Cloud เวอร์ชัน 4.16.05
ใช้ apigee-adminapi.sh เพื่อทำงานการกำหนดค่า Edge แบบเดียวกับที่คุณทำด้วยการเรียก Edge 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
ไวยากรณ์ 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 จะแสดงตัวเลือกตามบริบทของคำสั่ง หากคุณป้อนแป้น Tab หลังจากพิมพ์:
> apigee-adminapi.sh orgs
คุณจะเห็นตัวเลือกที่เป็นไปได้สำหรับการดำเนินการตามคำสั่ง orgs ให้เสร็จสมบูรณ์ ดังนี้
add apis apps delete envs list pods userroles
ใช้ตัวเลือก -h เพื่อแสดงตัวเลือก ความช่วยเหลือสำหรับคำสั่งใดก็ได้ เช่น หากคุณใช้ตัวเลือก -h ดังที่ปรากฏด้านล่าง
> apigee-adminapi.sh orgs -h
ยูทิลิตีจะแสดงข้อมูลความช่วยเหลือที่ครบถ้วนสำหรับตัวเลือกที่เป็นไปได้ทั้งหมดสำหรับคำสั่งของ orgs รายการแรกในเอาต์พุต แสดงความช่วยเหลือสำหรับ "องค์กรเพิ่ม" คำสั่ง:
+++++++++++++++++++++++++++++++++++++++++++ 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
เปลี่ยน:
apigee-adminapi.sh orgs -o testOrg - การตั้งค่าตัวแปรสภาพแวดล้อมชื่อ ORG:
ส่งออก ORG=testOrg
องค์กร apigee-adminapi.sh
หากไม่ระบุพารามิเตอร์ที่จําเป็นในคําสั่ง ยูทิลิตีจะแสดงข้อความแสดงข้อผิดพลาด ซึ่งอธิบายพารามิเตอร์ที่ขาดหายไป เช่น หากคุณไม่ใส่ตัวแปรสภาพแวดล้อม --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