גישה לאירועים בארגון באמצעות Personalized Service Health API

במרכז האישי שלכם ב-Service Health יש משאבי API של OrganizationEvents ו-OrganizationImpacts, שמאפשרים לכם לקבל מידע על אירועים שמשפיעים על הארגון שלכם. המידע כולל:

• אירועים ב-Service Health שעשויים להשפיע על פרויקט אחד או יותר בארגון.
• רשימת הפרויקטים שעשויים להיות מושפעים מאירוע שמשפיע על הארגון שלכם, או שמושפעים ממנו בפועל.

במאמר איך צופים באירועים ברמת הארגון במסוף Google Cloud מוסבר איך לראות אירועים ברמת הארגון במסוף Google Cloud .

לפני שמתחילים

1. מפעילים את Service Health API לפחות בפרויקט אחד בארגון. משאבי ה-API‏ OrganizationEvents ו-OrganizationImpacts מקבלים מידע רק על פרויקטים שבהם מופעל Service Health API.

2. מוודאים שהחיוב מופעל בפרויקט Google Cloud .

3. מגדירים הרשאות גישה ל-API של Service Health.

4. הגדרת הרשאות לניהול זהויות והרשאות גישה (IAM) בארגון כדי להשתמש במשאבי ה-API‏ OrganizationEvents ו-OrganizationImpacts. מריצים את הפקודה הבאה:

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

   כדי לקבל את ORGANIZATION_ID, אפשר לעיין במאמר קבלת מזהה משאב הארגון.

   כל הפרויקטים בארגון יורשים את מדיניות ה-IAM שמוענקת לארגון. המדיניות הזו מאפשרת לכם לגשת לממשקי API של אירועים ברמת הארגון והפרויקט בכל הארגון.

קובצי עזר

בOrganizationEvents ובOrganizationImpacts API מפורטות השיטות שבהן אפשר להשתמש, ומוסבר מה המשמעות של השדות בתגובה.

כשמגדירים את המוצר או המיקום, צריך להשתמש בערכים שנמצאים בGoogle Cloud products ובlocations.

הצגת רשימה של פרויקטים בארגון שעשויים להיות מושפעים מאירוע

מדריך למתחילים

הצגת רשימה של כל האירועים הפעילים בארגון

מדריך למתחילים

קבלת פרטים על אירוע שמשפיע על ארגון

אתם יכולים להשתמש ב-Get API כדי לראות פרטים על אירוע שמשפיע על ארגון.

לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:

• ‫API_VERSION: גרסת ה-API שבה ייעשה שימוש. אפשר להשתמש ב-v1 או ב-v1beta.
• ‫ORGANIZATION_ID: מזהה הארגון ב-Google Cloud.
• ‫EVENT_ID: מזהה האירוע.

ה-method של ה-HTTP וכתובת ה-URL:

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

כדי לשלוח את הבקשה צריך להרחיב אחת מהאפשרויות הבאות:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://servicehealth.googleapis.com/API VERSION/organizations/ORGANIZATION_ID/locations/global/organizationEvents/EVENT_ID"

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://servicehealth.googleapis.com/API VERSION/organizations/ORGANIZATION_ID/locations/global/organizationEvents/EVENT_ID" | Select-Object -Expand Content

אתם אמורים לקבל תגובת JSON שדומה לזו:

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

אם אין לכם הרשאות לקבל אירועים, תוצג לכם השגיאה PERMISSION_DENIED הבאה.

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

כדי לפתור את השגיאה, צריך להגדיר את ההרשאות הנדרשות.

קבלת פרטים על פרויקט בארגון שעשוי להיות מושפע מאירוע

באירוע נתון, מזהה האירוע נשאר זהה בין האירועים בפרויקט לבין האירועים בארגון. ‫OrganizationImpact מכיל EVENT_ID ו-PROJECT_NUMBER, שבעזרתם אפשר לקבל פרטים על אירוע שמשפיע על הפרויקט. הפרטים האלה כוללים את state ואת relevance.

‫PROJECT_NUMBER הוא תחליף ל-PROJECT_ID, שמוחזר על ידי Get API.