本節說明如何使用 Apigee API 檢查 API Proxy 的部署狀態。
- 按照「建立及部署新的 API Proxy」一文的說明,部署測試 API Proxy。
- 找出含有 Apigee 機構管理員服務帳戶金鑰的 JSON 檔案。 這個服務帳戶和金鑰是在「啟用同步處理工具存取權」中建立。
- 執行下列兩個指令,取得符記:
export GOOGLE_APPLICATION_CREDENTIALS=org-admin-service-account-file
export TOKEN=$(gcloud auth application-default print-access-token)
其中 org-admin-service-account-file 是系統中服務帳戶金鑰的路徑,您可以使用 Apigee 機構管理員角色下載該金鑰。
- 呼叫修訂版本 API,並使用下列部分:
- 基準網址:
https://apigee.googleapis.com/v1
- 端點網址:
/organizations/my-organization/environments/test/apis/myproxy/revisions/1/deployments
- 通訊協定:
HTTPS
- 方法:
GET
- 標頭:
"Authorization: Bearer $TOKEN"
以下範例使用
curl
呼叫部署修訂版本 API,並使用下列設定:curl "https://apigee.googleapis.com/v1/organizations/my-organization/environments/test/apis/myproxy/revisions/1/deployments" \ -X GET -H "Authorization: Bearer $TOKEN"
您應該會收到類似以下的回應:
{ "deployments": [ { "environment": "test", "apiProxy": "myproxy", "revision": "1", "deployStartTime": "1560782439002", "pods": [ { "podName": "apigee-runtime-my-organization-test-blue-56b642fv429v", "appVersion": "self", "deploymentStatusTime": "1560787671389", "deploymentStatus": "deployed", "statusCode": "200", "statusCodeDetails": "Deployment Success", "deploymentTime": "1560782471370", "podStatus": "active", "podStatusTime": "1560787671389" }, { "podName": "apigee-runtime-my-organization-test-blue-564422f7dmwj", "appVersion": "self", "deploymentStatusTime": "1560787670121", "deploymentStatus": "deployed", "statusCode": "200", "statusCodeDetails": "Deployment Success", "deploymentTime": "1560782485204", "podStatus": "active", "podStatusTime": "1560787670121" } ], "basePath": "/" } ] }
這個範例回應顯示 API 代理程式在 2 個 Pod 上的狀態。兩個 Pod 的部署狀態均為
deployed
。您的回應可能會顯示 API 代理程式在較少或較多 Pod 上的部署狀態,具體取決於叢集的設定。
如果您收到空白回應或錯誤訊息,請檢查以下事項:
- 您使用了正確的基本網址。請注意,混合型基本網址與 Edge API 的基本網址不同。使用
https://apigee.googleapis.com/v1
。 - 您使用了正確的端點網址。請注意,修訂版本為「1」,端點為
/organizations/my_organization/environments/test/apis/myproxy/revisions/1/deployments
。如果指定的修訂版本不存在,要求會傳回空白回應,如下所示:{ }
- 您具備存取要求中指定機構的權限。
- 您的權杖尚未過期。如果已過期,請按照「取得 OAuth 2.0 存取權杖」一節所述,重新產生新的權杖。
- 您將
"Authorization: Bearer $TOKEN"
標頭包在引號中。
- 基準網址: