Help Center> Cloud Container Engine> API Reference> APIs> Configuration Management> Obtaining the List of Parameters That Can Be Configured for a Cluster

Updated on 2024-03-22 GMT+08:00

View PDF

Obtaining the List of Parameters That Can Be Configured for a Cluster

Function

This API is used to obtain the list of parameters that can be configured for a CCE cluster.

URI

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/configuration/detail

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.
cluster_id	Yes	String	Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format).
X-Auth-Token	Yes	String	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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
kube-apiserver	Array of PackageOptions objects	Configuration parameter, which consists of key and value.
{User defined key}	map<string, array>

**Table 4** PackageOptions
Parameter	Type	Description
name	String	Parameter name
default	String	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.
validAt	String	How the parameter takes effect. Options: static: The parameter takes effect when a node is created and cannot be modified later. immediately: The parameter can be modified when a node is running and takes effect immediately after modification.
empty	Boolean	Whether the configuration item can be empty. Options: true: If this parameter is set to true, no value will take effect. false: If this parameter is set to false, the default value will take effect.
schema	String	Parameter category
type	String	Parameter type

Example Requests

None

Example Responses

Status code: 200

A list of parameters that can be configured for a cluster is obtained successfully.

{
  "kube-apiserver" : [ {
    "name" : "default-not-ready-toleration-seconds",
    "default" : 300,
    "validAt" : "immediately",
    "empty" : true,
    "schema" : "kubernetes",
    "type" : "int"
  } ]
}