Help Center/ Cloud Container Engine/ API Reference (Ally Region)/ APIs/ Chart Management/ Creating a Release
Updated on 2026-09-30 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a Release

Function

This API is used to create a release.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

cluster_id

Yes

String

Details:

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Cluster IDs

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition:

Type (or format) of the request body. The default value is application/json. Other values of this field will be provided for specific APIs, if any.

Constraints:

GET requests are not validated.

Range:

N/A

Default Value:

N/A

X-Auth-Token

Yes

String

Details:

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

Constraints:

None

Options:

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

chart_id

Yes

String

Definition:

Chart ID

Constraints:

N/A

Range:

N/A

Default Value:

N/A

description

No

String

Definition:

Release description

Constraints:

N/A

Range:

N/A

Default Value:

N/A

name

Yes

String

Definition:

Release name

Constraints:

The value must start with a lowercase letter and end with a lowercase letter or digit. Only lowercase letters, digits, and hyphens (-) are allowed.

Range:

N/A

Default Value:

N/A

namespace

Yes

String

Definition:

Namespace that a chart release belongs to

Constraints:

N/A

Range:

N/A

Default Value:

N/A

version

Yes

String

Definition:

Release version

Constraints:

N/A

Range:

N/A

Default Value:

N/A

parameters

No

ReleaseReqBodyParams object

Definition:

Release parameters

Constraints:

N/A

Range:

N/A

Default Value:

N/A

values

Yes

values object

Definition:

Release value

Constraints:

N/A

Range:

N/A

Default Value:

N/A
Table 4 ReleaseReqBodyParams

Parameter

Mandatory

Type

Description

dry_run

No

Boolean

Definition:

After this function is enabled, only chart parameters are verified, and installation is not performed.

Constraints:

N/A

Range:

  • true: verification only

  • false: normal installation

Default Value:

false

name_template

No

String

Definition:

Release name template

Constraints:

N/A

Range:

N/A

Default Value:

N/A

no_hooks

No

Boolean

Definition:

Whether to disable hooks during installation

Constraints:

N/A

Range:

  • true: Hooks are disabled.

  • false: Hooks are not disabled.

Default Value:

false

replace

No

Boolean

Definition:

Whether to retain the values setting when a release is updated. This field takes effect only when a specified release is updated.

Constraints:

N/A

Range:

  • true: The values setting is retained.

  • false: The values setting is not retained.

Default Value:

false

recreate

No

Boolean

Definition:

Whether to rebuild a release when it is updated. This field takes effect only when a specified release is updated.

Constraints:

N/A

Range:

  • true: The release is rebuilt.

  • false: The release is not rebuilt.

Default Value:

false

reset_values

No

Boolean

Definition:

Whether to reset the values setting when a release is updated. This field takes effect only when a specified release is updated.

Constraints:

N/A

Range:

  • true: The values setting is reset.

  • false: The values setting is not reset.

Default Value:

false

release_version

No

Integer

Definition:

Version of the release to be rolled back

Constraints:

N/A

Range:

N/A

Default Value:

N/A

include_hooks

No

Boolean

Definition:

Whether to enable hooks during an update or deletion

Constraints:

N/A

Range:

  • true: Hooks are enabled.

  • false: Hooks are not enabled.

Default Value:

false
Table 5 values

Parameter

Mandatory

Type

Description

imagePullPolicy

No

String

Definition:

Image pull policy

Constraints:

N/A

Range:

N/A

Default Value:

N/A

imageTag

No

String

Definition:

Image tag

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Response Parameters

Status code: 201

Table 6 Response body parameters

Parameter

Type

Description

chart_name

String

Definition:

Name

Range:

N/A

chart_public

Boolean

Definition:

Whether the chart is public

Range:

  • true: The chart is public.

  • false: The chart is not public.

chart_version

String

Definition:

Chart version

Range:

N/A

cluster_id

String

Definition:

Cluster ID

Range:

N/A

cluster_name

String

Definition:

Cluster name

Range:

N/A

create_at

String

Definition:

Creation time

Range:

N/A

description

String

Definition:

Release description

Range:

N/A

name

String

Definition:

Release name

Range:

N/A

namespace

String

Definition:

Namespace that a chart release belongs to

Range:

N/A

parameters

String

Definition:

Release parameters

Range:

N/A

resources

String

Definition:

Resources required by a release

Range:

N/A

status

String

Definition:

Release status

Range:

  • DEPLOYED: The release has been deployed and is normal.

  • DELETED: The release has been deleted.

  • FAILED: The release failed to be deployed.

  • DELETING: The release is being deleted.

  • PENDING_INSTALL: The release is waiting to be installed.

  • PENDING_UPGRADE: The release is waiting to be upgraded.

  • PENDING_ROLLBACK: The release is waiting to be rolled back.

  • UNKNOWN: The release status is unknown, indicating that the release is abnormal. You can manually delete the release and reinstall it.

status_description

String

Definition:

Release status description

Range:

N/A

update_at

String

Definition:

Update time

Range:

N/A

values

String

Definition:

Release value

Range:

N/A

version

Integer

Definition:

Release version

Range:

N/A

Example Requests

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" : ""
  }
}

Example Responses

Status code: 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
}

Status Codes

Status Code

Description

201

The chart release has been created.

Error Codes

See Error Codes.

Parent topic: Chart Management