- HTTP 请求
- 路径参数
- 请求正文
- 响应正文
- 授权范围
- IAM 权限
- ImportAppRequest.ImportOptions
- ImportAppRequest.ImportOptions.ConflictResolutionStrategy
导入指定应用。
HTTP 请求
POST https://ces.googleapis.com/v1/{parent=projects/*/locations/*}/apps:importApp
网址采用 gRPC 转码语法。
路径参数
| 参数 | |
|---|---|
parent |
必需。要导入的应用所在的父级资源名称。 |
请求正文
请求正文中包含结构如下的数据:
| JSON 表示法 |
|---|
{ "displayName": string, "appId": string, "importOptions": { object ( |
| 字段 | |
|---|---|
displayName |
可选。要导入的应用的显示名称。* 如果应用是在导入时创建的,并且指定了显示名称,则导入的应用将使用此显示名称。如果检测到与现有应用存在冲突,系统会在显示名称中附加时间戳,使其成为唯一名称。* 如果应用是重新导入的,则不应设置此字段。在重新导入期间提供显示名称会导致 INVALID_ARGUMENT 错误。 |
appId |
可选。要用于导入的应用的 ID。* 如果未指定,系统会自动为应用分配一个唯一 ID。* 否则,导入的应用将使用此 ID 作为其资源名称的最后一个组成部分。如果项目中的指定位置已存在具有相同 ID 的应用,则现有应用的内容将被替换。 |
importOptions |
可选。用于控制应用导入流程的选项。 |
ignoreAppLock |
可选。用于在导入期间替换应用锁定的标志。如果设置为 true,导入过程将忽略应用锁定。 |
联合字段 app。要导入的应用。app 只能是下列其中一项: |
|
gcsUri |
要从中导入应用的 Google Cloud Storage URI。此 URI 的格式必须为 |
appContent |
表示包含应用文件夹结构的压缩 ZIP 文件的原始字节。 使用 base64 编码的字符串。 |
响应正文
如果成功,则响应正文包含一个 Operation 实例。
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/ces
如需了解详情,请参阅 Authentication Overview。
IAM 权限
需要拥有 parent 资源的以下 IAM 权限:
ces.apps.import
如需了解详情,请参阅 IAM 文档。
ImportAppRequest.ImportOptions
应用导入流程的配置选项。这些选项可控制导入行为,尤其是在与现有应用数据发生冲突时。
| JSON 表示法 |
|---|
{
"conflictResolutionStrategy": enum ( |
| 字段 | |
|---|---|
conflictResolutionStrategy |
可选。在导入期间解决冲突时使用的策略。 |
validateOnly |
可选。用于试运行导入流程的标志。如果设置为 true,导入过程将仅执行验证,而不会对现有应用进行任何更改或创建新应用。 |
ImportAppRequest.ImportOptions.ConflictResolutionStrategy
定义了在以下情况下处理冲突的策略:已存在具有相同 ID 的应用,或者导入的资源(例如代理、工具等)与相应应用中的现有资源具有相同的显示名称。
| 枚举 | |
|---|---|
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED |
未指定冲突解决策略。 |
REPLACE |
使用导入的数据替换现有数据。如果已存在具有相同 appId 的应用,则其内容将根据导入的应用进行更新。- 导入的应用中与现有资源具有相同显示名称的资源(应用、代理、工具、示例、安全屏障、工具集)将覆盖现有资源。- 系统将创建具有新显示名称的导入资源。- 如果现有资源的显示名称与导入的应用中的显示名称不匹配,则这些资源将保持不变。 |
OVERWRITE |
使用导入的数据覆盖现有数据。如果已存在具有相同 appId 的应用,则其内容将被导入的应用覆盖。- 应用中现有的资源(代理、工具、示例、安全屏障、工具集)将被删除。- 导入的资源将作为新资源创建。 |