Deployments: patch

修补部署以及部署清单中所述的所有资源。此方法支持修补语义。立即试用。

请求

HTTP 请求

PATCH https://www.googleapis.com/deploymentmanager/v2/projects/project/global/deployments/deployment

参数

参数名称 值 说明
路径参数
deployment string 此请求的部署名称。
project string 此请求的项目 ID。
可选查询参数
createPolicy string 设置用于创建新资源的政策。

可接受的值：
  • “ACQUIRE”：获取现有资源。如果资源不存在，部署将失败。
  • “CREATE_OR_ACQUIRE”：如果资源已存在，则获取该资源；如果不存在，则创建该资源。 （默认）
deletePolicy string 设置用于删除资源的政策。

可接受的值：
  • “ABANDON”：从 Deployment Manager 中移除资源，但不会删除底层资源。
  • “DELETE”：从部署管理器中移除资源，并删除底层资源。 （默认）
preview boolean 如果设为 true，则会更新部署并创建和更新“shell”资源，但实际上不会更改或实例化这些资源。这样，您就可以预览部署的效果。您可以使用此 intent 预览更新对部署的影响。如果此值设置为 true，您必须为 target.config 提供配置。预览部署后，您可以使用 update() 发出请求来部署资源，也可以使用 cancelPreview() 完全移除预览。请注意，取消预览后，该部署仍会保留，如果您想将其移除，则必须单独删除此部署。 （默认值：false）

请求正文

在请求正文中，请根据补丁语义规则提供 Deployments 资源的相关部分。

响应

如果成功，此方法将返回以下结构的响应正文：

{
  "kind": "deploymentmanager#operation",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": unsigned long,
  "status": string,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string
      }
    ]
  },
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string
}
属性名称 值 说明 备注
kind string [仅限输出] 资源的类型。对于 Operation 资源，始终为 compute#operation。
id unsigned long [仅输出] 资源的唯一标识符。此标识符由服务器定义。
creationTimestamp string [已废弃] 此字段已废弃。
name string [仅限输出] 资源的名称。
zone string [仅限输出] 操作所在区域的网址。仅在执行地区级操作时可用。您必须在 HTTP 请求网址中指定此字段。无法在请求正文中将其设置为字段。
clientOperationId string [仅输出] 如果您在请求中提供了 `requestId`，则为其值。否则不存在。
operationType string [仅限输出] 操作类型，例如 insert、update 或 delete 等。
targetId unsigned long [仅限输出] 唯一的目标 ID，用于标识目标资源的特定实例。
status string [仅输出] 操作的状态，可以是以下状态之一：PENDING、RUNNING 或 DONE。
statusMessage string [仅限输出] 操作当前状态的可选文本描述。
user string [仅限输出] 请求执行操作的用户，例如：user@example.com。
progress integer [仅限输出] 可选的进度指示器，范围从 0 到 100。不要求其为线性或支持任何操作粒度。请勿根据此值来推测操作何时完成。此数字应随着操作的进行而单调递增。
insertTime string [仅限输出] 请求此操作的时间。此值采用 RFC3339 文本格式。
startTime string [仅限输出] 服务器启动此操作的时间。此值采用 RFC3339 文本格式。
endTime string [仅限输出] 此操作的完成时间。此值采用 RFC3339 文本格式。
error object [仅限输出] 如果在处理操作期间生成了错误，系统将填充此字段。
error.errors[] list [仅限输出] 处理此操作时遇到的错误数组。
error.errors[].code string [仅限输出] 此错误的错误类型标识符。
error.errors[].location string [仅限输出] 指示请求中导致错误的字段。该属性是可选的。
error.errors[].message string [仅限输出] 可选属性，人类可读的错误消息。
warnings[] list [仅限输出] 如果在处理操作期间生成警告消息，系统将填充此字段。
warnings[].code string [仅限输出] 警告代码（如果适用）。例如，如果响应中没有结果，Compute Engine 会返回 NO_RESULTS_ON_PAGE。
warnings[].message string [仅限输出] 警告代码的直观易懂的说明。
warnings[].data[] list [仅输出] 此警告的元数据，采用 key: value 格式。例如：
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
warnings[].data[].key string [仅输出] 用于提供有关返回的警告的更多详细信息的键。例如，对于特定区域的列表请求中没有结果的警告，此键可能为 scope，键值可能为区域名称。其他示例可能包括指示已废弃资源和建议替换项的键，或关于网络设置无效的警告（例如，如果实例尝试执行 IP 转发，但未启用 IP 转发）。
warnings[].data[].value string [仅输出] 与键对应的警告数据值。
httpErrorStatusCode integer [仅输出] 如果操作失败，此字段将包含返回的 HTTP 错误状态代码。例如，404 表示未找到资源。
httpErrorMessage string [仅输出] 如果操作失败，此字段会包含返回的 HTTP 错误消息，例如 NOT FOUND。
region string [仅限输出] 操作所在区域的网址。仅在执行地区性操作时可用。您必须在 HTTP 请求网址中指定此字段。无法在请求正文中将其设置为字段。
description string [仅限输出] 操作的文本说明，在创建操作时设置。

试试看！

使用下面的 API Explorer 对实际数据调用此方法，然后查看响应。 或者，您也可以尝试使用独立的 Explorer。