檢查狀態

本頁面說明如何使用服務基礎架構檢查代管服務、服務供應商、服務用戶和 API 金鑰的狀態。

服務供應商為服務用戶提供服務時，必須確保符合多項先決條件，例如確認下列事項：

• 服務用戶是否已遭刪除。
• 服務用戶是否已啟用服務。
• API 金鑰是否有效。

Service Control API 可讓您透過簡單的 services.check 方法檢查這些先決條件。代管服務應定期呼叫此方法，藉此確保符合各項先決條件。Operation 代表服務供應商與服務用戶之間的活動。services.check 方法會對作業執行下列檢查：

• 服務生產端專案正在運作，並處於良好的健康狀態。
• 服務用戶專案正在運作，並處於良好的健康狀態。
• 服務用戶專案上已啟用代管服務。
• API 金鑰有效。
• API 金鑰的使用方式符合 API 金鑰的相關限制，例如 IP 或 HTTP 參照網址等限制。

services.check 方法通常是從實際實作服務的伺服器呼叫。基於安全性和隱私權考量，Service Control API 會使用 Identity and Access Management，確認呼叫端具備呼叫方法的適當權限。詳情請參閱「Service Control API Access Control」。

檢查狀態

推行代管服務後，您不用另外調整設定即可在該服務上呼叫 services.check 方法。詳情請參閱 services.check 參考資料。

如要快速試用這個方法，可以使用 gcurl 指令呼叫 services.check 方法。如需初始設定步驟，請參閱「開始使用 Service Control API」。

gcurl -d '{
  "operation": {
    "operationId": "123e4567-e89b-12d3-a456-426655440000",
    "consumerId": "project:endpointsapis-consumer",
    "startTime":"2016-07-31T05:20:00Z",
    "operationName":"google.example.hello.v1.HelloService.GetHello"
  }
}' https://servicecontrol.googleapis.com/v1/services/endpointsapis.appspot.com:check
{
  "operationId": "123e4567-e89b-12d3-a456-426655440000"
}

檢查方法的回應可顯示兩種結果：所有作業的檢查皆順利完成，或有部分作業檢查失敗。回覆中沒有 checkErrors 欄位就表示檢查成功，否則，checkErrors 欄位會列出失敗的檢查。