Apigee Operator for Kubernetes resource reference

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

בדף הזה מפורטים כל משאבי Kubernetes שנתמכים על ידי Apigee Operator ל-Kubernetes. חובה למלא את כל השדות, אלא אם הם מסומנים כאופציונליים.

APIProduct

שדה	תיאור
apiVersion סוג: string	apim.googleapis.com/v1
kind סוג: string	APIProduct
metadata סוג: Kubernetes meta/v1.ObjectMeta	מידע על השדות שזמינים ב-metadata מופיע במאמרי העזרה של ה-API של Kubernetes.
spec סוג: APIProductSpec	‫spec מגדיר את המצב הרצוי של APIProductSet.

APIProductSpec

שדה	תיאור
name סוג: string	השם של מוצר ה-API.
approvalType סוג: string	דגל שמציין איך מפתחות API מאושרים לגישה לממשקי ה-API שמוגדרים על ידי מוצר ה-API. אם הערך הוא manual, טוקן הצרכן נוצר ומוחזר כ-pending. במקרה כזה, מפתחות ה-API לא יפעלו עד שיאושרו באופן מפורש. אם הערך הוא auto, טוקן הצרכן נוצר ומוחזר כ-approved ואפשר להשתמש בו באופן מיידי.
description סוג: string	תיאור של מוצר ה-API.
displayName סוג: string	השם שמוצג בממשק המשתמש או בפורטל המפתחים למפתחים שנרשמים לגישה ל-API.
analytics סוג: Analytics	המאפיין הזה מגדיר אם צריך לאסוף נתונים לצורך ניתוח פעולות שמשויכות למוצר הזה.
enforcementRefs סוג: Array	מערך של משאבי EnforcementRef להחלה על מוצר ה-API.
attributes סוג: Array	מערך של מאפיינים שאפשר להשתמש בהם כדי להרחיב את פרופיל המוצר של ה-API שמוגדר כברירת מחדל עם מטא-נתונים ספציפיים ללקוח.

EnforcementRef

שדה	תיאור
name סוג: string	השם של משאב היעד.
kind סוג: string	APIMExtensionPolicy
group סוג: string	‫APIGroup עבור Apigee APIM Operator, שהוא apim.googleapis.com.
namespace סוג: string	(אופציונלי) מרחב השמות של הישות שאליה מתייחסים. אם לא מציינים מרחב שמות, המערכת מסיקה מהו מרחב השמות המקומי.

מאפיין

שדה	תיאור
name סוג: string	המפתח של המאפיין.
value סוג: string	הערך של המאפיין.

APIOperationSet

שדה	תיאור
apiVersion סוג: string	apim.googleapis.com/v1
kind סוג: string	APIOperationSet
metadata סוג: Kubernetes meta/v1.ObjectMeta	מידע על השדות שזמינים ב-metadata מופיע במאמרי העזרה של ה-API של Kubernetes.
spec סוג: APIOperationSetSpec	ההגדרה הזו מגדירה את המצב הרצוי של APIOperationSet.

APIOperationSetSpec

שדה	תיאור
quota סוג: Quota	הגדרת מכסה.
restOperations סוג: Array	מערך של הגדרות RESTOperation.
apiProductRefs סוג: Array	מערך של משאבי APIProductRef או הפניות למוצרי API שבהם צריך להחיל את RESTOperations.

מכסה

שדה	תיאור
limit סוג: integer	מספר הודעות הבקשה שמותר לשלוח לכל אפליקציה באמצעות מוצר ה-API עבור interval וtimeUnit שצוינו.
interval סוג: integer	פרק הזמן שלפיו מחושב מספר ההודעות עם הבקשות.
timeUnit סוג: string	יחידת הזמן שמוגדרת למרווח. הערכים התקפים כוללים minute,‏ hour,‏ day או month.

RESTOperation

שדה	תיאור
name סוג: string	השם של פעולת ה-REST.
path סוג: string	בצירוף עם methods, ‏ path הוא נתיב ה-HTTP שצריך להתאים למכסת שימוש או למוצר API.
methods סוג: array	בצירוף עם path, ‏ methods היא הרשימה (בתור strings) של שיטות HTTP רלוונטיות להתאמה למכסת שימוש ו/או למוצר API.

APIProductRef

שדה	תיאור
name סוג: string	השם של משאב היעד.
kind סוג: string	APIProduct
group סוג: string	‫APIGroup עבור Apigee APIM Operator, שהוא apim.googleapis.com.
namespace סוג: string	(אופציונלי) מרחב השמות של הישות שאליה מתייחסים. אם לא מציינים מרחב שמות, המערכת מסיקה מהו מרחב השמות המקומי.

APIMExtensionPolicy

