REST Resource: projects.locations.tcpRoutes

משאב: TcpRoute

‫TcpRoute הוא המשאב שמגדיר איך תנועת TCP צריכה להיות מנותבת על ידי משאב Mesh או Gateway.

ייצוג ב-JSON
{
  "name": string,
  "selfLink": string,
  "createTime": string,
  "updateTime": string,
  "description": string,
  "rules": [
    {
      object (RouteRule)
    }
  ],
  "meshes": [
    string
  ],
  "gateways": [
    string
  ],
  "labels": {
    string: string,
    ...
  }
}
שדות
name

string

חובה. השם של משאב TcpRoute. הוא תואם לתבנית projects/*/locations/global/tcpRoutes/tcp_route_name>.

createTime

string (Timestamp format)

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

חותמת זמן בפורמט RFC3339 UTC ‏'Zulu', עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה העשרונית. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

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

חותמת זמן בפורמט RFC3339 UTC ‏'Zulu', עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה העשרונית. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

description

string

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

rules[]

object (RouteRule)

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

meshes[]

string

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

כל הפניה לרשת צריכה להתאים לתבנית: projects/*/locations/global/meshes/<mesh_name>

השגיאה: The attached Mesh should be of a type SIDECAR

gateways[]

string

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

כל הפניה לשער צריכה להתאים לתבנית: projects/*/locations/global/gateways/<gateway_name>

labels

map (key: string, value: string)

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

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

RouteRule

מציינת איך להתאים תנועה ואיך לנתב תנועה כשיש התאמה.

ייצוג ב-JSON
{
  "matches": [
    {
      object (RouteMatch)
    }
  ],
  "action": {
    object (RouteAction)
  }
}
שדות
matches[]

object (RouteMatch)

זה שינוי אופציונלי. המאפיין RouteMatch מגדיר את התנאי שמשמש להתאמת בקשות לפעולה נתונה. כדי לבצע הערכה, המערכת משתמשת באופרטור OR בין כמה סוגי התאמה. אם לא מציינים שדה routeMatch, הכלל הזה יתאים לתנועה ללא תנאי.

action

object (RouteAction)

חובה. הכלל המפורט שמגדיר איך לנתב תעבורה תואמת.

RouteMatch

המאפיין RouteMatch מגדיר את התנאי שמשמש להתאמת בקשות לפעולה נתונה. כדי לבצע הערכה, המערכת משתמשת באופרטור OR בין כמה סוגי התאמה. אם לא מציינים שדה routeMatch, הכלל הזה יתאים לתנועה ללא תנאי.

ייצוג ב-JSON
{
  "address": string,
  "port": string
}
שדות
address

string

חובה. חובה לציין בפורמט של טווח CIDR. טווח CIDR מורכב מכתובת IP ומאורך קידומת שמשמשים ליצירת מסכה של רשת משנה. כברירת מחדל, אורך הקידומת הוא 32 (כלומר, מתאים לכתובת IP אחת). יש תמיכה רק בכתובות IPV4. דוגמאות: ‎"10.0.0.1"‎ – התאמה לכתובת ה-IP המדויקת הזו. ‫‎"10.0.0.0/8" – מתאים לכל כתובת IP ברשת המשנה 10.0.0.0 ולמסכה 255.255.255.0. ‫'0.0.0.0/0' – מתאים לכל כתובת IP.

port

string

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

RouteAction

המפרט לניתוב תנועה ולהחלת מדיניות משויכת.

ייצוג ב-JSON
{
  "destinations": [
    {
      object (RouteDestination)
    }
  ],
  "originalDestination": boolean,
  "idleTimeout": string
}
שדות
destinations[]

object (RouteDestination)

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

originalDestination

boolean

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

idleTimeout

string (Duration format)

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

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-'s'. דוגמה: "3.5s".

RouteDestination

מתארים את היעד שאליו התנועה תנותב.

ייצוג ב-JSON
{
  "serviceName": string,
  "weight": integer
}
שדות
serviceName

string

חובה. כתובת ה-URL של BackendService שאליה תנותב התנועה.

weight

integer

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

אם מציינים רק serviceName אחד והמשקל שלו גדול מ-0, ‏ 100% מהתנועה מועברים לקצה העורפי הזה.

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

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

Methods

create

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

delete

מחיקת TcpRoute יחיד.

get

קבלת פרטים של TcpRoute יחיד.

list

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

patch

מעדכן את הפרמטרים של TcpRoute יחיד.

setIamPolicy

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

testIamPermissions

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