שימוש ב-Database Migration Service API

‫MySQL   |  PostgreSQL   |  PostgreSQL ל-AlloyDB

סקירה כללית

Database Migration Service מספק API בארכיטקטורת REST לניהול פרופילי החיבור ועבודות המיגרציה באופן פרוגרמטי. API בארכיטקטורת REST מוגדר על ידי משאבים שמשויכים ליצירה ולניהול של פרופילי חיבור ועבודות העברה. פרטים על כל המשאבים והשיטות שלהם זמינים במאמר Database Migration Service API Reference.

כששולחים בקשות ישירות אל Database Migration Service API בארכיטקטורת REST, צריך ליצור את הבקשה בפורמט הנכון, לאשר את הבקשה כמשתמש מאומת ולעבד את התשובות שמתקבלות. במסמכי התיעוד האלה יש דוגמאות רבות ל-API באמצעות cURL.

דוגמאות נוספות לשימוש בממשקי ה-API זמינות בדף הבקשה בהפניית API של Database Migration Service. בכל דף יש דוגמאות לקריאה ל-API בכמה שפות תכנות, וגם כלי Explorer ספציפי לבקשה שיעזור לכם להבין מה נדרש כדי ליצור בקשה תקינה ומה צפוי בתגובה.

אתם משתמשים ב-Database Migration Service API גם באופן עקיף, כשאתם משתמשים באחת מהדרכים הבאות לניהול מופעים:

• ‫Google Cloud CLI: ממשק שורת פקודה (CLI) שבעזרתו אפשר לעבוד עם המקרים שלכם.

• ‫Google Cloud console: ממשק אינטרנט גרפי.

היתרון בשימוש בשיטות האלה, במיוחד בGoogle Cloud מסוף, הוא שהן יכולות לפשט מאוד את הניהול של פרופילי החיבור ומשימות ההעברה (בהתאם לתרחיש השימוש). אם אתם רק מתחילים להשתמש ב-Database Migration Service, מומלץ להתחיל עם אחד מהכלים האלה לפני שתתחילו לעבוד ישירות עם API בארכיטקטורת REST.

הפעלת ה-API

כדי להשתמש ב-Database Migration Service API, צריך להפעיל אותו:

המסוף

1. מפעילים את Database Migration Service API.
2. בוחרים את הפרויקט הרצוי.
3. לוחצים על המשך.

gcloud

1. מזינים את הפקודה הבאה כדי להציג את מזהי הפרויקטים של Google Cloudהפרויקטים שלכם:

   gcloud projects list

2. מגדירים את פרויקט ברירת המחדל:

   gcloud config set project YOUR_PROJECT_ID

3. מפעילים את Cloud SQL Admin API:

   gcloud services enable datamigration.googleapis.com

הרשאות

כדי להשתמש ב-Database Migration Service API, צריכות להיות לכם ההרשאות הנדרשות. ההרשאות האלה כוללות:

• אדמין של Database Migration Service: עם ההרשאה הזו, המשתמש מקבל גישה לכל המשאבים של Database Migration Service שמשמשים לניהול פרופילי חיבור ועבודות העברה.
• Database Migration Viewer: עם ההרשאה הזו, למשתמש יש גישת קריאה בלבד לפרופילי חיבור ולמשימות העברה ב-Database Migration Service.
• אדמין Cloud SQL: עם ההרשאה הזו, משתמש יכול ליצור ולנהל פרופילים של חיבורים ועבודות העברה ל-Cloud SQL ב-Database Migration Service.

‫Google Cloud כולל את הפתרון 'ניהול זהויות והרשאות גישה (IAM)', שמאפשר לתת גישה פרטנית יותר למשאבים ספציפיים ב-Google Cloud ולמנוע גישה לא רצויה למשאבים אחרים. אפשר לקבל ולהגדיר הרשאות ל-Database Migration Service באמצעות Google Cloud console, השיטות של ה-API של IAM או Google Cloud CLI. מידע נוסף זמין במאמר הענקה, שינוי וביטול גישה למשאבים.

דוגמאות ל-API

דוגמאות לשימוש ב-Database Migration Service API עם cURL זמינות במאמרים ניהול פרופילי חיבור באמצעות API וניהול משימות העברה באמצעות API.

העברת נתוני JSON מקובץ

כשמשתמשים ב-API עם cURL, צריך לספק ערכי מאפיינים באמצעות שורת הפקודה. אם אתם עובדים עם ערכים רגישים כמו סיסמאות או מפתחות אבטחה, מסירתם בשורת הפקודה מהווה סיכון אבטחתי. כדי לשפר את האבטחה, אתם יכולים ליצור קובץ שמכיל את נתוני ה-JSON לקריאה ל-API, ולציין את הנתיב לקובץ בשורת הפקודה.

כדי לספק נתוני JSON לקריאה ל-API של cURL מקובץ:

1. יוצרים קובץ שמכיל את כל מה שמוקף במירכאות בודדות בשדה --data.

   צריך לכלול את הסוגריים המסולסלים, אבל לא את המירכאות הבודדות.

2. בשורת הפקודה, מציינים את הנתיב לקובץ, עם התו @ לפניו, כפרמטר --data:

   --data @<path-to-file>/<filename>

   לדוגמה, כדי ליצור פרופיל חיבור למסד נתונים של מקור Cloud SQL, אפשר ליצור קובץ בשם request.json עם התוכן הבא:

   {
     "displayName": "my Cloud SQL connection profile",
     "mysql": {
       "host": "10.11.12.13",
       "port": 3306,
       "username": "myusername",
       "password": "mypassword"
     }
   }
   

   אחר כך, משתמשים בפקודת ה-cURL הבאה בשורת הפקודה:

   curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
        --header 'Content-Type: application/json' \
        --data @./request.json \
        -X POST \
        https://datamigration.googleapis.com/v1/projects/myProject/locations/myLocation/connectionProfiles?connectionProfileId=myCloudSQLconnectionprofile

עבודה עם קריאות ל-API שפועלות לאורך זמן

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

אתם יכולים להשתמש ב-Database Migration Service API כדי לנהל פעולות. למשל:

• הצגת פרטים על פעולה
• פעולות של כרטיסי מוצר באזור מסוים
• מחיקת פעולה

‫Database Migration Service ו-Google APIs Discovery Service

‫Google APIs Discovery Service הוא שירות שמאפשר לכם לגלות Google APIs. לדוגמה, כשמשתמשים בכלי Google APIs Explorer , משתמשים ב-Discovery Service.

ב-Discovery Service, ‏ Database Migration Service מיוצג כ-datamigration (לדוגמה: https://datamigration.googleapis.com/$discovery/rest?version=v1).