שדה	תיאור
apiVersion סוג: string	apim.googleapis.com/v1
kind סוג: string	APIMExtensionPolicy
metadata סוג: Kubernetes meta/v1.ObjectMeta	מידע על השדות שזמינים ב-metadata מופיע במאמרי העזרה של ה-API של Kubernetes.
spec סוג: APIMExtensionPolicySpec	ההגדרה הזו מגדירה את המצב הרצוי של APIMExtensionPolicy.

APIMExtensionPolicySpec

שדה	תיאור
apigeeEnv	(אופציונלי) סביבת Apigee. אם לא תציינו סביבה, תיצור סביבה חדשה ותצרף אותה לכל המופעים הזמינים. אם מספקים סביבה כזו, צריך לצרף אותה לכל המופעים הזמינים בזמן השימוש במאזן עומסים גלובלי חיצוני.
failOpen סוג: boolean	ההגדרה קובעת אם להיפתח במקרה של כשל כשאי אפשר להגיע לזמן הריצה של Apigee. אם המדיניות מוגדרת לערך true, קריאות לזמן הריצה של Apigee ייחשבו כמוצלחות גם אם אי אפשר להגיע לזמן הריצה.
timeout סוג: string	מציינת את משך הזמן הקצוב לתפוגה לפני שקריאות לזמן הריצה של Apigee ייכשלו, בשניות או באלפיות השנייה. לדוגמה, 10s.
targetRef סוג: ExtensionServerRef	מזהה את שער Google Kubernetes Engine שבו צריך להתקין את התוסף.
location סוג: string	מזהה את Google Cloud המיקום שבו נאכפת מדיניות APIMExtensionPolicy.
supportedEvents סוג: List אירועים	מציין את רשימת אירועי המעבד של התוסף שנשלחים אל Apigee. למשל: "REQUEST_HEADERS" "RESPONSE_HEADERS" "REQUEST_BODY" (תצוגה מקדימה) "RESPONSE_BODY" (תצוגה מקדימה) "REQUEST_TRAILERS" "RESPONSE_TRAILERS"

ExtensionServerRef

שדה	תיאור
name סוג: string	השם של משאב היעד.
kind סוג: string	מציינים את kind של משאב היעד, לדוגמה, Gateway או Service.
group סוג: string	‫APIGroup עבור Apigee APIM Operator, שהוא apim.googleapis.com.
namespace סוג: string	(אופציונלי) מרחב השמות של הישות שאליה מתייחסים. אם לא מציינים מרחב שמות, המערכת מסיקה מהו מרחב השמות המקומי.

ApigeeGatewayPolicy

שדה	תיאור
apiVersion סוג: string	apim.googleapis.com/v1
kind סוג: string	ApigeeGatewayPolicy
metadata סוג: Kubernetes meta/v1.ObjectMeta	מידע על השדות שזמינים ב-metadata מופיע במאמרי העזרה של ה-API של Kubernetes.
spec סוג: ApigeeGatewayPolicySpec	ההגדרה הזו מגדירה את המצב הרצוי של ApigeeGatewayPolicy.

ApigeeGatewayPolicySpec

שדה	תיאור
ref סוג: ExtensionServerRef	מתייחס לתבנית APIM שנוצרה כדי לנהל את כללי המדיניות שחלים על GKE Gateway.
targetRef סוג: ExtensionServerRef	מפנה למדיניות של תוסף APIM שאמור להחיל את מדיניות השער הספציפית הזו. מפנה בעקיפין אל GKE Gateway.
serviceAccount	(אופציונלי) מציין את חשבון השירות שמשמש ליצירת אסימוני אימות Google בשרת proxy של Apigee ProApigee.

ApimTemplate

שדה	תיאור
apiVersion סוג: string	apim.googleapis.com/v1
kind סוג: string	ApimTemplate
metadata סוג: Kubernetes meta/v1.ObjectMeta	מידע על השדות שזמינים ב-metadata מופיע במאמרי העזרה של ה-API של Kubernetes.
spec סוג: ApimTemplateSpec	ההגדרה הזו מגדירה את המצב הרצוי של ApimTemplate.

ApimTemplateSpec

שדה	תיאור
templates סוג: list	רשימה של משאבי ApimTemplateFlow שמציינים את המדיניות שתופעל בתהליך הבקשה.
apimTemplateRule סוג: ExtensionServerRef	מציין את כלל התבנית של APIM שצריך להשתמש בו כדי לאמת את המדיניות שהוחלה.

ApimTemplateFlow

שדה	תיאור
policies סוג: list ConditionalParameterReference	רשימה של משאבי ConditionalParameterReference שמציינים את הרשימה הממוינת של כללי המדיניות שיש להפעיל כחלק מתהליך הבקשה.
condition סוג: string	מציינים את התנאים להפעלת המשאב הזה.

