Edge for Private Cloud phiên bản 4.17.05
Sử dụng tiện ích apigee-adminapi.sh để thực hiện các nhiệm vụ cấu hình Edge giống như khi bạn thực hiện lệnh gọi đến API quản lý Edge. Ưu điểm của tiện ích apigee-adminapi.sh là:
- Sử dụng giao diện dòng lệnh đơn giản
- Triển khai tính năng hoàn thành lệnh bằng phím tab
- Cung cấp thông tin trợ giúp và thông tin về việc sử dụng
- Có thể hiển thị lệnh gọi API tương ứng nếu bạn quyết định dùng thử API
Tiện ích apigee-adminapi.sh không thay thế cho tiện ích apigee-provision. Tiện ích apigee-provision thực sự sử dụng tiện ích apigee-adminapi.sh để thực hiện các nhiệm vụ của mình.
Sau đây là những điểm khác biệt chính giữa hai loại:
- Tiện ích apigee-adminapi.sh thực hiện các hàm nguyên tử thay thế các lệnh gọi API Edge riêng lẻ. Ví dụ: để tạo một tổ chức, môi trường và máy chủ lưu trữ ảo, bạn cần có 3 lệnh apigee-adminapi.sh riêng biệt tương ứng với 3 lệnh gọi API.
- Tiện ích apigee-provision được thiết kế để thực hiện một thao tác hoàn chỉnh ở cấp cao trong một lệnh duy nhất. Ví dụ: bạn có thể tạo một tổ chức, môi trường và máy chủ ảo bằng một lệnh apigee-provision duy nhất bằng cách truyền tệp cấu hình có tất cả thông tin cần thiết.
Tài liệu về Edge sử dụng cả hai tiện ích khi thích hợp.
Đang cài đặt apigee-adminapi.sh
Tiện ích apigee-adminapi.sh sẽ tự động được cài đặt khi bạn cài đặt tiện ích apigee-provision hoặc apigee-validate.
Tiện ích này được cài đặt ở vị trí sau:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
Cú pháp apigee-adminapi.sh
Tiện ích apigee-adminapi.sh sử dụng cú pháp dòng lệnh đơn giản. Bất cứ lúc nào, hãy sử dụng phím tab để hiển thị lời nhắc liệt kê các tuỳ chọn lệnh có sẵn.
Để xem tất cả các lệnh có thể, hãy gọi tiện ích mà không có tuỳ chọn:
> apigee-adminapi.sh
Nếu nhấn phím tab sau khi nhập apigee-adminapi.sh, bạn sẽ thấy danh sách các tuỳ chọn có thể có:
analytics classification logsessions regions securityprofile userroles buildinfo GET orgs runtime servers users
Phím tab hiển thị các tuỳ chọn dựa trên ngữ cảnh của lệnh. Nếu bạn nhấn phím tab sau khi nhập:
> apigee-adminapi.sh orgs
Bạn sẽ thấy các lựa chọn có thể dùng để hoàn tất lệnh orgs:
add apis apps delete envs list pods userroles
Sử dụng tuỳ chọn -h để hiển thị thông tin trợ giúp cho bất kỳ lệnh nào. Ví dụ: nếu bạn sử dụng tuỳ chọn -h như dưới đây:
> apigee-adminapi.sh orgs -h
Tiện ích này hiển thị thông tin trợ giúp đầy đủ cho tất cả các tuỳ chọn có thể có đối với lệnh orgs. Mục đầu tiên trong kết quả cho thấy thông tin trợ giúp về lệnh "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
Thiết lập tham số bằng cách sử dụng các nút chuyển dòng lệnh và biến môi trường
Bạn phải nhập tất cả tham số vào một lệnh bằng cách sử dụng nút chuyển dòng lệnh hoặc sử dụng biến môi trường. Thêm tiền tố vào các nút chuyển dòng lệnh bằng một dấu gạch ngang (-) hoặc dấu gạch ngang kép (--) theo yêu cầu.
Ví dụ: từ nội dung trợ giúp hiển thị ở trên cho lệnh "orgs add", bạn có thể chỉ định tên tổ chức bằng cách:
- Sử dụng nút chuyển dòng lệnh -o:
> apigee-adminapi.sh orgs -o testOrg - Đặt biến môi trường có tên ORG:
> export ORG=testOrg
> apigee-adminapi.sh orgs
Nếu bạn bỏ qua bất kỳ tham số bắt buộc nào đối với lệnh, thì tiện ích sẽ hiển thị thông báo lỗi mô tả các tham số bị thiếu. Ví dụ: nếu bạn bỏ qua biến môi trường --host hoặc EDGE_SERVER chỉ định Máy chủ quản lý Edge khi tạo tổ chức, bạn sẽ thấy thông báo lỗi sau:
Error with required variable or parameter ADMIN_PASSWORD....OK ADMIN_EMAIL....OK EDGE_SERVER....null
Hai tham số phổ biến mà bạn thường đặt làm biến môi trường là địa chỉ email của quản trị viên hệ thống và địa chỉ IP của Máy chủ quản lý:
> export ADMIN_EMAIL=foo@bar.com > export EDGE_SERVER=192.168.56.101
Chuyển tệp vào tiện ích apigee-adminapi.sh
Một số lệnh tiện ích apigee-adminapi.sh tương ứng với các lệnh gọi API PUT và POST lấy nội dung yêu cầu. Ví dụ: việc tạo một máy chủ lưu trữ ảo tương ứng với một lệnh gọi API POST yêu cầu thông tin về máy chủ lưu trữ ảo trong nội dung yêu cầu.
Khi sử dụng tiện ích apigee-adminapi.sh để tạo máy chủ lưu trữ ảo hoặc bất kỳ lệnh nào lấy nội dung yêu cầu, bạn có thể truyền tất cả thông tin cần thiết trên dòng lệnh như dưới đây:
> 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
Hoặc bạn có thể truyền một tệp chứa thông tin giống như thông tin có trong nội dung yêu cầu của POST. Ví dụ: lệnh sau đây lấy một tệp xác định máy chủ ảo:
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate
trong đó tệp vhostcreate chứa nội dung POST của lệnh gọi. Trong ví dụ này, đây là nội dung yêu cầu có định dạng XML:
<VirtualHost name="myVHostUtil">
<HostAliases>
<HostAlias>192.168.56.101:9005</HostAlias>
</HostAliases>
<Interfaces/>
<Port>9005</Port>
</VirtualHost>Hiển thị thông tin gỡ lỗi và API
Sử dụng tuỳ chọn --debug cho tiện ích apigee-adminapi.sh để hiển thị thông tin chi tiết về lệnh. Thông tin này bao gồm lệnh cURL do tiện ích apigee-adminapi.sh tạo để thực hiện thao tác.
Ví dụ: lệnh này sử dụng tuỳ chọn --debug:
> apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
Và hiển thị kết quả sau, bao gồm cả lệnh cURL được tạo:
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