דרישות מוקדמות

במאמר הזה מוסברות הדרישות המוקדמות לשימוש ב-Compute Engine API.

לפני שתתחילו לתכנת את אפליקציית הלקוח הראשונה, כדאי לעשות כמה פעולות – אם עדיין לא עשיתם אותן.

יצירת חשבון Google

כדי לגשת אל Compute Engine API, צריך חשבון Google. אם יש לכם חשבון קיים, כבר יש לכם גישה.

יכול להיות שתרצו גם חשבון Google נפרד למטרות בדיקה.

הרשמה והתנסות ב-Compute Engine

כדי להתחיל, אתם יכולים ליצור מכונת VM ב-Compute Engine באמצעות אחד מהמדריכים הבאים:

• יצירת מכונה וירטואלית של Linux
• יצירת מכונה וירטואלית של Windows

לפני שממשיכים, חשוב להכיר את Compute Engine. מאמרי העזרה של ה-API מבוססים על ההנחה שכבר השתמשתם ב-Compute Engine ושאתם מכירים את המושגים של תכנות לאינטרנט ואת פורמטים של נתונים באינטרנט.

מידע על אימות

יש כמה דרכים לבצע אימות ב-Compute Engine, בהתאם לאופן הגישה ל-API. מידע נוסף זמין במאמר בנושא אימות ל-Compute Engine.

מידע על REST

יש שתי דרכים להפעיל את ה-API:

• לשלוח בקשות HTTP ולנתח את התגובות.
• שימוש בספריות לקוח.

אם תחליטו לא להשתמש בספריות לקוח, תצטרכו להכיר את העקרונות הבסיסיים של REST.

העקרונות הבסיסיים של REST

‫REST הוא סגנון של ארכיטקטורת תוכנה שמציע תפיסה נוחה ועקבית לבקשת נתונים ולשינוי שלהם.

המונח REST הוא קיצור של Representational State Transfer. בהקשר של Google APIs,‏ REST מתייחס לשימוש בפעלים של HTTP כדי לאחזר ולשנות ייצוגים של נתונים ש-Google מאחסנת.

במערכת RESTful, המשאבים מאוחסנים במאגר נתונים. לקוח שולח בקשה לשרת לבצע פעולה מסוימת (כמו יצירה, אחזור, עדכון או מחיקה של משאב), והשרת מבצע את הפעולה ושולח תגובה – לרוב בצורת ייצוג של המשאב שצוין.

בממשקי RESTful API של Google, הלקוח מציין פעולה באמצעות פועל של HTTP כמו POST,‏ GET,‏ PUT או DELETE. הוא מציין משאב לפי URI ייחודי גלובלי, באופן הבא:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

בגלל שלכל משאבי ה-API יש מזהה URI ייחודי שניתן לגשת אליו באמצעות HTTP,‏ ב-REST אפשר לשמור נתונים במטמון והוא מותאם לעבודה עם התשתית המבוזרת של האינטרנט.

תוכלו להיעזר בהגדרות השיטה במסמכי התיעוד של תקני HTTP 1.1 – הן כוללות מפרטים של GET,‏ POST,‏ PUT ו-DELETE.

‫REST ב-Compute Engine API

הפעולות של Compute Engine API ממופות ישירות לפעלים מסוג REST HTTP.

הפורמט של מזהי ה-URI ב-Compute Engine API הוא:

https://www.googleapis.com/compute/API_VERSION/RESOURCE_PATH

ה-URI מכיל את הערכים הבאים:

• ‫API_VERSION: גרסת ה-API שבה רוצים להשתמש, שמתאימה לשלב ההשקה של משאב Compute Engine באופן הבא:
  • למשאבים ב-GA: v1
  • למשאבים בתוכנית Public Preview: beta
  • למשאבים בתצוגה מקדימה פרטית: alpha
• ‫RESOURCE_PATH: הנתיב למשאב ספציפי של Compute Engine, לדוגמה projects/example-project/aggregated/instances. כדי לראות את המשאבים הזמינים לכל גרסת API, אפשר לעיין במאמרים הבאים:
  • ‫Compute Engine API v1
  • ‫Compute Engine API beta
  • ‫Compute Engine API alpha (גרסת טרום-השקה)

אם רוצים לכלול פרמטרים של שאילתה, צריך לכלול אותם ב-URI אחרי סימן שאלה (?):

https://www.googleapis.com/compute/API_VERSION/RESOURCE_PATH?QUERY_PARAMETERS

ב-URI,‏ QUERY_PARAMETERS היא רשימה של פרמטרים של שאילתות, שמופרדים באמצעות אמפרסנד (&). לדוגמה: format=json&filter=zone=us-central1-a.

מידע על פורמט הנתונים JSON

הנתונים מוחזרים בפורמט JSON ב-Compute Engine API.

‫JSON‏ (JavaScript Object Notation) הוא פורמט נתונים נפוץ בלתי תלוי בשפה, שמספק ייצוג טקסט פשוט של מבני נתונים שרירותיים. למידע נוסף היכנסו לאתר של json.org.