此页面由 Cloud Translation API 翻译。

使用 apigee-adminapi.sh 实用程序

适用于私有云的 Edge v. 4.17.01

使用 apigee-adminapi.sh 实用程序，用于执行您通过调用 Edge 来执行相同的 Edge 配置任务。 Management API。apigee-adminapi.sh 实用程序的优势在于，：

使用简单的命令行界面
实现基于标签页的命令补全
提供帮助和使用情况信息
如果您决定试用该 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-adminapi.sh 实用程序当您安装 apigee-provision 或 apigee-validate 实用程序时，它就会自动安装。

该实用程序安装在以下位置：

/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
  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 组织 -o testOrg
设置名为 ORG 的环境变量：
>导出 ORG=testOrg
>apigee-adminapi.sh 组织

。

如果省略此命令的任何必需参数，则该实用程序会显示错误消息用于描述缺失的参数。例如，如果您省略 --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 信息

使用 --debug 选项 apigee-adminapi.sh 实用程序显示关于该命令的详细信息这些信息包括 apigee-adminapi.sh 实用程序生成的，以执行操作

例如，以下命令使用 --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