צפייה בממשקי API של API Gateway ב-API Hub
בדף הזה מוסבר איך לראות את ממשקי ה-API של API Gateway ב-API Hub באמצעות מסוף Google Cloud או API. מידע נוסף מופיע במאמר רשימת משאבי API.
אפשר לראות את ממשקי ה-API של API Gateway ב-API Hub כמו שמתואר בהמשך.
מסוףGoogle Cloud
כדי לראות את ממשקי ה-API של API Gateway ב-API Hub:
- במסוף Google Cloud , עוברים לדף APIs ב-API hub.
- בתפריט הנפתח Filter (סינון), בוחרים באפשרות Gateway: API Gateway (שער: API Gateway) כדי להציג את כל ממשקי ה-API של API Gateway.
נפתח הדף הראשי של קטלוג ה-API עם כל ממשקי ה-API הזמינים.
- לוחצים על API כדי לראות פרטים נוספים.
בטבלה הבאה מתוארים השדות במרכז ה-API והשדות המקבילים ב-API Gateway. מידע על מאפיינים אחרים של המערכת ועל מאפיינים שהוגדרו על ידי המשתמש זמין גם במאמר ניהול מאפיינים במרכז ה-API.
| שדה ב-API hub | שדה API Gateway | תיאור | |
|---|---|---|---|
| סקירה כללית> שם | פרטים> שם | שם ה-API. | |
| סקירה כללית> מזהה API | לא רלוונטי | המזהה של ה-API במרכז ה-API. | |
| סקירה כללית> שינוי אחרון | פרטים> עודכן | חותמת זמן של מועד השינוי האחרון ב-API. | |
| גרסאות> שם | הגדרות> מזהה ההגדרה | המזהה של הגדרת ה-API. | |
| גרסאות> מזהה גרסה | לא רלוונטי | המזהה של גרסת הגדרת ה-API במרכז ה-API. | |
| גרסאות> תאריך השינוי האחרון | הגדרות> עודכנו | חותמת זמן של מועד השינוי האחרון בהגדרת ה-API. | |
| גרסאות> פעולות | paths בקובץ המפרט של OpenAPI |
פעולות שמוגדרות בקובץ המפרט. פרטי API Gateway שנקלטים
כוללים:
|
|
| גרסאות> קובץ מפרט | הגדרות> מיקום מלא של המשאב | קובץ המפרט שמשויך להגדרת ה-API. הפרטים של API Gateway שנקלטים
כוללים:
|
|
| פריסות> שם הפריסה | שערים> מזהה השער | פריסת API Gateway בפורמט הבא:
LOCATION/GATEWAY_ID |
|
| פריסות> סוג הפריסה | לא רלוונטי | סוג הפריסה. ההגדרה היא API Gateway. | |
| פריסות> שינוי אחרון | שערי תשלום> עודכן | חותמת זמן של מועד השינוי האחרון בשער ה-API. | |
| Deployments> Resources URI | שערים> שם מלא של משאב | מזהה ה-URI של המשאבים ב-API Gateway בפורמט הבא:
projects/RUNTIME_PROJECT_ID/locations/LOCATION/gateways/GATEWAY_ID |
|
| פריסות> כתובת URL לניהול | שערים> שער | כתובת ה-URL שמשמשת לניהול הפריסה של API Gateway בפורמט הבא:
https://console.cloud.google.com/api-gateway/gateway/GATEWAY_ID/location/LOCATION?project=RUNTIME_PROJECT_ID |
|
| פריסות> פרויקט המקור | שערים> שם מלא של משאב | פרויקט המקור של הפריסה. | |
| פריסות> נקודות קצה | שערים> כתובת ה-URL של השער | כתובת ה-IP שבה משאב הפריסה מאזין לבקשות API. | |
| תובנות | הערה: בשלב הזה, מידע על תובנות לא זמין לממשקי API של API Gateway. | ||
| אבטחה | הערה: בשלב הזה, מידע על אבטחה לא זמין לממשקי API של API Gateway. | ||
REST
כדי להציג רשימה של כל ממשקי ה-API של API Gateway ב-API Hub, משתמשים בממשק ה-API List APIs. אם מוסיפים את המסנן של מופע הפלאגין, אפשר להציג רק את נכסי ה-API של מופע הפלאגין שצוין ב-API Gateway.
לדוגמה:
curl 'https://apihub.googleapis.com/v1/projects/HUB_PROJECT_ID/locations/HUB_LOCATION/apis?filter=source_metadata.plugin_instance_action_source.plugin_instance="projects/HUB_PROJECT_ID/locations/HUB_LOCATION/plugins/PLUGIN_TYPE/instances/PLUGIN_INSTANCE_ID"' \ -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)"
מחליפים את מה שכתוב בשדות הבאים:
- HUB_PROJECT_ID: השם של פרויקט המארח של מרכז ה-API. פרויקט המארח נבחר כש-API Hub הוקצה.
- HUB_LOCATION: המיקום של פרויקט המארח. המיקום נבחר כשסופקה רכזת API.
- PLUGIN_TYPE: סוג הפלאגין. מגדירים את הערך system-api-gateway.
- PLUGIN_INSTANCE_ID: המזהה של מופע הפלאגין של API Gateway. משתמשים ב-API של list plugin instances כדי לקבל את מזהה מופע הפלאגין.
בהמשך מופיעה דוגמה לתגובה.
{
"apis": [
{
"name": "projects/myproject/locations/us-west1/apis/4fc95784-16b0-4b6e-8b7f-a08607febf78",
"displayName": "test-api-1",
"versions": [
"projects/myproject/locations/us-west1/apis/4fc95784-16b0-4b6e-8b7f-a08607febf78/versions/843a7e72-c5d2-4af8-95b0-162fa5d5ea10",
"projects/myproject/locations/us-west1/apis/4fc95784-16b0-4b6e-8b7f-a08607febf78/versions/b6af2674-4a0e-410e-990d-d90ccbe6867e"
],
"createTime": "2025-12-12T18:55:54.445487Z",
"updateTime": "2025-12-12T18:55:54.445487Z",
"apiStyle": {
"attribute": "projects/myproject/locations/us-west1/attributes/system-api-style",
"enumValues": {
"values": [
{
"id": "rest",
"displayName": "REST",
"description": "REST",
"immutable": true
}
]
}
},
"fingerprint": "test-api-1",
"sourceMetadata": [
{
"pluginInstanceActionSource": {
"pluginInstance": "projects/myproject/locations/us-west1/plugins/system-api-gateway/instances/90b21a65-38b4-4159-8e9d-07a8b6cecab0",
"actionId": "sync-metadata"
},
"sourceType": "PLUGIN",
"originalResourceId": "projects/runtimeproject/locations/global/apis/test-api-1",
"originalResourceCreateTime": "2025-12-11T01:57:54.841944920Z",
"originalResourceUpdateTime": "0001-01-01T00:00:00Z"
}
]
}
]
}בטבלה הבאה מתוארים השדות שמאוכלסים במטא-נתונים של API מ-API Gateway בתגובה. מידע על מאפיינים אחרים של המערכת ועל מאפיינים שהוגדרו על ידי המשתמש זמין גם במאמר ניהול מאפיינים במרכז ה-API.
| שדה API | תיאור |
|---|---|
name |
המזהה של ה-API ב-API Hub בפורמט הבא: projects/HUB_PROJECT_ID/locations/HUB_LOCATION/apis/API_ID
הערה: נעשה שימוש ב-API_ID בשם המשאב כדי לוודא שהערך ייחודי. |
displayName |
השם המוצג של ה-API. |
createTime |
חותמת הזמן שבה נוצר ה-API. |
updateTime |
חותמת הזמן שבה נוצר ה-API. |
fingerprint |
מזהה ייחודי ל-API (בדרך כלל מוגדר כשם לתצוגה). |
sourceMetadata |
פרטי מופע של פלאגין API Gateway, כולל:
|