ConditionalParameterReference

שדה	תיאור
condition Type: string	מציינים את התנאים להפעלת המשאב הזה.

ApimTemplateRule

שדה	תיאור
apiVersion סוג: string	apim.googleapis.com/v1
kind סוג: string	ApimTemplateRule
metadata סוג: Kubernetes meta/v1.ObjectMeta	מידע על השדות שזמינים ב-metadata מופיע במאמרי העזרה של ה-API של Kubernetes.
spec סוג: ApimTemplateRuleSpec	ההגדרה הזו מגדירה את המצב הרצוי של ApimTemplateRule.

ApimTemplateRuleSpec

שדה	תיאור
requiredList	רשימת כללי המדיניות (כמו strings) שחייבים להיות נוכחים ב-ApimTemplate.
denyList	רשימת כללי המדיניות (בתור strings) שלא צריכים להיות נוכחים ב-ApimTemplate.
allowList	רשימת כללי המדיניות (כמו strings) שעשויים להופיע ב-ApimTemplate אבל לא חובה.
override סוג: boolean	העדכונים מבטלים את הכלל בתבנית APIM אם קיימות תבניות APIM שמשתמשות בכלל. הערכים התקינים הם true או false.

‫AssignMessage (הזרקת טוקן)Google

שדה	תיאור
apiVersion סוג: string	apim.googleapis.com/v1
kind סוג: string	AssignMessage
metadata סוג: Kubernetes meta/v1.ObjectMeta	מידע על השדות שזמינים ב-metadata מופיע במאמרי העזרה של ה-API של Kubernetes.
spec סוג: AssignMessageBean	ההגדרה הזו מגדירה את המצב הרצוי של מדיניות AssignMessage.

AssignMessageBean

שדה	תיאור
setActions סוג: array	מערך של אובייקטים מסוג SetActionsBean. הפונקציה מחליפה את הערכים של מאפיינים קיימים בבקשה או בתגובה, בהתאם למה שצוין ברכיב AssignTo. אם הכותרות או הפרמטרים כבר קיימים בהודעה המקורית, setActions מחליף את הערכים. אחרת, setActions מוסיף כותרות או פרמטרים חדשים לפי מה שצוין.
AssignTo סוג: AssignToBean	מציינת על איזו הודעה חלה מדיניות AssignMessage. האפשרויות כוללות את הבקשה, התשובה או הודעה מותאמת אישית חדשה.

SetActionsBean

שדה	תיאור
Authentication סוג: AuthenticationBean	יצירת אסימונים מסוג OAuth 2.0 או OpenID Connect כדי לבצע קריאות מאומתות לשירותים או לשירותים בהתאמה אישית שפועלים במוצרים מסוימים, כמו פונקציות Cloud Run ו-Cloud Run. Google Google Google Cloud

AuthenticationBean

שדה	תיאור
GoogleAccessToken סוג: GoogleAccessTokenBean	יוצר אסימונים של Google OAuth 2.0 כדי לבצע קריאות מאומתות לשירותי Google.
GoogleIDToken סוג: GoogleIDTokenBean	הגדרה ליצירת אסימון OpenID Connect לאימות בקשת היעד.
headerName סוג: string	כברירת מחדל, כשמוגדר אימות, Apigee יוצר אסימון bearer ומזריק אותו לכותרת Authorization של ההודעה שנשלחת למערכת היעד. רכיב headerName מאפשר לציין את השם של כותרת אחרת שתכיל את אסימון ה-Bearer.

GoogleAccessTokenBean

שדה	תיאור
scopes סוג: array	מערך של strings שמציין היקף תקין של Google API. למידע נוסף, ראו היקפי OAuth 2.0 ל-Google APIs.
LifetimeInSeconds סוג: integer	מציין את משך החיים של אסימון הגישה בשניות.

GoogleIDTokenBean

שדה	תיאור
Audience סוג: AudienceBean	הקהל של אסימון האימות שנוצר, למשל ה-API או חשבון השירות שקיבלו גישה באמצעות האסימון.
IncludeEmail סוג: boolean	אם הערך מוגדר כ-true, אסימון האימות שנוצר יכיל את הטענות email ו-email_verified של חשבון השירות.

AudienceBean

שדה	תיאור
useTargetHost סוג: string	אם הערך של Audience ריק או שהמשתנה ref לא מתפרש כערך תקין, והערך של useTargetUrl הוא true, כתובת ה-URL של היעד (לא כולל פרמטרים של שאילתה) משמשת כקהל.
useTargetUrl סוג: boolean	ערך ברירת המחדל של useTargetUrl הוא false.

