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

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

כדי לכתוב קוד שמשתמש ב-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

כדי להציג רשימה של שירותים שמופעלים בארגון או בתיקייה, קוראים לשיטה 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 ושירותים) עם רשימה של ממשקי ה-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. במסוף Google Cloud , נכנסים לדף API Library.

    לדף 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 כחלק מהבקשה.

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