במאמר הזה מוסבר איך להציג, לעדכן ולמחוק דומיינים ותתי-דומיינים של נתונים באמצעות מסוף Google Cloud ו-API בארכיטקטורת REST.
לפני שמתחילים
לפני שמנהלים דומיינים של נתונים, צריך לוודא שיש לכם את התפקידים הנדרשים ושהפעלתם את ממשקי ה-API.
הפעלת ממשקי ה-API
מפעילים את Dataplex API.
תפקידים שנדרשים להפעלת ממשקי API
כדי להפעיל ממשקי API, נדרשת ההרשאה serviceusage.services.enable. אם יצרתם את הפרויקט, סביר להניח שכבר יש לכם את ההרשאה הזו דרך התפקיד 'בעלים' (roles/owner). אחרת, תוכלו לקבל את ההרשאה הזו דרך התפקיד 'אדמין של Service Usage' (roles/serviceusage.serviceUsageAdmin). כך מקצים תפקידים.
התפקידים הנדרשים
כדי לקבל את ההרשאות שדרושות לניהול דומיינים של נתונים, צריך לבקש מהאדמין להקצות לכם את תפקידי ה-IAM הבאים בפרויקט:
-
עדכון של דומיינים של נתונים וקישורי משאבים:
Dataplex Data Domain Configuration Editor (
roles/dataplex.dataDomainEditor) -
צפייה בהגדרה של תחום הנתונים והקישורים:
Dataplex Data Domain Configuration Viewer (
roles/dataplex.dataDomainViewer)
להסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.
יכול להיות שאפשר לקבל את ההרשאות הנדרשות גם באמצעות תפקידים בהתאמה אישית או תפקידים מוגדרים מראש.
צפייה בנתונים של דומיינים ותת-דומיינים
הצגת דומיינים ותת-דומיינים של נתונים בפרויקט ספציפי.
המסוף
צפייה בכל דומייני הנתונים
נכנסים לדף Data domains במסוף Google Cloud .
בטבלה מפורטים הדומיינים שנוצרו. לוחצים על החץ הרחבה לצד שם דומיין הנתונים כדי לראות את תתי-הדומיינים המקוננים.
הצגת פרטים של דומיין נתונים ותת-דומיין
נכנסים לדף Data domains במסוף Google Cloud .
לוחצים על השם של הדומיין או תת-הדומיין שרוצים להציג.
בדף פרטי הדומיין מוצגות הכרטיסיות הבאות:
- סקירה כללית: סקירה כללית של הדומיין ורשימה של ההיבטים הנדרשים והאופציונליים.
- משאבים: רשימת המשאבים שכלולים בדומיין. ברשימה מוצגים רק תיקיות, פרויקטים ומשאבים שנכללים ישירות בדומיין.
REST
הצגת דומיינים ותת-דומיינים של נתונים
כדי להציג דומיינים של נתונים, משתמשים בשיטה projects.locations.dataDomains.list:
לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:
-
PROJECT_ID: מזהה הפרויקט ב- Google Cloud . -
LOCATION_ID: האזור של הפרויקט. לדוגמה,us-central1.
שיטת ה-HTTP וכתובת ה-URL:
GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains
כדי לשלוח את הבקשה צריך להרחיב אחת מהאפשרויות הבאות:
אמורים לקבל קוד סטטוס של הצלחה (2xx) ותגובה ריקה.
צפייה בתתי-דומיינים של נתונים
כדי להציג תת-דומיינים של נתונים, משתמשים בשיטה projects.locations.dataDomains.listSubdomains:
לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:
-
PROJECT_ID: מזהה הפרויקט ב- Google Cloud . -
LOCATION_ID: האזור שבו קיים דומיין הנתונים הראשי. לדוגמה,us-central1. -
DOMAIN_ID: המזהה הייחודי של תחום הנתונים הראשי.
ה-method של ה-HTTP וכתובת ה-URL:
GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID/subdomains
כדי לשלוח את הבקשה צריך להרחיב אחת מהאפשרויות הבאות:
אמורים לקבל קוד סטטוס של הצלחה (2xx) ותגובה ריקה.
משתמשים בפרמטר filter כדי להציג רשימה של תת-דומיינים ששייכים לדומיין הורה ספציפי:
לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:
-
PROJECT_ID: מזהה הפרויקט ב- Google Cloud . -
LOCATION_ID: האזור שבו קיים דומיין הנתונים הראשי. לדוגמה,us-central1. -
PARENT_DOMAIN_ID: המזהה הייחודי של תחום הנתונים הראשי.
ה-method של ה-HTTP וכתובת ה-URL:
GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains?filter=parent_data_domain="projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/PARENT_DOMAIN_ID"
כדי לשלוח את הבקשה צריך להרחיב אחת מהאפשרויות הבאות:
אמורים לקבל קוד סטטוס של הצלחה (2xx) ותגובה ריקה.
צפייה בפרטים של דומיין נתונים
כדי לקבל פרטים על דומיין או תת-דומיין, משתמשים בשיטה projects.locations.dataDomains.get:
לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:
-
PROJECT_ID: מזהה הפרויקט ב- Google Cloud . -
LOCATION_ID: האזור שבו קיים דומיין הנתונים. לדוגמה,us-central1. -
DOMAIN_ID: המזהה הייחודי של דומיין הנתונים או של תת-הדומיין.
ה-method של ה-HTTP וכתובת ה-URL:
GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID
כדי לשלוח את הבקשה צריך להרחיב אחת מהאפשרויות הבאות:
אמורים לקבל קוד סטטוס של הצלחה (2xx) ותגובה ריקה.
עדכון של דומיין או תת-דומיין של נתונים
אתם יכולים לעדכן את השם המוצג, התיאור והתוויות של דומיין. אחרי שיוצרים את הדומיין, אי אפשר לשנות את מזהה הדומיין או את המיקום.
המסוף
נכנסים לדף Data domains במסוף Google Cloud .
לוחצים על שם הדומיין או תת-הדומיין כדי לעבור לדף הפרטים.
בסרגל העליון, לוחצים על עריכה.
מעדכנים את השם המוצג או את התיאור.
לוחצים על Save.
REST
כדי לעדכן דומיין נתונים, משתמשים בשיטה projects.locations.dataDomains.patch:
לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:
-
PROJECT_ID: מזהה הפרויקט ב- Google Cloud . -
LOCATION_ID: האזור שבו קיים דומיין הנתונים. לדוגמה,us-central1. -
DOMAIN_ID: המזהה הייחודי של דומיין הנתונים או של תת-הדומיין.
ה-method של ה-HTTP וכתובת ה-URL:
PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID?updateMask=description,labels
תוכן בקשת JSON:
{
"description": "Updated description for the domain",
"labels": {
"status": "active"
}
}
כדי לשלוח את הבקשה צריך להרחיב אחת מהאפשרויות הבאות:
אמורים לקבל קוד סטטוס של הצלחה (2xx) ותגובה ריקה.
מחיקה של דומיין או תת-דומיין
אפשר למחוק רק דומיין נתונים ריק. לפני שמנסים למחוק את הדומיין עצמו, צריך למחוק את כל תתי-הדומיין ולהסיר את כל הקישורים למשאבים שמשויכים לדומיין. אם הדומיין לא ריק, בקשת המחיקה תיכשל ותוצג שגיאה.
המסוף
נכנסים לדף Data domains במסוף Google Cloud .
לוחצים על שם הדומיין או תת-הדומיין כדי לעבור לדף הפרטים.
בסרגל העליון, לוחצים על מחיקה.
כדי לאשר את המחיקה, מקלידים את שם הדומיין או תת-הדומיין של הנתונים.
לוחצים על Delete.
REST
כדי למחוק דומיין נתונים, משתמשים בשיטה projects.locations.dataDomains.delete:
לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:
-
PROJECT_ID: מזהה הפרויקט ב- Google Cloud . -
LOCATION_ID: האזור שבו קיים דומיין הנתונים. לדוגמה,us-central1. -
DOMAIN_ID: המזהה הייחודי של דומיין הנתונים או של תת-הדומיין.
ה-method של ה-HTTP וכתובת ה-URL:
DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/dataDomains/DOMAIN_ID
כדי לשלוח את הבקשה צריך להרחיב אחת מהאפשרויות הבאות:
אמורים לקבל קוד סטטוס של הצלחה (2xx) ותגובה ריקה.