AssignToBean

שדה	תיאור
createNew סוג: boolean	קובעת אם המדיניות יוצרת הודעה חדשה כשמגדירים ערכים. אם המדיניות מוגדרת לערך true, נוצרת הודעה חדשה.
type סוג: string	מציין את סוג ההודעה החדשה, כשהערך של CreateNew מוגדר ל-true true. הערכים התקינים הם request או response.

JavaScript

שדה	תיאור
apiVersion סוג: string	apim.googleapis.com/v1
kind סוג: string	JavaScript
metadata סוג: Kubernetes meta/v1.ObjectMeta	מידע על השדות שזמינים ב-metadata מופיע במאמרי העזרה של ה-API של Kubernetes.
spec סוג: JavascriptBean	ההגדרה הזו מגדירה את המצב הרצוי של מדיניות JavaScript.

JavascriptBean

שדה	תיאור
mode סוג: array	מערך של strings שמציין ProxyRequest או ProxyResponse. קובע אם המדיניות מצורפת לזרימת הבקשה או לזרימת התגובה.
source סוג: string	קוד JavaScript בתוך השורה.
timeLimit סוג: integer	המדיניות קובעת את פסק הזמן להרצת קוד JavaScript.

KVM

שדה	תיאור
apiVersion סוג: string	apim.googleapis.com/v1
kind סוג: string	KVM
metadata סוג: Kubernetes meta/v1.ObjectMeta	מידע על השדות שזמינים ב-metadata מופיע במאמרי העזרה של ה-API של Kubernetes.
spec סוג: KeyValueMapOperationsBean	ההגדרה הזו מגדירה את המצב הרצוי של מדיניות KVM.

KeyValueMapOperationsBean

שדה	תיאור
MapName סוג: MapName	הפעלת המדיניות מאפשרת לזהות באופן דינמי בזמן הריצה את ה-KVM שבו יש להשתמש. מידע נוסף זמין במאמר בנושא רכיב MapName.
expiryTimeInSecs סוג: integer	ההגדרה הזו מציינת את משך הזמן בשניות שבסיומו Apigee מרענן את הערך ששמור במטמון מ-KVM שצוין. מידע נוסף זמין במאמר בנושא האלמנט ExpiryTimeInSecs.
initialEntries סוג: list	ערכי אתחול ל-KVM, שמאוכלסים ב-KVM כשהוא מאותחל. מידע נוסף זמין במאמר בנושא רכיב InitialEntries.
delete סוג: list מתוך Delete	מחיקת צמד מפתח/ערך שצוין מ-KVM. מידע נוסף מופיע במאמר מחיקת רכיב.
get סוג: list מתוך Get	אחזור הערך של מפתח מ-KVM. מידע נוסף מופיע בקטע Get element.

OASValidation

שדה	תיאור
apiVersion סוג: string	apim.googleapis.com/v1
kind סוג: string	OASValidation
metadata סוג: Kubernetes meta/v1.ObjectMeta	מידע על השדות שזמינים ב-metadata מופיע במאמרי העזרה של ה-API של Kubernetes.
spec סוג: OASValidationBean	ההגדרה הזו מגדירה את המצב הרצוי של מדיניות OASValidation.
status סוג: ApimResourceStatus	הסטטוס של מדיניות OASValidation.

OASValidationBean

שדה	תיאור
openApiSpec סוג: string	מציינים את מפרט OpenAPI ב-yaml שרוצים לאמת. מכיוון שמדובר בקטע yaml רב-שורה, צריך להשתמש בתו המפריד '|'.
source סוג: string	אחד מהערכים message, request או response. אם המדיניות מוגדרת כ-request, היא תבדוק בקשות נכנסות מאפליקציות לקוח. אם היא מוגדרת כ-response, היא תבדוק תגובות משרתי יעד. אם הערך הוא message, המערכת תעריך באופן אוטומטי את הבקשה או את התגובה, בהתאם לשאלה אם המדיניות מצורפת לתהליך הבקשה או לתהליך התגובה.
options סוג: OASValidationOptions	ראו OASValidationOptions/td>

OASValidationOptions

שדה	תיאור
validateMessageBody סוג: boolean	ההגדרה קובעת אם המדיניות צריכה לאמת את גוף ההודעה מול סכמת גוף הבקשה של הפעולה במפרט OpenAPI. הערך true מאפשר לאמת את התוכן של גוף ההודעה. מוגדר לערך false כדי לאמת רק את קיום גוף ההודעה.
allowUnspecifiedParameters סוג: StrictOptions	ראו StrictOptions

StrictOptions

