Memeriksa Status

Halaman ini menjelaskan cara menggunakan Service Infrastructure untuk memeriksa status pada layanan terkelola, produsen layanan, konsumen layanan, dan kunci API.

Saat produsen layanan menawarkan layanan kepada konsumen layanannya, produsen layanan harus memastikan bahwa berbagai prasyarat terpenuhi, seperti apakah:

  • Konsumen layanan telah dihapus.
  • Konsumen layanan telah mengaktifkan layanan.
  • Kunci API valid.

Service Control API menyediakan metode services.check sederhana untuk memeriksa prasyarat tersebut. Layanan terkelola harus memanggil metode ini secara rutin untuk memastikan prasyarat terpenuhi. Aktivitas antara produsen layanan dan konsumen layanan diwakili oleh Operation. Metode services.check melakukan pemeriksaan berikut pada operasi:

  • Project produsen layanan sudah aktif dan dalam kondisi baik.
  • Project konsumen layanan aktif dan dalam status responsif.
  • Layanan terkelola diaktifkan di project konsumen layanan.
  • Kunci API valid.
  • Penggunaan kunci API memenuhi batasan yang terkait dengan kunci API, seperti pembatasan perujuk IP atau HTTP.

Metode services.check biasanya dipanggil dari server yang benar-benar menerapkan layanan. Untuk tujuan keamanan dan privasi, Service Control API menggunakan Identity and Access Management untuk memverifikasi pemanggil memiliki izin yang sesuai untuk memanggil metode. Untuk mengetahui detailnya, lihat Kontrol Akses Service Control API.

Memeriksa status

Setelah meluncurkan layanan terkelola, Anda dapat memanggil metode services.check di layanan tanpa konfigurasi tambahan. Lihat referensi services.check untuk mengetahui detailnya.

Untuk bereksperimen dengan metode ini dengan cepat, Anda dapat menggunakan perintah gcurl untuk memanggil metode services.check. Lihat Mulai Menggunakan Service Control API untuk mengetahui langkah-langkah penyiapan awal.

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"
}

Respons dari metode pemeriksaan menunjukkan apakah semua pemeriksaan berhasil atau beberapa pemeriksaan gagal. Keberhasilan ditunjukkan dengan tidak adanya kolom checkErrors. Jika tidak, kolom checkErrors akan mencantumkan pemeriksaan yang gagal.