apigee-adminapi.sh 유틸리티 사용

Private Cloud용 Edge v4.19.01

apigee-adminapi.sh는 Edge 관리 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.com
export 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