שדה	תיאור
header סוג: boolean	כדי לאפשר לציין בבקשה פרמטרים של כותרות שלא מוגדרים במפרט OpenAPI, צריך להגדיר את הפרמטר הזה לערך true. אחרת, מגדירים את הפרמטר הזה לערך false כדי לגרום לביצוע המדיניות להיכשל.
query סוג: boolean	כדי לאפשר לציין בבקשה פרמטרים של שאילתה שלא מוגדרים במפרט OpenAPI, מגדירים את הפרמטר הזה לערך true. אחרת, מגדירים את הפרמטר הזה לערך false כדי לגרום לביצוע המדיניות להיכשל.
cookie סוג: boolean	כדי לאפשר לציין בבקשה פרמטרים של קובצי Cookie שלא מוגדרים במפרט OpenAPI, מגדירים את הפרמטר הזה לערך true. אחרת, מגדירים את הפרמטר הזה לערך false כדי לגרום לביצוע המדיניות להיכשל.

ApimResourceStatus

שדה	תיאור
currentState סוג: enum	המצב הנוכחי של המשאב: ‫RUNNING = המשאב במצב פעיל. ‫CREATING = יצירת המשאב בתהליך ‫CREATED = המשאב נוצר ‫UPDATING = המשאב מתעדכן ‫DELETING = המשאב נמצא בתהליך מחיקה ‫CREATE_UPDATE_FAILED = פעולת היצירה או העדכון נכשלה ‫DELETE_FAILED = פעולת המחיקה נכשלה
errorMessage סוג: string	הודעת שגיאה שקשורה לאחד ממצבי הכשל של השדה currentState.
operationResult סוג: string	מחרוזת תגובה מאחת הפעולות הממושכות שקשורות ליצירה, לעדכון או למחיקה של משאב.

ServiceCallout

שדה	תיאור
apiVersion סוג: string	apim.googleapis.com/v1
kind סוג: string	ServiceCallout
metadata סוג: Kubernetes meta/v1.ObjectMeta	מידע על השדות שזמינים ב-metadata מופיע במאמרי העזרה של ה-API של Kubernetes.
spec סוג: ServiceCalloutBean	ההגדרה הזו מגדירה את המצב הרצוי של מדיניות ServiceCallout.
status סוג: ApimResourceStatus	הסטטוס של מדיניות ServiceCallout.

ServiceCalloutBean

שדה	תיאור
httpTargetConnection סוג: HttpTargetConnection	מספק פרטים על התעבורה, כמו כתובת URL, ‏ TLS/SSL ומאפייני HTTP.
request סוג: CalloutRequest	מציין את המשתנה שמכיל את הודעת הבקשה שנשלחת מ-proxy ל-API לשירות אחר.
Response סוג: string	מציין את המשתנה שמכיל את הודעת התגובה שמוחזרת משרת ה-API אל proxy ל-API.

HttpTargetConnection

שדה	תיאור
url סוג: string	כתובת ה-URL של שירות היעד.
properties סוג: Map of <string, string>	מאפייני העברה של HTTP לשירות לקצה העורפי. מידע נוסף זמין במאמר הפניה למאפייני Endpoint.
timeout סוג: int	הזמן הקצוב לתפוגה באלפיות השנייה של הקריאה לשירות. מידע נוסף זמין במאמר בנושא פסק זמן.

CalloutRequest

שדה	תיאור
url סוג: string	כתובת ה-URL של שירות היעד.
properties סוג: Map of <string, string>	מאפייני העברה של HTTP לשירות לקצה העורפי. מידע נוסף זמין במאמר הפניה למאפייני Endpoint.

SpikeArrest

שדה	תיאור
apiVersion סוג: string	apim.googleapis.com/v1
kind סוג: string	SpikeArrest
metadata סוג: Kubernetes meta/v1.ObjectMeta	מידע על השדות שזמינים ב-metadata מופיע במאמרי העזרה של ה-API של Kubernetes.
spec סוג: SpikeArrestBean	ההגדרה הזו מגדירה את המצב הרצוי של מדיניות SpikeArrest.

SpikeArrestBean

שדה	תיאור
mode סוג: array	מערך של strings שמציין ProxyRequest או ProxyResponse. קובע אם המדיניות מצורפת לתהליך הבקשה או לתהליך התגובה.
peakMessageRate סוג: peakMessageRate	מציין את הקצב של ההודעות עבור SpikeArrest.
useEffectiveCount סוג: boolean	אם הערך הוא truetrue, המדיניות SpikeArrest מופצת באזור, ומספר הבקשות מסונכרן בין מעבדי ההודעות (MPs) של Apigee באזור. אם ההגדרה היא false, הרכיב SpikeArrest משתמש באלגוריתם token bucket באופן מקומי. מידע נוסף זמין במאמר UseEffectiveCount.

