הצגת רשימת השירותים

במאמר הזה מוסבר איך להציג את רשימת ממשקי ה-API והשירותים שמופעלים או זמינים בפרויקט, בתיקייה או בארגון ב- Google Cloud .

כדי לכתוב קוד שמשתמש ב-Service Usage API, אפשר גם להשתמש באחת מספריות הלקוח של Service Usage.

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

כדי להציג את רשימת ממשקי ה-API והשירותים שזמינים ומופעלים, צריך:

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

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

gcloud

כדי להציג את רשימת ממשקי ה-API והשירותים שמופעלים בארגון או בתיקייה, משתמשים בפקודה gcloud beta services list:

gcloud beta services list RESOURCE_TYPE=RESOURCE_ID

מחליפים את מה שכתוב בשדות הבאים:

  • ‫RESOURCE_TYPE: משתמשים ב---organization או ב---folder כדי להציג את רשימת השירותים הפעילים של ארגון או תיקייה, בהתאמה.

  • ‫RESOURCE_ID: מזהה הארגון או התיקייה שרוצים להציג את רשימת השירותים הפעילים שלהם.

‫API בארכיטקטורת REST

כדי להציג את רשימת השירותים הפעילים בארגון או בתיקייה, מפעילים את ה-method‏ consumerPolicies.get:

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" "https://serviceusage.googleapis.com/v2beta/RESOURCE_TYPE/RESOURCE_ID/consumerPolicies/default?filter=state:ENABLED"

מחליפים את מה שכתוב בשדות הבאים:

  • ‫RESOURCE_TYPE: משתמשים ב-organizations או ב-folders כדי להציג את רשימת השירותים הפעילים של ארגון או תיקייה, בהתאמה.

  • ‫RESOURCE_ID: מזהה הארגון או התיקייה שרוצים להציג את רשימת השירותים הפעילים שלהם.

אם הפעולה מצליחה, גוף התשובה מכיל את ConsumerPolicy, שכולל רשימה של ממשקי ה-API שמופעלים:

{
  "name": "organizations/organization-name/consumerPolicies/default",
  ...
  "enableRules": [
    {
    "services": [
      "services/apphub.googleapis.com",
      "services/appoptimize.googleapis.com",
      "services/artifactregistry.googleapis.com",
      ...
      ]
    }
  ]
}

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

כדי לראות את רשימת השירותים הפעילים בפרויקט:

המסוף

כדי להציג את רשימת ממשקי ה-API והשירותים שמופעלים בפרויקט:

  1. במסוף Google Cloud , נכנסים לדף APIs & Services.

    כניסה אל APIs & Services

  2. בוחרים את הפרויקט Google Cloud באחת מהדרכים הבאות:

    • בוחרים פרויקט מהרשימה של הפרויקטים האחרונים.

    • לוחצים על Select project, מאתרים את הפרויקט ולוחצים על השם שלו.

    נפתח הדף APIs & Services, שבו מופיעה רשימה של ממשקי ה-API שמופעלים בפרויקט ב-Google Cloud .

gcloud

כדי להציג את רשימת ממשקי ה-API והשירותים שמופעלים בפרויקט הנוכחי, משתמשים בפקודה gcloud services list:

gcloud services list

הפלט אמור להיראות כך:

NAME: analyticshub.googleapis.com
TITLE: Analytics Hub API

NAME: appoptimize.googleapis.com
TITLE: App Optimize API

NAME: artifactregistry.googleapis.com
TITLE: Artifact Registry API

NAME: bigquery.googleapis.com
TITLE: BigQuery API
...

‫API בארכיטקטורת REST

כדי להציג את רשימת השירותים הפעילים בפרויקט, מפעילים את ה-method‏ services.list עם המסנן state:ENABLED:

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" "https://serviceusage.googleapis.com/v1/projects/PROJECT_ID/services?filter=state:ENABLED"

מחליפים את PROJECT_ID במספר או במזהה הפרויקט ב- Google Cloud .

הצגת רשימה של השירותים שזמינים בפרויקט

כדי לראות את רשימת השירותים הזמינים בפרויקט: קבוצת השירותים הזמינים משתנה לעיתים רחוקות, ואפשר לשמור אותה במטמון לפרקי זמן ארוכים.

המסוף

כדי לראות את רשימת ממשקי ה-API והשירותים שזמינים לכם בפרויקט:

  1. נכנסים לדף API Library במסוף Google Cloud .

    לדף API Library

  2. בוחרים את הפרויקט Google Cloud באחת מהדרכים הבאות:

    • בוחרים פרויקט מהרשימה של הפרויקטים האחרונים.

    • לוחצים על Select project, מאתרים את הפרויקט ולוחצים על השם שלו.

    הדף API Library ייפתח. אתם יכולים לחפש ממשקי API זמינים או לעיין בהם.

gcloud

כדי להציג את ממשקי ה-API והשירותים שזמינים בפרויקט הנוכחי, משתמשים בפקודה gcloud services list עם הדגל --available:

gcloud services list --available

התוצאות כוללות את כל השירותים שכבר הופעלו, וגם את השירותים שאפשר להפעיל בפרויקט הנוכחי. הפלט אמור להיראות כך:

NAME: places-backend.googleapis.com
TITLE: Google Places API Web Service

NAME: clouderrorreporting.googleapis.com
TITLE: Stackdriver Error Reporting API

NAME: analyticsreporting.googleapis.com
TITLE: Google Analytics Reporting API

NAME: youtube.googleapis.com
TITLE: YouTube Data API v3
...

‫API בארכיטקטורת REST

כדי להציג את רשימת השירותים שזמינים לפרויקט, צריך להפעיל את ה-method‏ services.list:

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" "https://serviceusage.googleapis.com/v1/projects/PROJECT_ID/services"

מחליפים את PROJECT_ID במספר או במזהה הפרויקט ב- Google Cloud .

התוצאה כוללת את כל השירותים הציבוריים, את כל השירותים שלמשתמש ששלח את הקריאה יש את ההרשאה servicemanagement.services.bind עבורם, ואת כל השירותים שכבר הופעלו בפרויקט.

כדי לסנן את התוצאות כך שלא יכללו את השירותים שמופעלים בפרויקט, אפשר לכלול את פרמטר השאילתה ?filter=state:DISABLED כחלק מהבקשה.

המאמרים הבאים