Database Migration Service מספק ממשק API בארכיטקטורת REST לניהול פרופילי החיבור ומשימות ההעברה באופן פרוגרמטי. API בארכיטקטורת REST מוגדר על ידי משאבים שמשויכים ליצירה ולניהול של פרופילי חיבור ומשימות העברה. לפרטים על כל המשאבים והשיטות שלהם, קראו את מאמרי העזרה של ה-API של Database Migration Service.
כששולחים בקשות ישירות ל-API בארכיטקטורת REST של Database Migration Service, צריך ליצור את הבקשה בפורמט הנכון, לאשר את הבקשה כמשתמש מאומת ולעבד את התגובות שמוחזרות. בהרבה מהמשימות במסמכי התיעוד האלה יש דוגמאות ל-API באמצעות cURL.
דוגמאות נוספות לשימוש בממשקי ה-API מופיעות בדף הבקשה ב מאמרי העזרה של Database Migration Service API. בכל דף יש דוגמאות לקריאה ל-API בכמה שפות תכנות, וגם כלי Explorer ספציפי לבקשה, שעוזר לראות מה נכלל בבקשה תקינה ולמה לצפות בתגובה.
אתם משתמשים ב-Database Migration Service API גם באופן עקיף, כשאתם משתמשים באחת מהדרכים הבאות לניהול מכונות:
Google Cloud CLI: ממשק שורת פקודה (CLI) שמאפשר לעבוד עם המכונות.
מסוףGoogle Cloud : ממשק אינטרנט גרפי.
היתרון בשימוש בשיטות האלה, במיוחד במסוףGoogle Cloud , הוא שהן יכולות לפשט מאוד את ניהול פרופילי החיבור ומשימות ההעברה (בהתאם לתרחיש לדוגמה). אם אתם רק מתחילים להשתמש ב-Database Migration Service, מומלץ להתחיל עם אחד מהכלים האלה לפני שתעבדו ישירות עם ה-API בארכיטקטורת REST.
הפעלת ה-API
כדי להשתמש ב-Database Migration Service API, צריך להפעיל אותו:
המסוף
- מפעילים את Database Migration Service API.
- בוחרים את הפרויקט הרצוי.
- לוחצים על המשך.
gcloud
- מזינים את הפקודה הבאה כדי להציג את מזהי הפרויקטים שלכם ב- Google Cloud:
gcloud projects list
- מגדירים את פרויקט ברירת המחדל:
gcloud config set project YOUR_PROJECT_ID
- מפעילים את Cloud SQL Admin API:
gcloud services enable datamigration.googleapis.com
הרשאות
כדי להשתמש ב-Database Migration Service API, צריך את ההרשאות הנדרשות. ההרשאות האלה כוללות:
- אדמין של Database Migration: הרשאה שנותנת למשתמש גישה לכל המשאבים של Database Migration Service שמשמשים לניהול פרופילי קישור ומשימות העברה.
- צפייה בהעברת מסדי נתונים: הרשאה שנותנת למשתמש גישה לקריאה בלבד לפרופילי החיבור ולמשימות ההעברה ב-Database Migration Service.
- אדמין ב-Cloud SQL: עם ההרשאה הזו, המשתמש יכול ליצור ולנהל פרופילי חיבור ומשימות העברה ל-Cloud SQL ב-Database Migration Service.
ב-Google Cloud יש ממשק לניהול זהויות והרשאות גישה (IAM), שמאפשר לתת גישה פרטנית יותר למשאבים ספציפיים ב- Google Cloud ולמנוע גישה לא רצויה למשאבים אחרים. אתם יכולים לקבל ולהגדיר הרשאות ל-Database Migration Service באמצעות מסוף Google Cloud , ה-methods של IAM ב-API או Google Cloud CLI. מידע נוסף זמין במאמר הענקה, שינוי וביטול של גישה למשאבים.
הזנת נתוני JSON מקובץ
כשמשתמשים ב-API עם cURL, מספקים את ערכי המאפיינים באמצעות שורת הפקודה. אם אתם עובדים עם ערכים רגישים כמו סיסמאות או מפתחות אבטחה, הזנה שלהם בשורת הפקודה מהווה סיכון אבטחה. כדי לשפר את האבטחה, אתם יכולים ליצור קובץ שמכיל את נתוני ה-JSON לקריאה ל-API, ולספק את הנתיב לקובץ בשורת הפקודה.
כדי לספק נתוני JSON לקריאה ל-API ב-cURL מקובץ:
יוצרים קובץ שמכיל את כל מה שמופיע במירכאות בודדות בשדה
--data.צריך לכלול את הסוגריים המסולסלים, אבל לא את הגרשיים.
בשורת הפקודה, מציינים את הנתיב לקובץ, לפני התו
@, בתור הפרמטר--data:--data @<path-to-file>/<filename>
עבודה עם קריאות ל-API שנמשכות זמן רב
יכול להיות שיעבור קצת זמן עד שיושלמו קריאות מסוימות ל-API, כמו יצירת אובייקטים. מכיוון שה-API הוא אסינכרוני, הקריאה חוזרת מיד, גם אם הפעולה עדיין מתבצעת. אם בקריאה הבאה ל-API משתמשים באובייקט החדש שנוצר, צריך להמתין עד שהפעולה הראשונה תסתיים לפני שממשיכים.
אתם יכולים להשתמש ב-Database Migration Service API כדי לנהל פעולות. למשל:
Database Migration Service ו-Google APIs Discovery Service
Google APIs Discovery Service הוא שירות שמאפשר לגלות ממשקי Google API. לדוגמה, כשאתם משתמשים בכלי Google APIs Explorer, אתם משתמשים ב-Discovery Service.ב-Discovery Service, Database Migration Service מיוצג כ-"datamigration" (לדוגמה: https://datamigration.googleapis.com/$discovery/rest?version=v1).