peakMessageRate

שדה	תיאור
ref סוג: string	משתנה שמפנה לערך rate.
value סוג: string	הערך בפועל של rate אם ההפניה לא זמינה.

GenerateJWT

שדה	תיאור
apiVersion סוג: string	apim.googleapis.com/v1
kind סוג: string	GenerateJWT
metadata סוג: Kubernetes meta/v1.ObjectMeta	מידע על השדות שזמינים ב-metadata מופיע במאמרי העזרה של ה-API של Kubernetes.
spec סוג: GenerateJWTBean	ההגדרה הזו מגדירה את המצב הרצוי של מדיניות GenerateJWT.
status סוג: ApimResourceStatus	מוצג סטטוס המדיניות GenerateJWT.

GenerateJWTBean

שדה	תיאור
subject סוג: PropertyBean	מזהה את חשבון המשתמש שהוא הנושא של ה-JWT. מידע נוסף זמין במאמר בנושא רכיב הנושא.
issuer סוג: PropertyBean	מזהה את חשבון המשתמש שהנפיק את ה-JWT. מידע נוסף זמין במאמר בנושא רכיב המנפיק.
audience סוג: VarArrayBean	מזהה את הנמענים שה-JWT מיועד להם. מידע נוסף מופיע במאמר בנושא רכיב הקהל.
id סוג: PropertyBean	מציין מזהה ייחודי ל-JWT. מידע נוסף זמין במאמר בנושא רכיב המזהה.
expiresIn סוג: PropertyBean	מציינת את זמן התפוגה של ה-JWT. מידע נוסף מופיע במאמר בנושא רכיב ExpiresIn.
notBefore סוג: PropertyBean	הזמן שלפניו אסור לקבל את ה-JWT לעיבוד. מידע נוסף זמין במאמר בנושא רכיב NotBefore.
additionalClaims סוג: AdditionalClaimsBean	מציינת הצהרות נוספות שייכללו ב-JWT. מידע נוסף זמין במאמר בנושא רכיב AdditionalClaims.
compress סוג: boolean	ההגדרה הזו מציינת אם לדחוס את המטען הייעודי (payload) של אסימון ה-JWT. מידע נוסף זמין במאמר בנושא דחיסת רכיב.

PropertyBean

שדה	תיאור
value סוג: string	הערך המילולי של המאפיין.
ref סוג: string	הפניה למשתנה שמכיל את הערך של המאפיין.

VarArrayBean

שדה	תיאור
values סוג: array מתוך string	מערך של ערכי מחרוזת מילוליים.
ref סוג: string	הפניה למשתנה שמכיל את מערך הערכים.

AdditionalClaimsBean

שדה	תיאור
claims סוג: map מתוך string עד string	מיפוי של שמות טענות לערכי טענות.
ref סוג: string	הפניה למשתנה שמכיל את מיפוי הטענות.

OAuthV2

שדה	תיאור
apiVersion סוג: string	apim.googleapis.com/v1
kind סוג: string	OAuthV2
metadata סוג: Kubernetes meta/v1.ObjectMeta	מידע על השדות שזמינים ב-metadata מופיע במאמרי העזרה של ה-API של Kubernetes.
spec סוג: OAuthV2Bean	ההגדרה הזו מגדירה את המצב הרצוי של מדיניות OAuthV2.
status סוג: ApimResourceStatus	מציג את סטטוס המדיניות של OAuthV2.

OAuthV2Bean

