Method: projects.locations.apps.importApp

匯入指定的應用程式。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
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

選用。要用於匯入應用程式的 ID。* 如未指定,系統會自動為應用程式指派專屬 ID。* 否則,匯入的應用程式會將這個 ID 做為資源名稱的最後一個元件。如果專案中指定位置已有相同 ID 的應用程式,系統會替換現有應用程式的內容。

importOptions

object (ImportAppRequest.ImportOptions)

選用。控管應用程式匯入程序的選項。

ignoreAppLock

boolean

選用。匯入期間,用於覆寫應用程式鎖定的旗標。如果設為 true,匯入程序會忽略應用程式鎖定。

要匯入的應用程式。以下列出互斥欄位。回應中最多會設定一個欄位:
gcsUri

string

要匯入應用程式的 Google Cloud Storage URI。這個 URI 的格式必須為 gs://<bucket-name>/<object-name>。

appContent

string (bytes format)

代表壓縮 ZIP 檔案的原始位元組,其中包含應用程式資料夾結構。

Base64 編碼字串。

互斥欄位的結尾。
要套用至匯入應用程式的 JSON 修補程式。以下是互斥欄位清單。回應中最多會設定一個欄位:
jsonPatchContent

string

選用。以 JSON 字串形式修補內容。

jsonPatchGcsUri

string

選用。指向含有修補程式的 JSON 檔案的 Cloud Storage URI。

互斥欄位的結尾。

回應主體

如果成功,回應主體會包含 Operation 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍:

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限:

  • 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

定義處理衝突的策略,例如應用程式 ID 相同,或匯入的資源 (例如代理程式、工具等) 與應用程式中的現有資源顯示名稱相同。

列舉
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED 未指定衝突解決策略。
REPLACE 以匯入的資料取代現有資料。如果已有appId名稱相同的應用程式,系統會根據匯入的應用程式更新內容。- 匯入應用程式中與現有資源顯示名稱相同的資源 (應用程式、代理程式、工具、範例、防護措施、工具集),會覆寫現有資源。- 系統會建立具有新顯示名稱的匯入資源。- 如果匯入的應用程式中沒有相符的顯示名稱,現有資源將維持不變。
OVERWRITE 以匯入的資料覆寫現有資料。如果已有appId名稱相同的應用程式,系統會以匯入的應用程式覆寫其內容。- 應用程式中的現有資源 (代理程式、工具、範例、防護措施、工具集) 將會遭到刪除。- 匯入的資源會建立為新資源。