REST Resource: projects.locations.gateways

משאב: שער

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

ייצוג ב-JSON
{
  "name": string,
  "selfLink": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "type": enum (Type),
  "addresses": [
    string
  ],
  "ports": [
    integer
  ],
  "allPorts": boolean,
  "scope": string,
  "serverTlsPolicy": string,
  "certificateUrls": [
    string
  ],
  "gatewaySecurityPolicy": string,
  "network": string,
  "subnetwork": string,
  "ipVersion": enum (IpVersion),
  "routingMode": enum (RoutingMode),
  "allowGlobalAccess": boolean,
  "envoyHeaders": enum (EnvoyHeaders)
}
שדות
name

string

מזהה. שם המשאב של השער. הוא תואם לתבנית projects/*/locations/*/gateways/<gateway_name>.

createTime

string (Timestamp format)

פלט בלבד. חותמת הזמן של מועד יצירת המשאב.

השימוש הוא ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

פלט בלבד. חותמת הזמן של מועד העדכון של המשאב.

השימוש הוא ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

זה שינוי אופציונלי. קבוצה של תגי תוויות שמשויכים למשאב Gateway.

אובייקט שמכיל רשימה של זוגות "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

description

string

זה שינוי אופציונלי. תיאור של המשאב בטקסט חופשי. אורך מקסימלי של 1,024 תווים.

type

enum (Type)

לא ניתן לשינוי. סוג השער שמנוהל על ידי הלקוח. חובה למלא את השדה הזה. אם לא הוגדר, תוחזר שגיאה.

addresses[]

string

זה שינוי אופציונלי. אפס או כתובת IPv4 או IPv6 אחת שבה השער יקבל את התנועה. אם לא מציינים כתובת, מוקצית כתובת IP מרשת המשנה

השדה הזה רלוונטי רק לשערים מסוג SECURE_WEB_GATEWAY. שערים מסוג OPEN_MESH מאזינים ל-0.0.0.0 ב-IPv4 ול-:: ב-IPv6.

ports[]

integer

חובה. מספר יציאה אחד או יותר (1-65535), שבהם השער יקבל תנועה. שרת ה-proxy נקשר ליציאות שצוינו. שערים מסוג SECURE_WEB_GATEWAY מוגבלים ל-5 יציאות. שערים מסוג OPEN_MESH מאזינים ב-0.0.0.0 ל-IPv4 וב-‎ :: ‎ ל-IPv6, ותומכים בכמה יציאות.

allPorts

boolean

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

scope

string

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

האורך המקסימלי הוא 64 תווים. היקף ההרשאות צריך להתחיל באות ויכול להכיל רק אותיות, מספרים ומקפים.

serverTlsPolicy

string

זה שינוי אופציונלי. הפניה לכתובת URL מוגדרת במלואה של ServerTLSPolicy. מציינת איך תנועת TLS מסתיימת. אם השדה ריק, סיום TLS מושבת.

certificateUrls[]

string

זה שינוי אופציונלי. הפניה לכתובת URL מוגדרת במלואה של אישורים. שרת ה-Proxy מציג אישור (שנבחר על סמך SNI) כשהוא יוצר חיבור TLS. התכונה הזו רלוונטית רק לשערים מסוג SECURE_WEB_GATEWAY.

gatewaySecurityPolicy

string

זה שינוי אופציונלי. הפניה לכתובת URL מוגדרת במלואה של GatewaySecurityPolicy. מגדירה איך השרת צריך להחיל את מדיניות האבטחה על חיבורים נכנסים (מ-VM לשרת proxy).

לדוגמה: projects/*/locations/*/gatewaySecurityPolicies/swg-policy.

המדיניות הזו ספציפית לשערים מסוג SECURE_WEB_GATEWAY.

network

string