שדה	תיאור
operation סוג: enum	פעולת OAuthV2 לביצוע. הערכים התקינים הם: GenerateAuthorizationCode GenerateAccessToken GenerateAccessTokenImplicitGrant GenerateJWTAccessTokenImplicitGrant GenerateJWTAccessToken RefreshAccessToken RefreshJWTAccessToken VerifyAccessToken VerifyJWTAccessToken ValidateToken InvalidateToken מידע נוסף זמין במאמר בנושא רכיב הפעולה.
configRef סוג: string	(אופציונלי) הפניה לOAuthV2Config שם של משאב מותאם אישית שמכיל הגדרות של OAuthV2 שאפשר לעשות בהן שימוש חוזר.
scope סוג: string	ההיקף של טוקן הגישה. מידע נוסף זמין במאמר בנושא רכיב scope.
generateResponse סוג: GenerateResponse	הגדרת יצירת התשובה. מידע נוסף זמין במאמר בנושא רכיב GenerateResponse.
generateErrorResponse סוג: GenerateErrorResponse	הגדרה של יצירת תגובות לשגיאות. מידע נוסף זמין במאמר בנושא הרכיב GenerateErrorResponse.
expiresIn סוג: PropertyExpiryBean	זמן התפוגה של טוקן הגישה. מידע נוסף מופיע במאמר בנושא רכיב ExpiresIn.
refreshTokenExpiresIn סוג: PropertyExpiryBean	תאריך התפוגה של אסימון הרענון. מידע נוסף זמין במאמר בנושא רכיב RefreshTokenExpiresIn.
supportedGrantTypes סוג: array מתוך string	רשימה של סוגי מענקים נתמכים. מידע נוסף זמין במאמר SupportedGrantTypes element.
redirectURI סוג: string	כתובת ה-URI להפניה אוטומטית שמשמשת בסוג ההרשאה 'קוד הרשאה'. מידע נוסף זמין במאמר בנושא רכיב RedirectUri.
responseType סוג: string	סוג התגובה לסוג ההרשאה Authorization Code Grant. מידע נוסף זמין במאמר בנושא רכיב ResponseType.
clientID סוג: string	מזהה הלקוח. מידע נוסף זמין במאמר בנושא רכיב ClientId.
state סוג: string	פרמטר המצב לסוג ההרשאה Authorization Code Grant. מידע נוסף מופיע במאמר בנושא רכיב מצב.
appEndUser סוג: string	מזהה משתמש הקצה. מידע נוסף זמין במאמר בנושא רכיב AppEndUser.
code סוג: string	קוד ההרשאה. מידע נוסף זמין במאמר בנושא רכיב קוד.
userName סוג: string	שם המשתמש לסוג ההרשאה של הסיסמה. מידע נוסף זמין במאמר בנושא רכיב UserName.
password סוג: string	הסיסמה לסוג ההרשאה של הסיסמה. מידע נוסף זמין במאמר בנושא רכיב הסיסמה.
grantType סוג: string	סוג המענק. מידע נוסף זמין במאמר בנושא רכיב GrantType.
refreshToken סוג: string	אסימון הרענון. מידע נוסף זמין במאמר בנושא רכיב RefreshToken.
accessToken סוג: string	טוקן הגישה. מידע נוסף זמין במאמר בנושא רכיב AccessToken.
cacheExpiryInSeconds סוג: PropertyExpiryBean	מועד תפוגה של המטמון בשניות. מידע נוסף מופיע במאמר בנושא הגדרות תפוגה של מטמון.
verifyAccessTokenPrefix סוג: string	(אופציונלי) קידומת שבה המערכת תשתמש לאימות אסימון גישה.
externalAuthorization סוג: boolean	מציין אם להשתמש בשירות הרשאות חיצוני. מידע נוסף מופיע במאמר בנושא רכיב ExternalAuthorization.
reuseRefreshToken סוג: boolean	ההגדרה קובעת אם לעשות שימוש חוזר באסימוני רענון. מידע נוסף זמין במאמר בנושא רכיב ReuseRefreshToken.
rfcCompliance סוג: boolean	אכיפת התאימות ל-RFC. מידע נוסף זמין במאמר בנושא RFCCompliantRequestResponse element.
enforceStrictCallbackURIEnforced סוג: boolean	(אופציונלי) אוכף התאמה מדויקת של URI של קריאה חוזרת.
customAttributes סוג: array של CustomAttribute	מאפיינים מותאמים אישית שרוצים להוסיף לטוקן. מידע נוסף זמין במאמר בנושא רכיב מאפיינים.
externalAccessToken סוג: string	טוקן גישה חיצוני. מידע נוסף זמין במאמר בנושא רכיב ExternalAccessToken.
externalRefreshToken סוג: string	טוקן רענון חיצוני. מידע נוסף זמין במאמר בנושא רכיב ExternalRefreshToken.
storeToken סוג: string	מציין אם לאחסן את האסימון. מידע נוסף זמין במאמר בנושא רכיב StoreToken.
tokens סוג: array מתוך Token	רשימה של טוקנים שצריך לבטל את התוקף שלהם. מידע נוסף זמין במאמר בנושא רכיב Tokens.
algorithm סוג: string	האלגוריתם שמשמש לחתימה על ה-JWT. מידע נוסף זמין במאמר בנושא רכיב האלגוריתם.
secretKey סוג: SecretKey	המפתח הסודי שמשמש לחתימה על ה-JWT. מידע נוסף זמין במאמר בנושא רכיב SecretKey.
privateKey סוג: PrivateKey	המפתח הפרטי שמשמש לחתימה על ה-JWT. מידע נוסף זמין במאמר בנושא רכיב PrivateKey.
publicKey סוג: PublicKey	המפתח הציבורי שמשמש לאימות ה-JWT. מידע נוסף זמין במאמר בנושא רכיב PublicKey.

GenerateResponse

