适用于私有云的 Edge v. 4.17.05
使用 apigee-adminapi.sh 实用程序可以执行与通过调用 Edge 管理 API 执行的 Edge 配置任务相同的任务。apigee-adminapi.sh 实用程序的优势在于：
- 使用简单的命令行界面
- 实现基于 Tab 键的命令补全
- 提供帮助和使用信息
- 如果您决定试用该 API，可以显示相应的 API 调用
apigee-adminapi.sh 实用程序不能替代 apigee-provision 实用程序。apigee-provision 实用程序实际上使用 apigee-adminapi.sh 实用程序来执行其任务。
这两种方法的主要区别如下：
- apigee-adminapi.sh 实用程序会执行替代单个 Edge API 调用的原子函数。例如，若要创建组织、环境和虚拟主机，需要三个单独的 apigee-adminapi.sh 命令，分别对应于三个 API 调用。
- apigee-provision 实用程序旨在通过单个命令执行完整的高级操作。例如，您可以通过传递包含所有必要信息的配置文件，使用单个 apigee-provision 命令创建组织、环境和虚拟主机。
Edge 文档会在适当情况下使用这两种实用程序。
安装 apigee-adminapi.sh
安装 apigee-provision 或 apigee-validate 实用程序时，系统会自动安装 apigee-adminapi.sh 实用程序。
此实用程序的安装位置如下：
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
apigee-adminapi.sh 语法
apigee-adminapi.sh 实用程序使用简单的命令行语法。您可以随时使用 Tab 键显示一个提示，其中列出了可用的命令选项。
如需查看所有可能的命令，请不带任何选项调用该实用程序：
> apigee-adminapi.sh
如果您在输入 apigee-adminapi.sh 后按 Tab 键，则会看到可能的选项列表：
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” 命令的帮助信息：
+++++++++++++++++++++++++++++++++++++++++++
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
使用命令行开关和环境变量设置参数
您必须使用命令行开关或环境变量输入命令的所有参数。根据需要，在命令行开关前面加上单短划线 (-) 或双短划线 (--)。
例如，在上面显示的“orgs add”命令的帮助中，您可以通过以下任一方式指定组织名称：
- 使用 -o 命令行开关：
> apigee-adminapi.sh orgs -o testOrg - 设置名为 ORG 的环境变量：
> export ORG=testOrg
> apigee-adminapi.sh orgs
如果您省略了命令的任何必需参数，该实用程序会显示一条错误消息，说明缺少的参数。例如，如果您在创建组织时省略了指定 Edge 管理服务器的 --host 或 EDGE_SERVER 环境变量，则会看到以下错误消息：
Error with required variable or parameter ADMIN_PASSWORD....OK ADMIN_EMAIL....OK EDGE_SERVER....null
您通常将两个常见参数设置为环境变量，即系统管理员电子邮件地址和管理服务器的 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 信息
使用 apigee-adminapi.sh 实用程序的 --debug 选项可显示有关该命令的详细信息。这些信息包括 apigee-adminapi.sh 实用程序生成的用于执行操作的 c网址 命令。
例如，以下命令使用 --debug 选项：
> apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
并显示以下输出，其中包括生成的 c网址 命令：
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