Method: projects.locations.apps.importApp

מייבא את האפליקציה שצוינה.

בקשת HTTP

POST https://ces.googleapis.com/v1beta/{parent=projects/*/locations/*}/apps:importApp

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם המשאב הראשי עם המיקום של האפליקציה לייבוא.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON
{
  "displayName": string,
  "appId": string,
  "importOptions": {
    object (ImportAppRequest.ImportOptions)
  },
  "ignoreAppLock": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsUri": string,
  "appContent": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "jsonPatchContent": string,
  "jsonPatchGcsUri": string
  // End of mutually exclusive fields.
}
שדות
displayName

string

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

appId

string

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

importOptions

object (ImportAppRequest.ImportOptions)

זה שינוי אופציונלי. אפשרויות שקובעות את תהליך הייבוא של האפליקציה.

ignoreAppLock

boolean

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

האפליקציה לייבוא. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
gcsUri

string

מזהה ה-URI של Google Cloud Storage שממנו מייבאים את האפליקציה. הפורמט של ה-URI הזה צריך להיות gs://<bucket-name>/<object-name>.

appContent

string (bytes format)

בייטים גולמיים שמייצגים את קובץ ה-ZIP הדחוס עם מבנה התיקיות של האפליקציה.

מחרוזת בקידוד Base64.

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

string

זה שינוי אופציונלי. תוכן התיקון כמחרוזת JSON.

jsonPatchGcsUri

string

זה שינוי אופציונלי. ‫URI של Cloud Storage שמפנה לקובץ JSON שמכיל את התיקונים.

סוף השדות הבלעדיים.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Operation.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • ces.apps.import

מידע נוסף מופיע במאמרי העזרה בנושא IAM.

ImportAppRequest.ImportOptions

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

ייצוג ב-JSON
{
  "conflictResolutionStrategy": enum (ImportAppRequest.ImportOptions.ConflictResolutionStrategy),
  "validateOnly": boolean
}
שדות
conflictResolutionStrategy

enum (ImportAppRequest.ImportOptions.ConflictResolutionStrategy)

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

validateOnly

boolean

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

ImportAppRequest.ImportOptions.ConflictResolutionStrategy

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

טיפוסים בני מנייה (enum)
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED לא צוינה אסטרטגיה לפתרון קונפליקטים.
REPLACE החלפת הנתונים הקיימים בנתונים המיובאים. אם כבר קיימת אפליקציה עם אותו appId, התוכן שלה יעודכן על סמך האפליקציה המיובאת. – משאבים (אפליקציה, סוכנים, כלים, דוגמאות, אמצעי הגנה, ערכות כלים) באפליקציה המיובאת שיש להם אותו שם תצוגה כמו למשאבים קיימים ידחוסו את המשאבים הקיימים. – ייווצרו משאבים מיובאים עם שמות חדשים לתצוגה. – משאבים קיימים שלא מופיע להם שם מוצג תואם באפליקציה המיובאת יישארו ללא שינוי.
OVERWRITE החלפת הנתונים הקיימים בנתונים מיובאים. אם כבר קיימת אפליקציה עם אותו appId, התוכן שלה יוחלף באפליקציה המיובאת. – משאבים קיימים (סוכנים, כלים, דוגמאות, אמצעי הגנה, ערכות כלים) באפליקציה יימחקו. – משאבים מיובאים ייצרו משאבים חדשים.