שדה	תיאור
enabled סוג: boolean	אם הערך הוא true או אם המאפיין enabled לא מצוין, המדיניות יוצרת תשובה ומחזירה אותה.
format סוג: enum	אחד מהערכים XML, FORM_PARAM.

GenerateErrorResponse

שדה	תיאור
enabled סוג: boolean	אם הערך הוא true או אם המאפיין enabled לא מצוין, המדיניות יוצרת תשובה ומחזירה אותה.
format סוג: enum	אחד מהערכים XML, FORM_PARAM.
realm סוג: PropertyBean	התחום שיוחזר בכותרת WWW-Authenticate.

PropertyExpiryBean

שדה	תיאור
value סוג: long	הערך המילולי של התפוגה.
ref סוג: string	הפניה למשתנה שמכיל את ערך התפוגה.

CustomAttribute

שדה	תיאור
name סוג: string	השם של המאפיין המותאם אישית.
ref סוג: string	הפניה למשתנה שמכיל את ערך המאפיין.
value סוג: string	הערך המילולי של המאפיין.

SecretKey

שדה	תיאור
value סוג: PropertyBean	מציין את המפתח הסודי שמשמש לחתימה על ה-JWT. מידע נוסף זמין במאמר בנושא רכיב SecretKey.

PrivateKey

שדה	תיאור
value סוג: PropertyBean	מציין את המפתח הפרטי שמשמש לחתימה על ה-JWT. מידע נוסף זמין במאמר בנושא רכיב PrivateKey.

PublicKey

שדה	תיאור
value סוג: PropertyBean	מציין את המפתח הציבורי שמשמש לאימות ה-JWT. מידע נוסף זמין במאמר בנושא רכיב PublicKey.

מדיניות ResponseCache

שדה	תיאור
apiVersion סוג: string	apim.googleapis.com/v1
kind סוג: string	ResponseCache
metadata סוג: Kubernetes meta/v1.ObjectMeta	מידע על השדות שזמינים ב-metadata מופיע במאמרי העזרה של ה-API של Kubernetes.
spec סוג: APIExtensionPolicySpec	ההגדרה הזו מגדירה את המצב הרצוי של ResponseCache.

ResponseCacheBean

שדה	תיאור
mode סוג: boolean	מציינים ProxyRequest או ProxyResponse. קובע אם המדיניות מצורפת לתהליך הבקשה או לתהליך התגובה.
cacheExpiry סוג: cacheExpiry	מספק את אובייקט cacheExpiry.
cacheKey סוג: cacheKey	מספק את אובייקט cacheKey.
cacheLookupTimeOut סוג: integer	מציינת את תקופת הזמן הקצוב לחיפוש במטמון.
cacheResourceRef סוג: string	מציינים את מזהה משאב המטמון באמצעות הפניה למשתנה.
excludeErrorResponse סוג: boolean	המדיניות הזו יכולה לשמור במטמון תגובות HTTP עם כל קוד סטטוס. כלומר, אפשר לשמור במטמון גם תגובות של הצלחה וגם תגובות של שגיאה, כולל קודי הסטטוס 2xx ו-3xx.
skipCacheLookupCondition סוג: string	ההגדרה מגדירה ביטוי שאם הוא שווה ל-true בזמן הריצה, מציינת שצריך לדלג על חיפוש במטמון ולרענן את המטמון
skipCachePopulationCondition סוג: string	ההגדרה מגדירה ביטוי שאם הערך שלו הוא true בזמן הריצה, מציין שצריך לדלג על חיפוש במטמון ולרענן את המטמון בזמן הריצה, או מציין שצריך לדלג על כתיבה למטמון.
useAcceptHeader סוג: boolean	הערך true מציין שערכים מכותרות של תגובות Accept יצורפו למפתח המטמון של רשומה במטמון התגובות.
useResponseCacheHeaders סוג: boolean	ההגדרה true גורמת לכך שכותרות תגובת ה-HTTP נלקחות בחשבון כשמגדירים את אורך החיים (TTL) של התגובה במטמון.

cacheExpiry

שדה	תיאור
expiryDate סוג: object	מציין את התאריך שבו רשומה במטמון אמורה לפוג.
timeOfDay סוג: object	מציינים את השעה ביום שבה תוקף הרשומה במטמון יפוג.
timeoutInSeconds סוג: object	מציין את מספר השניות שאחריהן תוקף של רשומה במטמון יפוג.

cacheKey

שדה	תיאור
cacheKeyPrefix סוג: string	מציינת ערך לשימוש כקידומת של מפתח מטמון.
fragments סוג: object	מציינים ערך שייכלל במפתח המטמון כדי ליצור מרחב שמות להתאמת בקשות לתגובות שנשמרו במטמון.