Mengelola peristiwa yang memengaruhi organisasi

Dokumen ini menjelaskan cara menggunakan Service Health API untuk mengelola peristiwa yang memengaruhi organisasi Anda.

Personalized Service Health menyediakan resource OrganizationEvents dan OrganizationImpacts API, yang memungkinkan Anda mendapatkan informasi tentang peristiwa yang memengaruhi organisasi Anda. Informasi ini mencakup:

  • Peristiwa kondisi layanan yang dapat memengaruhi satu atau beberapa project di organisasi.
  • Daftar project yang mungkin atau terkena dampak peristiwa yang memengaruhi organisasi Anda.

Resource API tidak mendapatkan semua peristiwa yang memengaruhi organisasi, atau membuatnya muncul di dasbor Service Health.

Sebelum memulai

  1. Aktifkan Service Health API untuk minimal satu project dalam organisasi Anda. Resource OrganizationEvents dan OrganizationImpacts API hanya mendapatkan informasi untuk project yang mengaktifkan Service Health API.
  2. Tetapkan izin untuk mengakses Service Health API.

  3. Konfigurasikan izin Identity and Access Management (IAM) di organisasi Anda untuk menggunakan resource OrganizationEvents dan OrganizationImpacts API. Jalankan perintah berikut: 

    gcloud organizations add-iam-policy-binding $ORGANIZATION_ID \
  --member {USER|GROUP|SERVICE_ACCOUNT} \
  --role roles/servicehealth.viewer

    Untuk mendapatkan ORGANIZATION_ID, lihat Mendapatkan ID resource organisasi.

    Kebijakan IAM yang diberikan pada organisasi diwarisi oleh semua project dalam organisasi. Kebijakan ini memungkinkan Anda mengakses API peristiwa organisasi dan project di seluruh organisasi.

Referensi

Lihat referensi API OrganizationEvents dan OrganizationImpacts untuk mengetahui metode yang dapat Anda gunakan, dan arti kolom dalam respons.

Saat menetapkan produk atau lokasi, gunakan nilai yang ditemukan di Google Cloud products dan locations.

Mencantumkan project dalam organisasi yang mungkin terpengaruh oleh peristiwa

Lihat panduan memulai.

Mencantumkan semua insiden aktif untuk organisasi

Lihat panduan memulai.

Mendapatkan detail untuk peristiwa yang memengaruhi organisasi

Anda dapat menggunakan Get API untuk melihat informasi mendetail tentang peristiwa yang memengaruhi organisasi.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

  • API_VERSION: Versi API yang akan digunakan. Gunakan v1 atau v1beta.
  • ORGANIZATION_ID: ID organisasi Google Cloud Anda.

Metode HTTP dan URL: 

GET https://servicehealth.googleapis.com/API VERSION/organizations/ORGANIZATION_ID/locations/global/organizationEvents/EVENT_ID

Untuk mengirim permintaan, perluas salah satu opsi berikut:

Anda akan melihat respons JSON seperti berikut:

{
  "name": "organizations/ORGANIZATION_ID/locations/global/organizationEvents/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",
      "eventImpacts": [
        {
          "product": {
            "productName": "Google Cloud SQL",
            "id": "hV87iK5DcEXKgWU2kDri",
          },
          "location": {
            "locationName": "us-central1",
          }
        }
      ],
   "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 tidak memiliki izin untuk mendapatkan peristiwa, Anda akan mendapatkan error PERMISSION_DENIED berikut.

{
  "error": {
    "code": 403,
    "message": "Permission 'servicehealth.organizationEvents.get' denied on resource '//servicehealth.googleapis.com/organizations/ORGANIZATION_ID/locations/global/organizationEvents/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": "organizations/ORGANIZATION_ID/locations/global/organizationEvents/EVENT_ID",
          "permission": "servicehealth.organizationEvents.get"
        }
      }
    ]
  }
}

Untuk memperbaiki error ini, tetapkan izin yang diperlukan.

Mendapatkan detail untuk project dalam organisasi yang mungkin terpengaruh oleh peristiwa

Untuk peristiwa tertentu, ID peristiwa tetap sama antara peristiwa project dan peristiwa organisasi Anda. OrganizationImpact berisi EVENT_ID dan PROJECT_NUMBER, yang dapat Anda gunakan untuk mendapatkan detail peristiwa yang memengaruhi project Anda. Detail ini mencakup state dan relevance.

PROJECT_NUMBER dapat dipertukarkan dengan PROJECT_ID, yang ditampilkan oleh Get API.