apigee-adminapi.sh
会调用 Edge Management API 来执行多项维护
任务。
apigee-adminapi.sh 简介
调用 apigee-adminapi.sh
从管理服务器节点调用 apigee-adminapi.sh
。调用该实用程序时,您必须
将以下内容定义为环境变量或命令行选项:
ADMIN_EMAIL
(对应于admin
命令行选项)ADMIN_PASSWORD
(pwd
)EDGE_SERVER
(host
)
以下示例调用 apigee-adminapi.sh
并将所需的值作为命令行传递
选项:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh buildinfo list --admin user@example.com --pwd abcd1234 --host localhost
以下示例将所需选项定义为临时环境变量,然后
调用 apigee-adminapi.sh
实用程序:
export ADMIN_EMAIL=user@example.comexport ADMIN_PASSWORD=abcd1234
export EDGE_SERVER=192.168.56.101
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh servers list
如果您不将密码作为选项传递或将其定义为环境变量,
apigee-adminapi.sh
会提示您输入。
设置 apigee-adminapi.sh 参数
您必须使用命令行开关或使用 环境变量在命令行开关前面加上一个短划线 (-) 或双短划线作为前缀 (--)。
例如,您可以通过以下方式指定组织名称:
- 使用
-o
命令行开关:/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -o testOrg
- 设置名为
ORG
的环境变量:export ORG=testOrg
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs
如果省略此命令的任何必需参数,则该实用程序会显示错误消息
用于描述缺失的参数。例如,如果您省略 --host
选项,
(对应于 EDGE_SERVER
环境变量),apigee-adminapi.sh
会做出响应
并显示以下错误:
Error with required variable or parameter ADMIN_PASSWORD....OK ADMIN_EMAIL....OK EDGE_SERVER....null
如果您收到 HTTP STATUS CODE: 401
错误,则表示您输入的内容有误
密码。
获取 apigee-adminapi.sh 帮助
使用 Tab 键可随时显示提示,其中会列出可用命令选项。
要查看所有可能的命令,请在不使用选项的情况下调用实用程序:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
如果您在输入 apigee-adminapi.sh 后按 Tab 键,则会看到 选项:
analytics classification logsessions regions securityprofile userroles buildinfo GET orgs runtime servers users
Tab 键可根据命令的上下文显示选项。如果您输入 Tab 键, 之后:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs
您将看到完成 orgs
命令的可能选项:
add apis apps delete envs list pods userroles
使用 -h
选项可显示任何命令的帮助信息。例如,如果您使用
-h
选项,如下所示:
/opt/apigee/apigee-adminapi/bin/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
将文件传递给 apigee-adminapi.sh
apigee-adminapi.sh
实用程序是 curl
的封装容器。因此,一些
命令对应于接受请求正文的 PUT
和 POST
API 调用。
例如,创建虚拟主机对应于 POST
API 调用,该调用需要
有关虚拟主机的信息。
使用 apigee-adminapi.sh
实用程序执行以下操作时:
创建虚拟主机或任何接受请求正文的命令,您就可以将所有
如下所示:
/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
或者,您可以传递一个文件,其中包含与 请求中包含的相同信息 POST 正文。例如,以下命令接受定义虚拟主机的文件:
/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
其中,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
选项以显示
以及关于该命令的详细信息这些信息包括 curl
命令
apigee-adminapi.sh
实用程序生成的代码,以执行操作。
例如,以下命令使用 --debug
选项。取得的成效
以详细模式显示底层 curl
命令的输出:
/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