Updated on 2026-09-30 GMT+08:00

Obtaining a Chart List

Function

This API is used to obtain the chart list.

Calling Method

For details, see Calling APIs.

URI

GET /v2/charts

Request Parameters

Table 1 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

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

[items]

Array of ChartResp objects

Definition:

The chart list has been obtained.

Range:

N/A

Table 3 ChartResp

Parameter

Type

Description

id

String

Definition:

Chart ID

Range:

N/A

name

String

Definition:

Name

Range:

N/A

values

String

Definition:

Chart value

Range:

N/A

translate

String

Definition:

Chart translation resources

Range:

N/A

instruction

String

Definition:

Chart introduction

Range:

N/A

version

String

Definition:

Chart version

Range:

N/A

description

String

Definition:

Chart description

Range:

N/A

source

String

Definition:

Chart source

Range:

N/A

icon_url

String

Definition:

URL to the chart icon

Range:

N/A

public

Boolean

Definition:

Whether the chart is public

Range:

  • true: The chart is public.

  • false: The chart is not public.

chart_url

String

Definition:

URL to the chart

Range:

N/A

create_at

String

Definition:

Creation time

Range:

N/A

update_at

String

Definition:

Update time

Range:

N/A

Example Requests

None

Example Responses

Status code: 200

[ {
  "id" : "1abd3bd6-0258-11ec-b8b0-0255ac100b05",
  "name" : "magento-mysql",
  "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\"}}",
  "translate" : "",
  "instruction" : "",
  "version" : "1.0.0",
  "description" : "chart description",
  "source" : "",
  "icon_url" : "https://example.com/magento-stack-110x117.png",
  "public" : false,
  "chart_url" : "magento-mysql-1.0.0.tgz",
  "create_at" : "2021-08-20T08:00:29Z",
  "update_at" : "2021-08-20T08:00:29Z"
} ]

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.