Help Center/ Cloud Container Engine/ API Reference/ APIs/ Configuration Management/ Obtaining the List of Configurable Parameters Supported by a Cluster
Updated on 2025-08-26 GMT+08:00

Obtaining the List of Configurable Parameters Supported by a Cluster

Function

This API is used to obtain the detailed configuration items supported by a cluster based on factors like the cluster version or type. It is specified during cluster creation.

Calling Method

For details, see Calling APIs.

URI

GET /api/v3/clusters/configuration/detail

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

clusterType

No

String

Definition

Used to filter the cluster architecture.

Constraints

N/A

Range

  • ARM64: Only the configuration items supported by the Kunpeng cluster are obtained.

Default Value

N/A

clusterVersion

No

String

Definition

Used to obtain the configuration items supported by a specified cluster version.

Constraints

N/A

Range

N/A

Default Value

N/A

clusterID

No

String

Definition

Used to obtain the configuration items supported by a specified cluster.

Constraints

N/A

Range

N/A

Default Value

N/A

networkMode

No

String

Definition

Used to filter out the configuration items related to the cluster network model.

Constraints

N/A

Range

  • eni: The configurations related to the Cloud Native 2.0 network model are filtered out.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Details:

The request body type or format

Constraints:

The GET method is not verified.

Options:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

  • multipart/form-data (used when the FormData parameter is present)

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 3 Response body parameters

Parameter

Type

Description

{User defined key}

Map<String,Array<PackageOptions>>

Definition

Configuration items supported by a cluster

Table 4 PackageOptions

Parameter

Type

Description

name

String

Definition

Parameter name

Range

N/A

default

Object

Definition

Default parameter value. If this parameter is not specified, the default value will take effect. The returned parameter can be of integer, string, or Boolean type.

Range

N/A

validAt

String

Definition

How parameters will take effect

Range

  • static: The parameters take effect during the cluster or node pool creation and cannot be changed later.

  • immediately: The parameters can be modified during the cluster or node pool running, and the modification takes effect immediately.

empty

Boolean

Definition

Whether a configuration item can be empty

Range

  • true: If the configuration item is empty, the default value is not used. The value remains empty.

  • false: If the configuration item is empty, the default value is used.

schema

String

Definition

Parameter category

Range

N/A

type

String

Definition

Parameter type

Range

N/A

Example Requests

None

Example Responses

Status code: 200

The list of configurable parameters supported by the cluster has been obtained.

{
  "eni" : [ {
    "name" : "nic-minimum-target",
    "default" : 10,
    "validAt" : "immediately",
    "empty" : false,
    "schema" : "network",
    "type" : "str"
  }, {
    "name" : "nic-warm-target",
    "default" : 2,
    "validAt" : "immediately",
    "empty" : false,
    "schema" : "network",
    "type" : "str"
  } ],
  "kube-apiserver" : [ {
    "name" : "default-not-ready-toleration-seconds",
    "default" : 300,
    "validAt" : "immediately",
    "empty" : true,
    "schema" : "kubernetes",
    "type" : "int"
  } ]
}

Status Codes

Status Code

Description

200

The list of configurable parameters supported by the cluster has been obtained.

Error Codes

See Error Codes.