Deployments

注意:这是已弃用的 Deployment Manager API 版本。请改用最新的 API 版本

部署是利用一个配置文件一起部署和管理的资源集合。

如需了解此资源的方法列表,请参阅本页结尾部分。

资源表示法



{
  "id": unsigned long,
  "insertTime": string,
  "updateTime": string,
  "name": string,
  "description": string,
  "fingerprint": bytes,
  "manifest": string,
  "update": {
    "errors": [
      string
    ],
    "manifest": string
  },
  "target": {
    "config": string,
    "imports": [
      {
        "name": string,
        "content": string
      }
    ]
  },
  "state": string,
  "intent": string
}
属性名称 说明 备注
description string 用户为部署提供的说明(可选)。
fingerprint bytes update() 请求指定指纹。指纹是随机生成的值,必须在 update() 请求中提供,才能执行乐观锁定。这样可确保乐观并发,从而一次只能执行一项更新。指纹最初由部署管理器生成,并会在每次请求修改数据后更改。如需获取最新的指纹值,请对部署执行 get() 请求。
id unsigned long [仅限输出] 资源的唯一标识符;由服务器定义。
insertTime string [仅输出] 部署的创建时间戳,采用 RFC3339 文本格式。
intent string [仅限输入] 指定 Deployment Manager 应如何应用此模板。可能的选项包括 PREVIEWUPDATECANCEL

PREVIEW 会创建部署并创建“空壳”资源,但实际上并未实例化这些资源。这样,您就可以预览部署的效果。您可以使用此 intent 预览部署的更新或预览新的部署。您必须提供一个 target.config,并为此 intent 提供配置。预览部署后,您可以使用 UPDATE intent 发出请求来部署资源,也可以完全 CANCEL 预览。请注意,取消预览后,该部署仍会保留,如果您想将其移除,则必须单独删除此部署。

UPDATE 会对部署中的底层资源执行更新。如果您在该请求中提供已填充的 target.config 字段,Deployment Manager 会使用该配置执行更新。如果您之前预览过此更新,并且未提供 target.config 或提供的 target.config 为空,Deployment Manager 会使用上次预览的配置。

CANCEL 会取消 PREVIEWUPDATE 中的更新,但不会撤消已做出的任何更改。
manifest string [仅输出] 表示上次成功部署的清单的清单网址。
name string 资源的名称;由客户端在创建资源时提供。名称的长度必须为 1-63 个字符,并且符合 RFC1035 的要求。具体而言,名称长度必须介于 1-63 个字符之间,并且与正则表达式 [a-z]([-a-z0-9]*[a-z0-9])? 匹配。这意味着第一个字符必须是小写字母,后面所有字符必须是短划线、小写字母或数字,但最后一个字符不能是短划线。
state string [仅限输出] 部署的当前状态。可以是 DEPLOYEDDEPLOYMENT_FAILEDPREVIEWINGUPDATINGCANCELING
target nested object [仅限输入] 用于定义部署的参数,包括部署配置和相关模板。
target.config string 要用于此部署的配置。
target.imports[] list 指定要为此配置导入的所有文件。您可以使用此方法导入模板或其他文件。例如,您可以导入文本文件,以便在模板中使用该文件。
target.imports[].content string 文件的内容。
target.imports[].name string 文件的名称。
update nested object [仅输出] 如果 Deployment Manager 当前正在更新此部署或预览对此部署的更新,更新后的配置会显示在此处。
update.errors[] list [仅输出] 尝试实施更新时遇到的所有错误的列表。
update.manifest string [仅输出] 表示此部署的更新配置的清单的网址。
updateTime string [仅输出] 部署更新的时间戳,采用 RFC3339 文本格式。

方法

删除
删除部署及其中的所有资源。
get
获取有关特定部署的信息。
insert
创建部署以及部署清单中所述的所有资源。
list
列出给定项目的所有部署。
patch
更新部署以及部署清单中所述的所有资源。此方法支持修补语义。
update
更新部署以及部署清单中所述的所有资源。