זה שינוי אופציונלי. שם המשאב היחסי שמזהה את רשת ה-VPC שמשתמשת בהגדרה הזו. לדוגמה: projects/*/global/networks/network-1.

נכון לעכשיו, השדה הזה ספציפי לשערים מסוג SECURE_WEB_GATEWAY.

subnetwork

string

זה שינוי אופציונלי. שם המשאב היחסי שמזהה את רשת המשנה שבה מוקצה ה-SWG הזה. לדוגמה: projects/*/regions/us-central1/subnetworks/network-1

נכון לעכשיו, השדה הזה ספציפי לשערים מסוג SECURE_WEB_GATEWAY.

ipVersion

enum (IpVersion)

זה שינוי אופציונלי. גרסת ה-IP שבה השער הזה ישתמש. האפשרויות התקינות הן IPV4 או IPV6. ברירת המחדל היא IPV4.

routingMode

enum (RoutingMode)

זה שינוי אופציונלי. מצב הניתוב של השער. אפשר להגדיר את השדה הזה רק לשערים מסוג SECURE_WEB_GATEWAY. השדה הזה נדרש לשערים מסוג SECURE_WEB_GATEWAY.

allowGlobalAccess

boolean

זה שינוי אופציונלי. אם הערך הוא True, השער יאפשר תנועה מלקוחות מחוץ לאזור שבו השער נמצא. אפשר להגדיר את השדה הזה רק לשערים מסוג SECURE_WEB_GATEWAY.

envoyHeaders

enum (EnvoyHeaders)

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

סוג

סוג השער בניהול הלקוח. הערכים האפשריים הם: * OPEN_MESH * SECURE_WEB_GATEWAY

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED לא צוין סוג השער שמנוהל על ידי הלקוח.
OPEN_MESH סוג השער בניהול הלקוח הוא TrafficDirector Open Mesh.
SECURE_WEB_GATEWAY סוג השער שמנוהל על ידי הלקוח הוא SecureWebGateway‏ (SWG).

IpVersion

סוגי גרסאות ה-IP של השער. הערכים האפשריים הם: * IPV4 * IPV6

טיפוסים בני מנייה (enum)
IP_VERSION_UNSPECIFIED הסוג כשגרסת ה-IP לא צוינה. ברירת המחדל היא IPV4.
IPV4 הסוג של כתובת IP בגרסה 4.
IPV6 הסוג של IP גרסה 6.

RoutingMode

מצב הניתוב של השער, שקובע איך השער מנתב את התנועה. נכון להיום, השדה הזה רלוונטי רק לשערים מסוג SECURE_WEB_GATEWAY. הערכים האפשריים הם: * EXPLICIT_ROUTING_MODE * NEXT_HOP_ROUTING_MODE

טיפוסים בני מנייה (enum)
EXPLICIT_ROUTING_MODE מצב הניתוב הוא מפורש, והלקוחות מוגדרים לשלוח תנועה דרך השער. זהו מצב הניתוב שמוגדר כברירת מחדל.
NEXT_HOP_ROUTING_MODE מצב הניתוב הוא next-hop. הלקוחות לא מודעים לשער, ואפשר להגדיר נתיב (נתיב מתקדם או סוג אחר של נתיב) כדי להפנות תנועה מהלקוח לשער. לאחר מכן, שער הגישה פועל בתור הדילוג הבא אל היעד.

Methods

create

יצירת שער חדש בפרויקט ובמיקום נתונים.

delete

מחיקת שער אחד.

get

אחזור פרטים של שער גישה יחיד.

getIamPolicy

מקבלת את מדיניות בקרת הגישה של משאב.

list

הצגת רשימה של שערים בפרויקט ובמיקום נתונים.

patch

עדכון הפרמטרים של שער יחיד.

setIamPolicy

מגדירה את מדיניות בקרת הגישה במשאב שצוין.

testIamPermissions

הפונקציה מחזירה את ההרשאות שיש לפונקציית קריאה חוזרת (caller) במשאב שצוין.