Dokumen ini menjelaskan petunjuk penggunaan Service Health API untuk mengelola peristiwa yang memengaruhi satu project.
Sebelum memulai
Pastikan penagihan diaktifkan untuk project Google Cloud Anda.
- Aktifkan Service Health API untuk project yang ingin Anda kelola peristiwanya.
- Tetapkan izin untuk mengakses Service Health API.
Referensi
Lihat referensi Events API (v1, v1beta)
untuk mengetahui metode yang dapat Anda gunakan dan arti kolom dalam respons.
Dalam respons API, setiap entri dalam daftar impact menyertakan gangguan
terperinci state (AFFECTED atau RESOLVED), startTime, dan endTime (saat
diselesaikan) untuk setiap produk dan lokasi yang terpengaruh.
Saat menetapkan produk atau lokasi, gunakan nilai yang ditemukan di Google Cloud produk dan lokasi.
Mencantumkan semua insiden aktif untuk sebuah project
Lihat panduan memulai.
Mendapatkan detail insiden
Anda dapat menggunakan Get API untuk melihat informasi mendetail tentang suatu peristiwa.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
- API_VERSION: Versi API yang akan digunakan. Gunakan
v1atauv1beta. - PROJECT_ID: Project ID Google Cloud Anda.
- EVENT_ID: ID acara.
Metode HTTP dan URL:
GET https://servicehealth.googleapis.com/API VERSION/projects/PROJECT_ID/locations/global/events/EVENT_ID
Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:
Anda akan melihat respons JSON seperti berikut:
{
"name": "projects/PROJECT_ID/locations/global/events/EVENT_ID",
"title": "We are experiencing a connectivity issue affecting Google Cloud SQL in us-east1, australia-southeast2.",
"description": "The issue with Google Cloud SQL has been resolved for all affected projects as of Tuesday, 2022-10-18 11:00 US/Pacific. We thank you for your patience while we worked on resolving the issue.",
"category": "INCIDENT",
"detailedCategory": "CONFIRMED_INCIDENT",
"state": "CLOSED",
"detailedState": "RESOLVED",
"artifacts": [
{
"artifact": "projects/PROJECT_ID/locations/global/artifacts/artifact_id",
"artifactCategory": "ARTIFACT_CATEGORY_INCIDENT_REPORT",
}
],
"eventImpacts": [
{
"product": {
"productName": "Google Cloud SQL",
"id": "hV87iK5DcEXKgWU2kDri",
},
"location": {
"locationName": "us-central1",
}
}
],
"relevance": "RELATED",
"updates": [
{
"updateTime": "2022-10-18T17:41:20.112287Z",
"title": "We are experiencing a connectivity issue affecting Google Cloud SQL in us-east1, australia-southeast2.",
"description": "We are experiencing an intermittent issue with Google Cloud SQL. Our engineering team continues to investigate the issue.",
"symptom": "None at this time.",
"workaround": "None at this time."
},
{
"updateTime": "2022-10-18T18:00:05.690761Z",
"title": "We are experiencing a connectivity issue affecting Google Cloud SQL in us-east1, australia-southeast2.",
"description": "The issue with Google Cloud SQL has been resolved for all affected projects as of Tuesday, 2022-10-18 11:00 US/Pacific.\n\nWe thank you for your patience while we worked on resolving the issue.",
"symptom": "None at this time.",
"workaround": "None at this time."
}
],
"updateTime": "2022-10-18T18:00:05.690761Z",
"startTime": "2022-10-18T17:41:20.112287Z",
"endTime": "2022-10-18T18:00:05.690761Z",
}
Jika Anda tidak memiliki
izin untuk mendapatkan peristiwa,
Anda akan mendapatkan error PERMISSION_DENIED berikut.
{
"error": {
"code": 403,
"message": "Permission 'servicehealth.events.get' denied on resource '//servicehealth.googleapis.com/projects/PROJECT_ID/locations/global/events/EVENT_ID' (or it may not exist).",
"status": "PERMISSION_DENIED",
"details": [
{
"@type": "type.googleapis.com/google.rpc.ErrorInfo",
"reason": "IAM_PERMISSION_DENIED",
"domain": "servicehealth.googleapis.com",
"metadata": {
"resource": "projects/PROJECT_ID/locations/global/events/EVENT_ID",
"permission": "servicehealth.events.get"
}
}
]
}
}
Untuk memperbaiki error ini, tetapkan izin yang diperlukan.
Mencantumkan resource yang terpengaruh dalam project
Untuk produk Google Cloud yang didukung, Anda dapat mencantumkan resource Google Cloud tertentu dalam project Anda yang terpengaruh oleh peristiwa Personalized Service Health.
Untuk mencantumkan resource yang terpengaruh, Service Health API
(servicehealth.googleapis.com) harus diaktifkan di project setidaknya 24
jam sebelum peristiwa dimulai, dan akun utama Anda harus memiliki
izin servicehealth.impacts.list (disertakan dalam
roles/servicehealth.viewer).
REST API (v1beta)
Untuk mencantumkan resource yang terpengaruh dalam project, kirim permintaan ke Service Health API dengan parameter berikut:
| Parameter | Nilai | Deskripsi |
|---|---|---|
parent |
projects/PROJECT_ID/locations/global |
Wajib. Project ID atau nomor project tempat Anda ingin mencantumkan resource yang terpengaruh. |
pageSize |
1 sampai 100 | Opsional. Jumlah maksimum dampak yang akan ditampilkan per halaman. Jika tidak ditentukan, setelan defaultnya adalah 10. |
pageToken |
string | Opsional. Token dari ListImpactsResponse sebelumnya untuk mengambil halaman hasil berikutnya. |
filter |
string | Opsional. Ekspresi filter untuk mencakup dampak yang ditampilkan. Misalnya, untuk mencantumkan resource yang terpengaruh oleh peristiwa tertentu, tetapkan filter=events:projects/PROJECT_ID/locations/global/events/EVENT_ID. |
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
PROJECT_ID: Project ID atau nomor project Google Cloud Anda.
Metode HTTP dan URL:
GET https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/impacts
Untuk menggunakan curl, panggil endpoint GET secara langsung:
curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ "https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/impacts"
gcloud
Jalankan perintah berikut untuk mencantumkan resource yang terpengaruh dalam project:
gcloud beta service-health impacts list \
--project=PROJECT_ID \
--location=global
Untuk mencantumkan hanya resource yang terpengaruh oleh peristiwa tertentu, teruskan flag --filter:
gcloud beta service-health impacts list \
--project=PROJECT_ID \
--location=global \
--filter="events:projects/PROJECT_ID/locations/global/events/EVENT_ID"
Jika permintaan berhasil, isi respons akan berisi daftar objek Impact yang mirip dengan berikut ini:
{
"impacts": [
{
"name": "projects/my-project/locations/global/impacts/f9a8b7c6-d5e4-4f3a-9b2c-1d0e9f8a7b6c",
"events": [
"projects/my-project/locations/global/events/1234567890abcdef"
],
"asset": {
"assetName": "//cloudsql.googleapis.com/projects/9876543210/instances/prod-orders-db",
"assetType": "sqladmin.googleapis.com/Instance"
},
"description": "Instance experienced elevated connection errors during regional network disruption.",
"createTime": "2026-10-08T14:12:05.120450Z",
"updateTime": "2026-10-08T14:12:05.120450Z"
}
]
}
Contoh filter umum untuk resource yang terpengaruh
Anda dapat meneruskan parameter kueri filter (atau --filter di Google Cloud CLI) untuk mempersempit data Impact yang ditampilkan:
- Mencantumkan resource yang terpengaruh untuk peristiwa tertentu:
filter=events:projects/PROJECT_ID/locations/global/events/EVENT_ID - Mencantumkan resource yang terpengaruh dari jenis resource tertentu (misalnya, instance Cloud SQL):
filter=asset.assetType="sqladmin.googleapis.com/Instance" - Mencantumkan resource yang terpengaruh yang diperbarui setelah stempel waktu tertentu:
filter=updateTime>"2026-10-08T00:00:00Z"
Mendapatkan detail tentang resource yang terpengaruh
Anda dapat mengambil data Impact tertentu menggunakan IMPACT_ID-nya.
REST API (v1beta)
Untuk mendapatkan detail tentang data resource tertentu yang terpengaruh, kirim permintaan dengan parameter berikut:
| Parameter | Nilai | Deskripsi |
|---|---|---|
name |
projects/PROJECT_ID/locations/global/impacts/IMPACT_ID |
Wajib. Nama resource lengkap data Impact yang akan diambil. |
Metode HTTP dan URL:
GET https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/impacts/IMPACT_ID
curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ "https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/impacts/IMPACT_ID"
gcloud
Jalankan perintah berikut untuk mendapatkan detail tentang data resource yang terpengaruh:
gcloud beta service-health impacts describe IMPACT_ID \
--project=PROJECT_ID \
--location=global
Jika permintaan berhasil, isi respons akan berisi objek Impact:
{
"name": "projects/my-project/locations/global/impacts/f9a8b7c6-d5e4-4f3a-9b2c-1d0e9f8a7b6c",
"events": [
"projects/my-project/locations/global/events/1234567890abcdef"
],
"asset": {
"assetName": "//cloudsql.googleapis.com/projects/9876543210/instances/prod-orders-db",
"assetType": "sqladmin.googleapis.com/Instance"
},
"description": "Instance experienced elevated connection errors during regional network disruption.",
"createTime": "2026-10-08T14:12:05.120450Z",
"updateTime": "2026-10-08T14:12:05.120450Z"
}