更新时间:2026-09-30 GMT+08:00

创建模板实例

功能介绍

创建模板实例

调用方法

请参见如何调用API。

URI

POST /cce/cam/v3/clusters/{cluster_id}/releases

表1 路径参数

参数

是否必选

参数类型

描述

cluster_id

是

String

参数解释:

集群ID,获取方式请参见如何获取接口URI中参数。

约束限制:

不涉及

取值范围:

集群ID

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释:

消息体的类型(格式),默认为application/json,有其他取值时会在具体接口中专门说明。

约束限制:

GET方法不做校验

取值范围:

不涉及

默认取值:

不涉及

X-Auth-Token

是

String

参数解释:

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

chart_id

是

String

参数解释:

模板ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

description

否

String

参数解释:

模板实例描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

name

是

String

参数解释:

模板实例名称

约束限制:

由小写字母开头,中间由小写字母、数字和中划线(-)组成,以小写字母或数字结尾

取值范围:

不涉及

默认取值:

不涉及

namespace

是

String

参数解释:

模板实例所在的命名空间

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

version

是

String

参数解释:

模板实例版本号

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

parameters

否

ReleaseReqBodyParams object

参数解释:

模板实例参数

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

values

是

values object

参数解释:

模板实例的值

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 ReleaseReqBodyParams

参数

是否必选

参数类型

描述

dry_run

否

Boolean

参数解释:

开启后,仅验证模板参数,不进行安装

约束限制:

不涉及

取值范围:

  • true:仅验证

  • false:正常安装

默认取值:

false

name_template

否

String

参数解释:

实例名称模板

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

no_hooks

否

Boolean

参数解释:

安装时是否禁用hooks

约束限制:

不涉及

取值范围:

  • true:禁用hooks

  • false:不禁用hooks

默认取值:

false

replace

否

Boolean

参数解释:

模板实例更新时是否保留values,该字段仅在更新指定模板实例时生效

约束限制:

不涉及

取值范围:

  • true:保留values

  • false:不保留values

默认取值:

false

recreate

否

Boolean

参数解释:

模板实例更新时是否重建实例,该字段仅在更新指定模板实例时生效

约束限制:

不涉及

取值范围:

  • true:重建实例

  • false:不重建实例

默认取值:

false

reset_values

否

Boolean

参数解释:

模板实例更新时是否重置values,该字段仅在更新指定模板实例时生效

约束限制:

不涉及

取值范围:

  • true:重置values

  • false:不重置values

默认取值:

false

release_version

否

Integer

参数解释:

回滚实例的版本

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

include_hooks

否

Boolean

参数解释:

更新或者删除时启用hooks

约束限制:

不涉及

取值范围:

  • true:启用hooks

  • false:不启用hooks

默认取值:

false

表5 values

参数

是否必选

参数类型

描述

imagePullPolicy

否

String

参数解释:

镜像拉取策略

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

imageTag

否

String

参数解释:

镜像标签

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:201

表6 响应Body参数

参数

参数类型

描述

chart_name

String

参数解释:

模板名称

取值范围:

不涉及

chart_public

Boolean

参数解释:

是否公开模板

取值范围:

  • true:公开模板

  • false:不公开模板

chart_version

String

参数解释:

模板版本

取值范围:

不涉及

cluster_id

String

参数解释:

集群ID

取值范围:

不涉及

cluster_name

String

参数解释:

集群名称

取值范围:

不涉及

create_at

String

参数解释:

创建时间

取值范围:

不涉及

description

String

参数解释:

模板实例描述

取值范围:

不涉及

name

String

参数解释:

模板实例名称

取值范围:

不涉及

namespace

String

参数解释:

模板实例所在的命名空间

取值范围:

不涉及

parameters

String

参数解释:

模板实例参数

取值范围:

不涉及

resources

String

参数解释:

模板实例需要的资源

取值范围:

不涉及

status

String

参数解释:

模板实例状态

取值范围:

  • DEPLOYED:已部署,表示模板实例处于正常状态

  • DELETED:已删除,表示模板实例已经被删除

  • FAILED:失败,表示模板实例部署失败

  • DELETING:删除中,表示模板实例正处于删除过程中

  • PENDING_INSTALL:待安装,表示模板正在等待安装

  • PENDING_UPGRADE:待升级,表示模板正在等待升级

  • PENDING_ROLLBACK:待回滚,表示模板正在等待回滚

  • UNKNOWN:未知,表示模板状态异常,可尝试手动删除后重新安装

status_description

String

参数解释:

模板实例状态描述

取值范围:

不涉及

update_at

String

参数解释:

更新时间

取值范围:

不涉及

values

String

参数解释:

模板实例的值

取值范围:

不涉及

version

Integer

参数解释:

模板实例版本

取值范围:

不涉及

请求示例

POST /cce/cam/v3/clusters/{cluster_id}/releases

{
  "name" : "nino21",
  "namespace" : "project01",
  "version" : "1.0.0",
  "chart_id" : "3c138b72-7ce4-6d76-7c55-604cdb2ce423",
  "values" : {
    "imageTag" : "v2",
    "imagePullPolicy" : "IfNotPresent"
  },
  "parameters" : {
    "dry_run" : false,
    "no_hooks" : false,
    "replace" : false,
    "name_template" : ""
  }
}

响应示例

状态码:201

创建模板实例成功

{
  "chart_name" : "magento-mysql",
  "chart_public" : false,
  "chart_version" : "1.0.0",
  "cluster_id" : "a870253f-5dc7-11ee-bf71-0255ac100b03",
  "cluster_name" : "sfs-turbo-test",
  "create_at" : "2023-11-14T20:30:57+08:00",
  "description" : "Initial install underway",
  "name" : "testwww",
  "namespace" : "monitoring",
  "parameters" : "",
  "resources" : "",
  "status" : "PENDING_INSTALL",
  "status_description" : "Initial install underway",
  "update_at" : "2023-11-14T20:30:57+08:00",
  "values" : "{\"basic\":{\"admin_password\":\"******\",\"admin_username\":\"username\",\"app_name\":\"magento\",\"mysql_database\":\"magento\",\"mysql_name\":\"mysql\",\"mysql_password\":\"******\",\"mysql_port\":3306,\"mysql_root_password\":\"******\",\"mysql_user\":\"magento\",\"storage_class\":\"csi-nas\",\"storage_mode\":\"ReadWriteMany\",\"storage_size\":\"10G\"},\"global\":{\"magento_EIP\":\"100.100.100.100\",\"magento_EPORT\":32080,\"namespace\":\"default\"},\"image\":{\"magento_image\":\"example.com/everest/magento:latest\",\"mysql_image\":\"example.com/everest/mysql:5.7.14\"}}",
  "version" : 1
}

状态码

状态码

描述

201

创建模板实例成功

错误码

请参见错误码。