Trang này được dịch bởi Cloud Translation API.

Sử dụng tiện ích apigee-adminapi.sh

Edge for Private Cloud phiên bản 4.19.01

apigee-adminapi.sh gọi API quản lý Edge để thực hiện nhiều hoạt động bảo trì công việc.

Giới thiệu về apigee-adminapi.sh

Ưu điểm

Ưu điểm của tiện ích apigee-adminapi.sh là:

Sử dụng một giao diện dòng lệnh đơn giản
Triển khai hoàn tất lệnh dựa trên thẻ
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

So sánh với dịch vụ cung cấp apigee

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 tác vụ của mình.

Sự khác biệt chính giữa hai công cụ này là:

apigee-adminapi.sh thực hiện các hàm nguyên tử thay thế lệnh gọi API Edge riêng lẻ. Ví dụ: để tạo một tổ chức, môi trường và môi trường ảo máy chủ lưu trữ yêu cầu 3 lệnh apigee-adminapi.sh riêng biệt tương ứng với 3 Lệnh gọi API.
apigee-provision thực hiện một cấp độ cao hoàn toàn 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 có một lệnh apigee-provision duy nhất bằng cách truyền một 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.

Cài đặt apigee-adminapi.sh

Tiện ích apigee-adminapi.sh sẽ được cài đặt tự động khi bạn cài đặt apigee-provision hoặc tiện ích apigee-validate.

Tiện ích này được cài đặt ở vị trí sau:

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

Gọi apigee-adminapi.sh

Bạn gọi apigee-adminapi.sh từ nút Máy chủ quản lý. Khi gọi tiện ích, bạn phải hãy xác định các mục sau là biến môi trường hoặc tuỳ chọn dòng lệnh:

ADMIN_EMAIL (tương ứng với tuỳ chọn dòng lệnh admin)
ADMIN_PASSWORD (pwd)
EDGE_SERVER (host)

Ví dụ sau đây gọi apigee-adminapi.sh và chuyển các giá trị bắt buộc dưới dạng dòng lệnh tùy chọn:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh buildinfo list --admin user@example.com --pwd abcd1234 --host localhost

Ví dụ sau đây xác định các tuỳ chọn bắt buộc là biến môi trường tạm thời, sau đó gọi tiện ích 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

Nếu bạn không chuyển mật khẩu dưới dạng tuỳ chọn hoặc xác định mật khẩu là biến môi trường, apigee-adminapi.sh sẽ nhắc bạn nhập mã.

Đặt thông số apigee-adminapi.sh

Bạn phải nhập tất cả các tham số vào một lệnh bằng cách sử dụng các nút chuyển dòng lệnh hoặc sử dụng biến môi trường. Đặt tiền tố cho công tắc dòng lệnh bằng một dấu gạch ngang (-) hoặc dấu gạch ngang đôi (--) theo yêu cầu.

Ví dụ: bạn có thể chỉ định tên tổ chức bằng một trong hai cách sau:

Sử dụng nút chuyển dòng lệnh -o:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -o testOrg

Đặt một biến môi trường có tên là ORG:

export ORG=testOrg
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs

LƯU Ý: Bạn thường sử dụng các biến môi trường để đặt ADMIN_EMAIL và EDGE_SERVER, và không bắt buộc ADMIN_PASSWORD. Hầu hết các lệnh đều sử dụng những tham số này. Mối lo ngại về việc đặt các tham số khác (chẳng hạn như ORG) khi sử dụng các biến môi trường, nghĩa là chế độ cài đặt có thể chính xác cho một lệnh nhưng có thể không chính xác cho lệnh tiếp theo. Cho Ví dụ: nếu quên đặt lại biến môi trường, bạn có thể vô tình truyền sai giá trị cho lệnh tiếp theo.

Nếu bạn bỏ qua bất kỳ tham số bắt buộc nào vào lệnh, tiện ích này 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 tuỳ chọn --host (tương ứng với biến môi trường EDGE_SERVER), apigee-adminapi.sh sẽ phản hồi với lỗi sau:

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

Nếu bạn gặp lỗi HTTP STATUS CODE: 401 thì tức là bạn đã nhập sai mật khẩu.

Nhận trợ giúp về apigee-adminapi.sh

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ả lệnh có thể áp dụng, hãy gọi phần mềm tiện ích mà không có tuỳ chọn nào:

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

Nếu bạn nhấn phím tab sau khi nhập apigee-adminapi.sh, bạn sẽ thấy danh sách các tùy chọn:

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ập phím tab sau khi nhập:

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

Bạn sẽ thấy các tuỳ 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 nội dung 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ư minh hoạ dưới đây:

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

Tiện ích này hiển thị thông tin trợ giúp đầy đủ cho tất cả tuỳ chọn có thể có để Lệnh orgs. Mục đầu tiên trong dữ liệu đầu ra cho thấy sự 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

Chuyển một tệp vào apigee-adminapi.sh

Tiện ích apigee-adminapi.sh là một trình bao bọc xung quanh curl. Do đó, một số Các lệnh tương ứng với 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ủ ảo tương ứng với 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ột 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ể chuyển tất cả thông tin cần thiết về dòng lệnh như được hiển thị dưới đây:

/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

Ngoài ra, bạn có thể chuyển tệp có chứa thông tin giống như trong yêu cầu nội dung của POST. Ví dụ: lệnh sau đây lấy một tệp xác định máy chủ lưu trữ ảo:

/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

Nơi tệp vhostcreate chứa phần nội dung POST của lệnh gọi. Trong ví dụ sau đây là nội dung yêu cầu ở đị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

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 cả lệnh curl do tiện ích apigee-adminapi.sh tạo ra để thực hiện phép toán.

Ví dụ: lệnh sau đây sử dụng tuỳ chọn --debug. Kết quả hiển thị kết quả của lệnh curl cơ bản ở chế độ chi tiết:

/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